Module org.apache.qpid.protonj2

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

Class FloatTypeDecoder

java.lang.Object

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

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

All Implemented Interfaces:

PrimitiveTypeDecoder<Float>, StreamTypeDecoder<Float>, TypeDecoder<Float>

public final class FloatTypeDecoder
extends AbstractPrimitiveTypeDecoder<Float>

Decoder of AMQP Float values from a byte stream.

Field Summary

Fields

Modifier and Type	Field	Description
static final FloatTypeDecoder	INSTANCE

Constructor Summary

Constructors

Constructor	Description
FloatTypeDecoder()

Method Summary

Modifier and Type	Method	Description
Class<Float>	getTypeClass()	Returns the Class that this decoder handles.
int	getTypeCode()	Returns the AMQP Encoding Code that this primitive type decoder can read.
boolean	isJavaPrimitive()	Returns true if the type managed by this decoder is assignable to a Java primitive type.
float[]	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.
float[]	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.
float	readPrimitiveValue(InputStream stream, StreamDecoderState state)	Reads the primitive value from the given InputStream and returns it.
float	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.
Float	readValue(InputStream stream, StreamDecoderState state)	Reads the next type from the given buffer and returns it.
Float	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.AbstractPrimitiveTypeDecoder

isArrayType, isNull, readArrayElements, readArrayElements

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, isZeroWidth

Field Details

INSTANCE

public static final FloatTypeDecoder INSTANCE

Constructor Details

FloatTypeDecoder

public FloatTypeDecoder()

Method Details

isJavaPrimitive

public boolean isJavaPrimitive()

Description copied from interface: PrimitiveTypeDecoder

Returns true if the type managed by this decoder is assignable to a Java primitive type.

Specified by:

isJavaPrimitive in interface PrimitiveTypeDecoder<Float>

Overrides:

isJavaPrimitive in class AbstractPrimitiveTypeDecoder<Float>

Returns:

true if the type managed by this decoder is assignable to a Java primitive type

getTypeClass

public Class<Float> getTypeClass()

Description copied from interface: TypeDecoder

Returns the Class that this decoder handles.

Returns:

the Class that this decoder handles

getTypeCode

public int getTypeCode()

Description copied from interface: PrimitiveTypeDecoder

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

Returns:

the AMQP Encoding Code that this primitive type decoder can read

readValue

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

Description copied from interface: TypeDecoder

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

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 Float readValue(InputStream stream,
 StreamDecoderState state)
                throws DecodeException

Description copied from interface: StreamTypeDecoder

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

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.

readPrimitiveValue

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

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

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 float readPrimitiveValue(InputStream stream,
 StreamDecoderState state)
                         throws DecodeException

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

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.

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.

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.

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.

Parameters:

stream - the source of encoded data.

state - the current state of the decoder.

Returns:

the size in bytes of the encoded primitive value.

readPrimitiveArray

public float[] 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.

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 float[] 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.

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.