-
- 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.
-
-
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
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description 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.
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/websocket/encoder.textstream.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.