Encoder.Text (Tyrus 2.1.5 API)

Type Parameters:

T - The type of the custom developer object that this Encoder can encode into a String.

All Superinterfaces:

Encoder

All Known Implementing Classes:

NoOpTextCoder, ToStringEncoder

Enclosing interface:

Encoder
```
public static interface Encoder.Text<T>
extends Encoder
```
This interface defines how to provide a way to convert a custom object into a text message.

- Nested Class Summary
  - Nested classes/interfaces inherited from interface jakarta.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 Description
  
  java.lang.String encode(T object)
  Encode the given object into a String.
  - Methods inherited from interface jakarta.websocket.Encoder
    destroy, init

- Method Detail
  - encode
```
java.lang.String encode(T object)
                 throws EncodeException
```
    Encode the given object into a String.
    
    Parameters:
    
    object - the object being encoded.
    
    Returns:
    
    the encoded object as a string.
    
    Throws:
    
    EncodeException - The provided object could not be encoded as a string