jakarta.websocket

Interface Decoder.TextStream<T>

Type Parameters:

T - The type of the object that is decoded

All Superinterfaces:

Decoder

Enclosing interface:

Decoder

public static interface Decoder.TextStream<T>
extends Decoder

This interface defines how a custom object of type T is decoded from a web socket message in the form of a character stream.

Nested Class Summary

Nested classes/interfaces inherited from interface jakarta.websocket.Decoder

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

Method Summary

Modifier and Type	Method and Description
T	decode(java.io.Reader reader) Reads the websocket message from the implementation provided Reader and decodes it into an instance of the supplied object type.

Methods inherited from interface jakarta.websocket.Decoder

destroy, init

Method Detail

decode

T decode(java.io.Reader reader)
  throws DecodeException,
         java.io.IOException

Reads the websocket message from the implementation provided Reader and decodes it into an instance of the supplied object type.

Parameters:

reader - the reader from which to read the web socket message.

Returns:

the instance of the object that is the decoded web socket message.

Throws:

DecodeException - If the data from the provided reader cannot be decoded to type T

java.io.IOException - If an error occurs reading from the reader