Module org.apache.qpid.protonj2

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

Class BooleanFalseTypeDecoder

java.lang.Object

org.apache.qpid.protonj2.codec.decoders.AbstractPrimitiveTypeDecoder<Boolean>

org.apache.qpid.protonj2.codec.decoders.primitives.BooleanTypeDecoder

org.apache.qpid.protonj2.codec.decoders.primitives.BooleanFalseTypeDecoder

All Implemented Interfaces:

PrimitiveTypeDecoder<Boolean>, StreamTypeDecoder<Boolean>, TypeDecoder<Boolean>

public final class BooleanFalseTypeDecoder
extends BooleanTypeDecoder

Decoder of AMQP Boolean False values from a byte stream.

Field Summary

Fields

Modifier and Type	Field	Description
static final BooleanFalseTypeDecoder	INSTANCE

Constructor Summary

Constructors

Constructor	Description
BooleanFalseTypeDecoder()

Method Summary

Modifier and Type	Method	Description
int	getTypeCode()	Returns the AMQP Encoding Code that this primitive type decoder can read.
boolean	isZeroWidth()	Returns true if the underlying type is a zero width type that has no encoding beyond the encoding code.
Boolean[]	readArrayElements(InputStream stream, StreamDecoderState state, int count)	Reads a series of this type that have been encoded into the body of an Array type.
Boolean[]	readArrayElements(ProtonBuffer buffer, DecoderState state, int count)	Reads a series of this type that have been encoded into the body of an Array type.
boolean[]	readPrimitiveArray(InputStream stream, StreamDecoderState state, int count)	Read and return a Java primitive type array from the given stream of bytes up to the given count of elements.
boolean[]	readPrimitiveArray(ProtonBuffer buffer, DecoderState state, int count)	Read and return a Java primitive type array from the given stream of bytes up to the given count of elements.
boolean	readPrimitiveValue(InputStream stream, StreamDecoderState state)	Reads the primitive value from the given InputStream and returns it.
boolean	readPrimitiveValue(ProtonBuffer buffer, DecoderState state)	Reads the primitive value from the given ProtonBuffer and returns it.
int	readSize(InputStream stream, StreamDecoderState state)	Reads the size in bytes of the encoded primitive from the given InputStream and returns it.
int	readSize(ProtonBuffer buffer, DecoderState state)	Reads the size in bytes of the encoded AMQP type from the given buffer and returns it.
Boolean	readValue(InputStream stream, StreamDecoderState state)	Reads the next type from the given buffer and returns it.
Boolean	readValue(ProtonBuffer buffer, DecoderState state)	Reads the next type from the given buffer and returns it.
void	skipValue(InputStream stream, StreamDecoderState state)	Skips over the bytes that compose the type this descriptor decodes.
void	skipValue(ProtonBuffer buffer, DecoderState state)	Skips over the bytes that compose the type this descriptor decodes.

Methods inherited from class org.apache.qpid.protonj2.codec.decoders.primitives.BooleanTypeDecoder

getTypeClass, isJavaPrimitive

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

isArrayType, isNull

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.decoders.PrimitiveTypeDecoder

isPrimitive

Field Details

INSTANCE

public static final BooleanFalseTypeDecoder INSTANCE

Constructor Details

BooleanFalseTypeDecoder

public BooleanFalseTypeDecoder()

Method Details

readValue

public Boolean readValue(ProtonBuffer buffer,
 DecoderState state)
                  throws DecodeException

Description copied from interface: TypeDecoder

Reads the next type from the given buffer and returns it.

Specified by:

readValue in interface TypeDecoder<Boolean>

Overrides:

readValue in class BooleanTypeDecoder

Parameters:

buffer - the source of encoded data.

state - the current state of the decoder.

Returns:

the next instance in the stream that this decoder handles.

Throws:

DecodeException - if an error is encountered while reading the next value.

readValue

public Boolean readValue(InputStream stream,
 StreamDecoderState state)
                  throws DecodeException

Description copied from interface: StreamTypeDecoder

Reads the next type from the given buffer and returns it.

Specified by:

readValue in interface StreamTypeDecoder<Boolean>

Overrides:

readValue in class BooleanTypeDecoder

Parameters:

stream - the source of encoded data.

state - the current state of the decoder.

Returns:

the next instance in the stream that this decoder handles.

Throws:

DecodeException - if an error is encountered while reading the next value.

getTypeCode

public int getTypeCode()

Description copied from interface: PrimitiveTypeDecoder

Returns the AMQP Encoding Code that this primitive type decoder can read.

Specified by:

getTypeCode in interface PrimitiveTypeDecoder<Boolean>

Overrides:

getTypeCode in class BooleanTypeDecoder

Returns:

the AMQP Encoding Code that this primitive type decoder can read

isZeroWidth

public boolean isZeroWidth()

Description copied from interface: PrimitiveTypeDecoder

Returns true if the underlying type is a zero width type that has no encoding beyond the encoding code.

Returns:

true if the underlying type is a zero width type that has no encoding beyond the encoding code

readPrimitiveValue

public boolean readPrimitiveValue(ProtonBuffer buffer,
 DecoderState state)
                           throws DecodeException

Description copied from class: BooleanTypeDecoder

Reads the primitive value from the given ProtonBuffer and returns it.

Overrides:

readPrimitiveValue in class BooleanTypeDecoder

Parameters:

buffer - The ProtonBuffer where the primitive value should be read from.

state - The DecoderState that can be used during decode of the value.

Returns:

the decoded primitive value.

Throws:

DecodeException - if an error occurs while reading the encoded value.

readPrimitiveValue

public boolean readPrimitiveValue(InputStream stream,
 StreamDecoderState state)
                           throws DecodeException

Description copied from class: BooleanTypeDecoder

