Module org.apache.qpid.protonj2

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

Class DeleteOnNoLinksOrMessagesTypeEncoder

java.lang.Object

org.apache.qpid.protonj2.codec.encoders.AbstractDescribedTypeEncoder<DeleteOnNoLinksOrMessages>

org.apache.qpid.protonj2.codec.encoders.AbstractDescribedListTypeEncoder<DeleteOnNoLinksOrMessages>

org.apache.qpid.protonj2.codec.encoders.messaging.DeleteOnNoLinksOrMessagesTypeEncoder

All Implemented Interfaces:

DescribedTypeEncoder<DeleteOnNoLinksOrMessages>, TypeEncoder<DeleteOnNoLinksOrMessages>

public final class DeleteOnNoLinksOrMessagesTypeEncoder
extends AbstractDescribedListTypeEncoder<DeleteOnNoLinksOrMessages>

Encoder of AMQP DeleteOnNoLinksOrMessages type values to a byte stream

Field Summary

Fields

Modifier and Type	Field	Description
static final DeleteOnNoLinksOrMessagesTypeEncoder	INSTANCE

Constructor Summary

Constructors

Constructor	Description
DeleteOnNoLinksOrMessagesTypeEncoder()

Method Summary

Modifier and Type	Method	Description
UnsignedLong	getDescriptorCode()
Symbol	getDescriptorSymbol()
int	getElementCount(DeleteOnNoLinksOrMessages value)	Gets the number of elements that will result when this type is encoded into an AMQP List type.
byte	getListEncoding(DeleteOnNoLinksOrMessages value)	Determine the list type the given value can be encoded to based on the number of bytes that would be needed to hold the encoded form of the resulting list entries.
int	getMaxElementCount()	Returns the maximum number of elements the list body of the described type can carry and is used as a sanity check during encode.
Class<DeleteOnNoLinksOrMessages>	getTypeClass()
void	writeElements(DeleteOnNoLinksOrMessages source, int count, ProtonBuffer buffer, Encoder encoder, EncoderState state)	Instructs the encoder to write the elements identified with the given count which should match what it reports as the required number needed for this encoding.

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

getMinElementCount, writeArray, writeRawArray, writeType

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

isArrayType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.qpid.protonj2.codec.DescribedTypeEncoder

encoderRegistered

Field Details

INSTANCE

public static final DeleteOnNoLinksOrMessagesTypeEncoder INSTANCE

Constructor Details

DeleteOnNoLinksOrMessagesTypeEncoder

public DeleteOnNoLinksOrMessagesTypeEncoder()

Method Details

getDescriptorCode

public UnsignedLong getDescriptorCode()

Returns:

the UnsignedLong value to use as the Descriptor for this type.

getDescriptorSymbol

public Symbol getDescriptorSymbol()

Returns:

the Symbol value to use as the Descriptor for this type.

getTypeClass

public Class<DeleteOnNoLinksOrMessages> getTypeClass()

Returns:

the Class type that this encoder handles.

getListEncoding

public byte getListEncoding(DeleteOnNoLinksOrMessages value)

Description copied from class: AbstractDescribedListTypeEncoder

Determine the list type the given value can be encoded to based on the number of bytes that would be needed to hold the encoded form of the resulting list entries.

Most encoders will return LIST32 but for cases where the type is known to be encoded to LIST8 or always encodes an empty list (LIST0) the encoder can optimize the encode step and not compute sizes.

Overrides:

getListEncoding in class AbstractDescribedListTypeEncoder<DeleteOnNoLinksOrMessages>

Parameters:

value - The value that is to be encoded.

Returns:

the encoding code of the list type encoding needed for this object.

getElementCount

public int getElementCount(DeleteOnNoLinksOrMessages value)

Description copied from class: AbstractDescribedListTypeEncoder

Gets the number of elements that will result when this type is encoded into an AMQP List type.

Specified by:

getElementCount in class AbstractDescribedListTypeEncoder<DeleteOnNoLinksOrMessages>

Parameters:

value - the value which will be encoded as a list type.

Returns:

the number of elements that should comprise the encoded list.

getMaxElementCount

public int getMaxElementCount()

Description copied from class: AbstractDescribedListTypeEncoder

Returns the maximum number of elements the list body of the described type can carry and is used as a sanity check during encode.

Specified by:

getMaxElementCount in class AbstractDescribedListTypeEncoder<DeleteOnNoLinksOrMessages>

Returns:

the maximum number of elements the described type can carry.

writeElements

public void writeElements(DeleteOnNoLinksOrMessages source,
 int count,
 ProtonBuffer buffer,
 Encoder encoder,
 EncoderState state)

Description copied from class: AbstractDescribedListTypeEncoder

Instructs the encoder to write the elements identified with the given count which should match what it reports as the required number needed for this encoding.

Specified by:

writeElements in class AbstractDescribedListTypeEncoder<DeleteOnNoLinksOrMessages>

Parameters:

source - the source of the list elements to write

count - the number of elements that are to be encoded for this type

buffer - the buffer to write the element to

encoder - the current Encoder value to use.

state - the current EncoderState value to use.