Interface Encoder.TextStream<T>

  • Type Parameters:
    T - the type of the object this encoder can encode to a CharacterStream.
    All Superinterfaces:
    Enclosing interface:

    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.
    • Method Detail

      • encode

        void encode​(T object,
                    Writer writer)
             throws EncodeException,
        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.
        object - the object to be encoded.
        writer - the writer provided by the web socket runtime to write the encoded data.
        EncodeException - if there was an error encoding the object due to its state.
        IOException - if there was an exception writing to the writer.