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

Class AbstractMapTypeDecoder

java.lang.Object

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

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

All Implemented Interfaces:

MapTypeDecoder, PrimitiveTypeDecoder<Map>, StreamTypeDecoder<Map>, TypeDecoder<Map>

Direct Known Subclasses:

Map32TypeDecoder, Map8TypeDecoder

public abstract class AbstractMapTypeDecoder
extends AbstractPrimitiveTypeDecoder<Map>
implements MapTypeDecoder

Base for the various Map type decoders used to read AMQP Map values.

Constructor Summary

Constructors

Constructor	Description
AbstractMapTypeDecoder()

Method Summary

Modifier and Type	Method	Description
Map<Object,Object>	readValue(InputStream stream, StreamDecoderState state)	Reads the next type from the given buffer and returns it.
Map<Object,Object>	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

Methods inherited from interface org.apache.qpid.protonj2.codec.decoders.primitives.MapTypeDecoder

getTypeClass, readCount, readCount, readSize, readSize

Methods inherited from interface org.apache.qpid.protonj2.codec.decoders.PrimitiveTypeDecoder

getTypeCode, isJavaPrimitive

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

getTypeClass, isArrayType, readArrayElements

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

isArrayType, readArrayElements

Constructor Details

AbstractMapTypeDecoder

public AbstractMapTypeDecoder()

Method Details

readValue

public Map<Object,Object> 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<Map>

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.

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

Parameters:

buffer - The buffer that contains the encoded type.

state - The decoder state.

Throws:

DecodeException - if an error occurs while skipping the value.

readValue

public Map<Object,Object> 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<Map>

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(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<Map>

Parameters:

stream - The stream that contains the encoded type.

state - The decoder state.

Throws:

DecodeException - if an error occurs while skipping the value.