Top Inners Methods
jakarta.websocket

public Interface Encoder

Known Direct Subinterfaces
jakarta.websocket.Encoder.Text, jakarta.websocket.Encoder.TextStream, jakarta.websocket.Encoder.Binary, jakarta.websocket.Encoder.BinaryStream
Imports
java.io.IOException, .OutputStream, .Writer, java.nio.ByteBuffer

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
Encoder.Binary<T>

public static interface
Encoder.BinaryStream<T>

public static interface
Encoder.Text<T>

public static interface
Encoder.TextStream<T>

Method Summary

Modifier and TypeMethod and Description
public default void
destroy()

Destroy the decoder.

public default void
init(EndpointConfig
The end-point configuration
endpointConfig)

Initialise the encoder.

Method Detail

destroyback to summary
public default void destroy()

Destroy the decoder. The default implementation is a NO-OP.

initback to summary
public default void init(EndpointConfig endpointConfig)

Initialise the encoder. The default implementation is a NO-OP.

Parameters
endpointConfig:EndpointConfig

The end-point configuration

jakarta.websocket back to summary

public Interface Encoder.Binary<T>

extends Encoder

Method Summary

Modifier and TypeMethod and Description
public ByteBuffer
encode(T object)

Inherited from jakarta.websocket.Encoder:
destroyinit

Method Detail

encodeback to summary
public ByteBuffer encode(T object) throws EncodeException
jakarta.websocket back to summary

public Interface Encoder.BinaryStream<T>

extends Encoder

Method Summary

Modifier and TypeMethod and Description
public void
encode(T object, OutputStream os)

Inherited from jakarta.websocket.Encoder:
destroyinit

Method Detail

encodeback to summary
public void encode(T object, OutputStream os) throws EncodeException, IOException
jakarta.websocket back to summary

public Interface Encoder.Text<T>

extends Encoder

Method Summary

Modifier and TypeMethod and Description
public String
encode(T object)

Inherited from jakarta.websocket.Encoder:
destroyinit

Method Detail

encodeback to summary
public String encode(T object) throws EncodeException
jakarta.websocket back to summary

public Interface Encoder.TextStream<T>

extends Encoder

Method Summary

Modifier and TypeMethod and Description
public void
encode(T object, Writer writer)

Inherited from jakarta.websocket.Encoder:
destroyinit

Method Detail

encodeback to summary
public void encode(T object, Writer writer) throws EncodeException, IOException