Encoder.Binary (Tyrus 2.1.5 API)

Type Parameters:

T - The type of the custom object that this Encoder can encoder to a ByteBuffer.

All Superinterfaces:

Encoder

All Known Implementing Classes:

NoOpByteArrayCoder, NoOpByteBufferCoder

Enclosing interface:

Encoder
```
public static interface Encoder.Binary<T>
extends Encoder
```
This interface defines how to provide a way to convert a custom object into a binary 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.nio.ByteBuffer encode(T object)
  Encode the given object into a byte array.
  - Methods inherited from interface jakarta.websocket.Encoder
    destroy, init

- Method Detail
  - encode
```
java.nio.ByteBuffer encode(T object)
                    throws EncodeException
```
    Encode the given object into a byte array.
    
    Parameters:
    
    object - the object being encoded.
    
    Returns:
    
    the binary data.
    
    Throws:
    
    EncodeException - The provided object could not be encoded to a byte buffer