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

Class NullTypeDecoder

java.lang.Object

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

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

All Implemented Interfaces:

PrimitiveTypeDecoder<Void>, StreamTypeDecoder<Void>, TypeDecoder<Void>

public final class NullTypeDecoder
extends AbstractPrimitiveTypeDecoder<Void>

Decoder of AMQP Null values from a byte stream.

Constructor Summary

Constructors

Constructor	Description
NullTypeDecoder()

Method Summary

Modifier and Type	Method	Description
Class<Void>	getTypeClass()
int	getTypeCode()
Void	readValue(InputStream stream, StreamDecoderState state)	Reads the next type from the given buffer and returns it.
Void	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, isJavaPrimitive, readArrayElements, readArrayElements

Methods inherited from class java.lang.Object

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

Constructor Details

NullTypeDecoder

public NullTypeDecoder()

Method Details

getTypeCode

public int getTypeCode()

Returns:

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

getTypeClass

public Class<Void> getTypeClass()

Returns:

the Class that this decoder handles.

readValue

public Void 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 Void 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.

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.