Jetty 12.0.6 · org.eclipse.jetty.ee10.websocket.jakarta.common.decoders.ByteBufferDecoder

Modifier and Type	Field and Description
public static final ByteBufferDecoder	INSTANCE

Access	Constructor and Description
public	ByteBufferDecoder()

Method Summary

Modifier and Type	Method and Description
public ByteBuffer	decode(ByteBuffer the bytes to be decoded. bytes) Implements jakarta.websocket.Decoder.Binary.decode. Decode the given bytes into an object of type T.
public boolean	willDecode(ByteBuffer the bytes to be decoded. bytes) Implements jakarta.websocket.Decoder.Binary.willDecode. Answer whether the given bytes can be decoded into an object of type T.

Inherited from org.eclipse.jetty.ee10.websocket.jakarta.common.decoders.AbstractDecoder:: destroy init

INSTANCE	back to summary
public static final ByteBufferDecoder INSTANCE

ByteBufferDecoder	back to summary
public ByteBufferDecoder()

Method Detail

decode	back to summary
public ByteBuffer decode(ByteBuffer bytes) throws DecodeException Implements jakarta.websocket.Decoder.Binary.decode. Doc from jakarta.websocket.Decoder.Binary.decode. Decode the given bytes into an object of type T. It is not safe for other threads to use the ByteBuffer until the decoding of the given bytes is complete. If the decoding completes successfully, the buffer's limit will be unchanged and the buffer's position will be equal to the limit. If the decoding does not complete successfully, the state of the buffer is undefined. Parameters bytes:ByteBuffer the bytes to be decoded. Returns:ByteBuffer the decoded object. Annotations @Override Exceptions DecodeException: If the provided bytes cannot be decoded to type T

decode

back to summary

public ByteBuffer decode(ByteBuffer bytes) throws DecodeException

Implements jakarta.websocket.Decoder.Binary.decode.

Doc from jakarta.websocket.Decoder.Binary.decode.

Decode the given bytes into an object of type T.

It is not safe for other threads to use the ByteBuffer until the decoding of the given bytes is complete. If the decoding completes successfully, the buffer's limit will be unchanged and the buffer's position will be equal to the limit. If the decoding does not complete successfully, the state of the buffer is undefined.

Parameters

bytes:ByteBuffer: the bytes to be decoded.

Returns:ByteBuffer

the decoded object.

Annotations

@Override

Exceptions

DecodeException:: If the provided bytes cannot be decoded to type T

willDecode	back to summary
public boolean willDecode(ByteBuffer bytes) Implements jakarta.websocket.Decoder.Binary.willDecode. Doc from jakarta.websocket.Decoder.Binary.willDecode. Answer whether the given bytes can be decoded into an object of type T. It is not safe for other threads to use the ByteBuffer until this method completes. When the method completes, the buffer will be in the same state as it was at the start of the method call. Parameters bytes:ByteBuffer the bytes to be decoded. Returns:boolean whether or not the bytes can be decoded by this decoder. Annotations @Override

willDecode

back to summary

public boolean willDecode(ByteBuffer bytes)

Implements jakarta.websocket.Decoder.Binary.willDecode.

Doc from jakarta.websocket.Decoder.Binary.willDecode.

Answer whether the given bytes can be decoded into an object of type T.

It is not safe for other threads to use the ByteBuffer until this method completes. When the method completes, the buffer will be in the same state as it was at the start of the method call.

Parameters

bytes:ByteBuffer: the bytes to be decoded.

Returns:boolean

whether or not the bytes can be decoded by this decoder.

Annotations

@Override

public Class ByteBufferDecoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail