Package jakarta.websocket

Interface Encoder.BinaryStream<T>

Type Parameters:

T - the type of the object this encoder can encode.

All Superinterfaces:

Encoder

Enclosing interface:

Encoder

public static interface Encoder.BinaryStream<T>
extends Encoder

This interface may be implemented by encoding algorithms that want to write the encoded object to a binary stream.

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

Modifier and Type	Method	Description
void	encode(T object, java.io.OutputStream os)	Encode the given object into a binary stream written to the implementation provided OutputStream.

Methods inherited from interface jakarta.websocket.Encoder

destroy, init

Method Detail

encode

void encode(T object,
            java.io.OutputStream os)
     throws EncodeException,
            java.io.IOException

Encode the given object into a binary stream written to the implementation provided OutputStream.

Parameters:

object - the object being encoded.

os - the output stream where the encoded data is written.

Throws:

EncodeException - The provided object could not be encoded to an output stream

java.io.IOException - If an error occurred writing to the output stream