Package org.apache.qpid.protonj2.codec.encoders.primitives

Class BinaryTypeEncoder

java.lang.Object

org.apache.qpid.protonj2.codec.encoders.AbstractPrimitiveTypeEncoder<Binary>

org.apache.qpid.protonj2.codec.encoders.primitives.BinaryTypeEncoder

All Implemented Interfaces:

PrimitiveTypeEncoder<Binary>, TypeEncoder<Binary>

public final class BinaryTypeEncoder
extends AbstractPrimitiveTypeEncoder<Binary>

Encoder of AMQP Binary type values to a byte stream.

Constructor Summary

Constructors

Constructor	Description
BinaryTypeEncoder()

Method Summary

Modifier and Type	Method	Description
Class<Binary>	getTypeClass()
void	writeRawArray(ProtonBuffer buffer, EncoderState state, Object[] values)	Write an array elements of the AMQP type to the given byte buffer.
void	writeType(ProtonBuffer buffer, EncoderState state, byte[] value)	Shortcut API that allows a byte[] to be directly encoded as an AMQP Binary type without the need to create a Binary instance.
void	writeType(ProtonBuffer buffer, EncoderState state, ProtonBuffer value)	Shortcut API that allows a ProtonBuffer to be directly encoded as an AMQP Binary type without the need to create a Binary instance.
void	writeType(ProtonBuffer buffer, EncoderState state, Binary value)	Write the full AMQP type data to the given byte buffer.

Methods inherited from class org.apache.qpid.protonj2.codec.encoders.AbstractPrimitiveTypeEncoder

isArrayType, writeArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BinaryTypeEncoder

public BinaryTypeEncoder()

Method Detail

getTypeClass

public Class<Binary> getTypeClass()

Returns:

the Class type that this encoder handles.

writeType

public void writeType(ProtonBuffer buffer,
                      EncoderState state,
                      Binary value)

Description copied from interface: TypeEncoder

Write the full AMQP type data to the given byte buffer.

This can consist of writing both a type constructor value and the bytes that make up the value of the type being written.

Parameters:

buffer - The buffer to write the AMQP type to

state - The current encoder state

value - The value that is to be written.

writeType

public void writeType(ProtonBuffer buffer,
                      EncoderState state,
                      ProtonBuffer value)

Shortcut API that allows a ProtonBuffer to be directly encoded as an AMQP Binary type without the need to create a Binary instance. The encoder will attempt to write the smallest encoding possible based on the buffer size.

Parameters:

buffer - The ProtonBuffer instance to write the encoding to.

state - The EncoderState for use in encoding operations.

value - The ProtonBuffer instance that is to be encoded.

writeType

public void writeType(ProtonBuffer buffer,
                      EncoderState state,
                      byte[] value)

Shortcut API that allows a byte[] to be directly encoded as an AMQP Binary type without the need to create a Binary instance. The encoder will attempt to write the smallest encoding possible based on the buffer size.

Parameters:

buffer - The ProtonBuffer instance to write the encoding to.

state - The EncoderState for use in encoding operations.

value - The byte[] instance that is to be encoded.

writeRawArray

public void writeRawArray(ProtonBuffer buffer,
                          EncoderState state,
                          Object[] values)

Description copied from interface: TypeEncoder

Write an array elements of the AMQP type to the given byte buffer.

This method writes only the body portion of an AMQP array of this type, the array encoding, size and element count should be assumed to be managed by the caller.

Parameters:

buffer - The buffer to write the AMQP array elements to

state - The current encoder state

values - The array of values that is to be written.