Reads the primitive value from the given InputStream and returns it.

Overrides:

readPrimitiveValue in class BooleanTypeDecoder

Parameters:

stream - The InputStream where the primitive value should be read from.

state - The DecoderState that can be used during decode of the value.

Returns:

the decoded primitive value.

Throws:

DecodeException - if an error occurs while reading the encoded value.

skipValue

public void skipValue(ProtonBuffer buffer,
 DecoderState state)
               throws DecodeException

Description copied from interface: TypeDecoder

Skips over the bytes that compose the type this descriptor decodes.

Skipping values can be used when the type is not used or processed by the application doing the decoding. An example might be an AMQP message decoder that only needs to decode certain parts of the message and not others.

Specified by:

skipValue in interface TypeDecoder<Boolean>

Overrides:

skipValue in class BooleanTypeDecoder

Parameters:

buffer - The buffer that contains the encoded type.

state - The decoder state.

Throws:

DecodeException - if an error occurs while skipping the value.

skipValue

public void skipValue(InputStream stream,
 StreamDecoderState state)
               throws DecodeException

Description copied from interface: StreamTypeDecoder

Skips over the bytes that compose the type this descriptor decodes.

Skipping values can be used when the type is not used or processed by the application doing the decoding. An example might be an AMQP message decoder that only needs to decode certain parts of the message and not others.

Specified by:

skipValue in interface StreamTypeDecoder<Boolean>

Overrides:

skipValue in class BooleanTypeDecoder

Parameters:

stream - The stream that contains the encoded type.

state - The decoder state.

Throws:

DecodeException - if an error occurs while skipping the value.

readSize

public int readSize(ProtonBuffer buffer,
 DecoderState state)

Description copied from interface: TypeDecoder

Reads the size in bytes of the encoded AMQP type from the given buffer and returns it. Since this methods advances the read position of the provided buffer the caller must either reset that based on a previous mark or they must read the primitive payload manually as the decoder would not be able to read the value as it has no retained state.

Specified by:

readSize in interface TypeDecoder<Boolean>

Overrides:

readSize in class BooleanTypeDecoder

Parameters:

buffer - the source of encoded data.

state - the current state of the decoder.

Returns:

the size in bytes of the encoded primitive value.

readSize

public int readSize(InputStream stream,
 StreamDecoderState state)

Description copied from interface: StreamTypeDecoder

Reads the size in bytes of the encoded primitive from the given InputStream and returns it. Since this methods advances the read position of the provided stream the caller must either reset that based on a previous mark or they must read the primitive payload manually as the decoder would not be able to read the value as it has no retained state.

Specified by:

readSize in interface StreamTypeDecoder<Boolean>

Overrides:

readSize in class BooleanTypeDecoder

Parameters:

stream - the source of encoded data.

state - the current state of the decoder.

Returns:

the size in bytes of the encoded primitive value.

readArrayElements

public Boolean[] readArrayElements(ProtonBuffer buffer,
 DecoderState state,
 int count)
                            throws DecodeException

Description copied from interface: TypeDecoder

Reads a series of this type that have been encoded into the body of an Array type.

When encoded into an array the values are encoded in series following the identifier for the type, this method is given a count of the number of instances that are encoded and should read each in succession and returning them in a new array.

Specified by:

readArrayElements in interface TypeDecoder<Boolean>

Overrides:

readArrayElements in class AbstractPrimitiveTypeDecoder<Boolean>

Parameters:

buffer - the source of encoded data.

state - the current state of the decoder.

count - the number of array elements encoded in the buffer.

Returns:

the next instance in the stream that this decoder handles.

Throws:

DecodeException - if an error is encountered while reading the next value.

readArrayElements

public Boolean[] readArrayElements(InputStream stream,
 StreamDecoderState state,
 int count)
                            throws DecodeException

Description copied from interface: StreamTypeDecoder

Reads a series of this type that have been encoded into the body of an Array type.

When encoded into an array the values are encoded in series following the identifier for the type, this method is given a count of the number of instances that are encoded and should read each in succession and returning them in a new array.

Specified by:

readArrayElements in interface StreamTypeDecoder<Boolean>

Overrides:

readArrayElements in class AbstractPrimitiveTypeDecoder<Boolean>

Parameters:

stream - the source of encoded data.

state - the current state of the decoder.

count - the number of array elements encoded in the buffer.

Returns:

the next instance in the stream that this decoder handles.

Throws:

DecodeException - if an error is encountered while reading the next value.

readPrimitiveArray

public boolean[] readPrimitiveArray(ProtonBuffer buffer,
 DecoderState state,
 int count)

Description copied from interface: PrimitiveTypeDecoder

Read and return a Java primitive type array from the given stream of bytes up to the given count of elements.

Specified by:

readPrimitiveArray in interface PrimitiveTypeDecoder<Boolean>

Overrides:

readPrimitiveArray in class BooleanTypeDecoder

Parameters:

buffer - The source of bytes to read the primitive type from.

state - The decoder state used when performing the decode operation.

count - The number of elements that comprise the array to read.

Returns:

an array made up of Java primitive values stored in the primitive typed array.

readPrimitiveArray

public boolean[] readPrimitiveArray(InputStream stream,
 StreamDecoderState state,
 int count)

Description copied from interface: PrimitiveTypeDecoder

Read and return a Java primitive type array from the given stream of bytes up to the given count of elements.

Specified by:

readPrimitiveArray in interface PrimitiveTypeDecoder<Boolean>

Overrides:

readPrimitiveArray in class BooleanTypeDecoder

Parameters:

stream - The source of bytes to read the primitive type from.

state - The decoder state used when performing the decode operation.

count - The number of elements that comprise the array to read.

Returns:

an array made up of Java primitive values stored in the primitive typed array.