Module org.apache.qpid.protonj2

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

Class SaslMechanismsTypeEncoder

java.lang.Object

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

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

org.apache.qpid.protonj2.codec.encoders.security.SaslMechanismsTypeEncoder

All Implemented Interfaces:

DescribedTypeEncoder<SaslMechanisms>, TypeEncoder<SaslMechanisms>

public final class SaslMechanismsTypeEncoder
extends AbstractDescribedListTypeEncoder<SaslMechanisms>

Encoder of AMQP SaslMechanisms type values to a byte stream

Field Summary

Fields

Modifier and Type	Field	Description
static final SaslMechanismsTypeEncoder	INSTANCE

Constructor Summary

Constructors

Constructor	Description
SaslMechanismsTypeEncoder()

Method Summary

Modifier and Type	Method	Description
UnsignedLong	getDescriptorCode()
Symbol	getDescriptorSymbol()
int	getElementCount(SaslMechanisms challenge)	Gets the number of elements that will result when this type is encoded into an AMQP List type.
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.
int	getMinElementCount()	Return the minimum number of elements that this AMQP type must provide in order to be considered a valid type.
Class<SaslMechanisms>	getTypeClass()
void	writeElements(SaslMechanisms mechanisms, 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

getListEncoding, 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 SaslMechanismsTypeEncoder INSTANCE

Constructor Details

SaslMechanismsTypeEncoder

public SaslMechanismsTypeEncoder()

Method Details

getTypeClass

public Class<SaslMechanisms> getTypeClass()

Returns:

the Class type that this encoder handles.

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.

getElementCount

public int getElementCount(SaslMechanisms challenge)

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<SaslMechanisms>

Parameters:

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

Returns:

the number of elements that should comprise the encoded list.

getMinElementCount

public int getMinElementCount()

Description copied from class: AbstractDescribedListTypeEncoder

Return the minimum number of elements that this AMQP type must provide in order to be considered a valid type.

Overrides:

getMinElementCount in class AbstractDescribedListTypeEncoder<SaslMechanisms>

Returns:

the minimum number of elements this type must provide.

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<SaslMechanisms>

Returns:

the maximum number of elements the described type can carry.

writeElements

public void writeElements(SaslMechanisms mechanisms,
 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<SaslMechanisms>

Parameters:

mechanisms - 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.