Module org.apache.qpid.protonj2

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

Class SaslOutcomeTypeDecoder

java.lang.Object

org.apache.qpid.protonj2.codec.decoders.AbstractDescribedTypeDecoder<SaslOutcome>

org.apache.qpid.protonj2.codec.decoders.AbstractDescribedListTypeDecoder<SaslOutcome>

org.apache.qpid.protonj2.codec.decoders.security.SaslOutcomeTypeDecoder

All Implemented Interfaces:

DescribedTypeDecoder<SaslOutcome>, StreamDescribedTypeDecoder<SaslOutcome>, StreamTypeDecoder<SaslOutcome>, TypeDecoder<SaslOutcome>

public final class SaslOutcomeTypeDecoder
extends AbstractDescribedListTypeDecoder<SaslOutcome>

Decoder of AMQP SaslOutcome type values from a byte stream.

Field Summary

Fields

Modifier and Type	Field	Description
static final SaslOutcomeTypeDecoder	INSTANCE

Constructor Summary

Constructors

Constructor	Description
SaslOutcomeTypeDecoder()

Method Summary

Modifier and Type	Method	Description
UnsignedLong	getDescriptorCode()	Returns the AMQP descriptor code for the type this decoder reads.
Symbol	getDescriptorSymbol()	Returns the AMQP descriptor symbol for the type this decoder reads.
protected final int	getMaxListElements()	Returns the maximum number of elements that may appear in this list type.
protected final int	getMinListElements()	(@return the minimum number of elements that must appear in this list type}
Class<SaslOutcome>	getTypeClass()	Returns the Class that this decoder handles.
protected SaslOutcome	readType(int count, InputStream stream, StreamDecoder decoder, StreamDecoderState state)	Reads the actual type from the byte stream with the given number of encoded list elements populated
protected SaslOutcome	readType(int count, ProtonBuffer buffer, Decoder decoder, DecoderState state)	Reads the actual type from the byte stream with the given number of encoded list elements populated

Methods inherited from class org.apache.qpid.protonj2.codec.decoders.AbstractDescribedListTypeDecoder

readArrayElements, readArrayElements, readSingle, readSingle, readValue, readValue, skipValue, skipValue

Methods inherited from class org.apache.qpid.protonj2.codec.decoders.AbstractDescribedTypeDecoder

checkIsExpectedType, checkIsExpectedType, checkIsExpectedTypeAndCast, checkIsExpectedTypeAndCast, isArrayType, isNull, isPrimitive, readSize, readSize, toString

Methods inherited from class java.lang.Object

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

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

decoderRegistered

Field Details

INSTANCE

public static final SaslOutcomeTypeDecoder INSTANCE

Constructor Details

SaslOutcomeTypeDecoder

public SaslOutcomeTypeDecoder()

Method Details

getDescriptorCode

public UnsignedLong getDescriptorCode()

Description copied from interface: DescribedTypeDecoder

Returns the AMQP descriptor code for the type this decoder reads.

Returns:

an unsigned long descriptor code value.

getDescriptorSymbol

public Symbol getDescriptorSymbol()

Description copied from interface: DescribedTypeDecoder

Returns the AMQP descriptor symbol for the type this decoder reads.

Returns:

an symbol descriptor code value.

getTypeClass

public Class<SaslOutcome> getTypeClass()

Description copied from interface: TypeDecoder

Returns the Class that this decoder handles.

Returns:

the Class that this decoder handles

getMinListElements

protected final int getMinListElements()

Description copied from class: AbstractDescribedListTypeDecoder

(@return the minimum number of elements that must appear in this list type}

Specified by:

getMinListElements in class AbstractDescribedListTypeDecoder<SaslOutcome>

getMaxListElements

protected final int getMaxListElements()

Description copied from class: AbstractDescribedListTypeDecoder

Returns the maximum number of elements that may appear in this list type.

Specified by:

getMaxListElements in class AbstractDescribedListTypeDecoder<SaslOutcome>

Returns:

the maximum number of elements that may appear in this list type

readType

protected SaslOutcome readType(int count,
 ProtonBuffer buffer,
 Decoder decoder,
 DecoderState state)
                        throws DecodeException

Description copied from class: AbstractDescribedListTypeDecoder

Reads the actual type from the byte stream with the given number of encoded list elements populated

Specified by:

readType in class AbstractDescribedListTypeDecoder<SaslOutcome>

Parameters:

count - The number of entries encoded into the list body.

buffer - The source of the encoded bytes to read the value from.

decoder - The list decoder that indicates the structure of the encoded lists of elements.

state - The decoder state that was passed at the start of decoding.

Returns:

a single value that is the described type this decoder reads using the given list decoder.

Throws:

DecodeException - if an error occurs while performing the decode.

readType

protected SaslOutcome readType(int count,
 InputStream stream,
 StreamDecoder decoder,
 StreamDecoderState state)
                        throws DecodeException

Description copied from class: AbstractDescribedListTypeDecoder

Reads the actual type from the byte stream with the given number of encoded list elements populated

Specified by:

readType in class AbstractDescribedListTypeDecoder<SaslOutcome>

Parameters:

count - The number of entries encoded into the list body.

stream - The source of the encoded bytes to read the value from.

decoder - The list decoder that indicates the structure of the encoded lists of elements.

state - The decoder state that was passed at the start of decoding.

Returns:

a single value that is the described type this decoder reads using the given list decoder.

Throws:

DecodeException - if an error occurs while performing the decode.