javax.websocket
Interface Encoder.TextStream<T>

Type Parameters:

T - the type of the object this encoder can encode to a CharacterStream.

All Superinterfaces:

Encoder

Enclosing interface:

Encoder

public static interface Encoder.TextStream<T>
extends Encoder

This interface may be implemented by encoding algorithms that want to write the encoded object to a character stream.

Since:

DRAFT 006 / EDR

Nested Class Summary

Nested classes/interfaces inherited from interface javax.websocket.Encoder

Encoder.Binary<T>, Encoder.BinaryStream<T>, Encoder.Text<T>, Encoder.TextStream<T>

Method Summary

void	encode(T object, Writer writer) Encode the given object to a character stream writing it to the supplied Writer.

Method Detail

encode

void encode(T object,
            Writer writer)
            throws EncodeException,
                   IOException

Encode the given object to a character stream writing it to the supplied Writer. Implementations of this method may use the EncodeException to indicate a failure to convert the supplied object to an encoded form, and may use the IOException to indicate a failure to write the data to the supplied stream.

Parameters:

object - the object to be encoded.

writer - the writer provided by the web socket runtime to write the encoded data.

Throws:

EncodeException - if there was an error encoding the object due to its state.

IOException - if there was an exception writing to the writer.