Class List0TypeDecoder
java.lang.Object
org.apache.qpid.protonj2.codec.decoders.AbstractPrimitiveTypeDecoder<List>
org.apache.qpid.protonj2.codec.decoders.primitives.List0TypeDecoder
- All Implemented Interfaces:
ListTypeDecoder
,PrimitiveTypeDecoder<List>
,StreamTypeDecoder<List>
,TypeDecoder<List>
public final class List0TypeDecoder
extends AbstractPrimitiveTypeDecoder<List>
implements ListTypeDecoder
Decoder of Zero sized AMQP List values from a byte stream.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
int
readCount
(InputStream stream, StreamDecoderState state) Reads the number of elements contained in the encoded list from the providedInputStream
.int
readCount
(ProtonBuffer buffer, DecoderState state) Reads the number of elements contained in the encoded list from the providedProtonBuffer
.int
readSize
(InputStream stream, StreamDecoderState state) Reads the size in bytes of the encoded primitive from the givenInputStream
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.readValue
(InputStream stream, StreamDecoderState state) Reads the next type from the given buffer and returns it.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, 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.primitives.ListTypeDecoder
getTypeClass
Methods inherited from interface org.apache.qpid.protonj2.codec.decoders.PrimitiveTypeDecoder
isJavaPrimitive, isPrimitive
Methods inherited from interface org.apache.qpid.protonj2.codec.StreamTypeDecoder
getTypeClass, isArrayType, isNull, readArrayElements
Methods inherited from interface org.apache.qpid.protonj2.codec.TypeDecoder
isArrayType, isNull, readArrayElements
-
Constructor Details
-
List0TypeDecoder
public List0TypeDecoder()
-
-
Method Details
-
getTypeCode
public int getTypeCode()- Specified by:
getTypeCode
in interfacePrimitiveTypeDecoder<List>
- Returns:
- the AMQP Encoding Code that this primitive type decoder can read.
-
readValue
Description copied from interface:TypeDecoder
Reads the next type from the given buffer and returns it.- Specified by:
readValue
in interfaceTypeDecoder<List>
- 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
Description copied from interface:StreamTypeDecoder
Reads the next type from the given buffer and returns it.- Specified by:
readValue
in interfaceStreamTypeDecoder<List>
- 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
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 interfaceTypeDecoder<List>
- Parameters:
buffer
- The buffer that contains the encoded type.state
- The decoder state.- Throws:
DecodeException
- if an error occurs while skipping the value.
-
skipValue
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 interfaceStreamTypeDecoder<List>
- Parameters:
stream
- The stream that contains the encoded type.state
- The decoder state.- Throws:
DecodeException
- if an error occurs while skipping the value.
-
readSize
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 interfaceTypeDecoder<List>
- Parameters:
buffer
- the source of encoded data.state
- the current state of the decoder.- Returns:
- the size in bytes of the encoded primitive value.
- Throws:
DecodeException
- if an error is encountered while reading the encoded size.
-
readCount
Description copied from interface:ListTypeDecoder
Reads the number of elements contained in the encoded list from the providedProtonBuffer
. The implementation must read the correct size encoding based on the type ofList
that thisTypeDecoder
handles.- Specified by:
readCount
in interfaceListTypeDecoder
- Parameters:
buffer
- The buffer where the size value should be read from.state
- The decoder state that is in used during this decode operation.- Returns:
- an integer containing the number of elements in the encoded
List
. - Throws:
DecodeException
- if an error occurs while reading the encoded element count.
-
readSize
Description copied from interface:StreamTypeDecoder
Reads the size in bytes of the encoded primitive from the givenInputStream
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 interfaceStreamTypeDecoder<List>
- Parameters:
stream
- the source of encoded data.state
- the current state of the decoder.- Returns:
- the size in bytes of the encoded primitive value.
- Throws:
DecodeException
- if an error is encountered while reading the encoded size.
-
readCount
Description copied from interface:ListTypeDecoder
Reads the number of elements contained in the encoded list from the providedInputStream
. The implementation must read the correct size encoding based on the type ofList
that thisTypeDecoder
handles.- Specified by:
readCount
in interfaceListTypeDecoder
- Parameters:
stream
- The stream where the size value should be read from.state
- The decoder state that is in used during this decode operation.- Returns:
- an integer containing the number of elements in the encoded
List
. - Throws:
DecodeException
- if an error occurs while reading the encoded element count.
-