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

Interface ListTypeDecoder

All Superinterfaces:

PrimitiveTypeDecoder<java.util.List>, StreamTypeDecoder<java.util.List>, TypeDecoder<java.util.List>

All Known Implementing Classes:

AbstractListTypeDecoder, List0TypeDecoder, List32TypeDecoder, List8TypeDecoder

public interface ListTypeDecoder
extends PrimitiveTypeDecoder<java.util.List>

Base class for List type decoders.

Method Summary

Modifier and Type	Method	Description
default java.lang.Class<java.util.List>	getTypeClass()
int	readCount(java.io.InputStream stream)	Reads the number of elements contained in the encoded list from the provided InputStream.
int	readCount(ProtonBuffer buffer)	Reads the number of elements contained in the encoded list from the provided ProtonBuffer.
int	readSize(java.io.InputStream stream)	Reads the size in bytes of the encoded list from the provided InputStream.
int	readSize(ProtonBuffer buffer)	Reads the size in bytes of the encoded list from the provided ProtonBuffer.

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

getTypeCode, isJavaPrimitive

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

isArrayType, readArrayElements, readValue, skipValue

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

isArrayType, readArrayElements, readValue, skipValue

Method Detail

readSize

int readSize(ProtonBuffer buffer)
      throws DecodeException

Reads the size in bytes of the encoded list from the provided ProtonBuffer. The implementation must read the correct size encoding based on the type of List that this TypeDecoder handles.

Parameters:

buffer - The buffer where the size value should be read from.

Returns:

an integer containing the size in bytes of the encoded List.

Throws:

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

readCount

int readCount(ProtonBuffer buffer)
       throws DecodeException

Reads the number of elements contained in the encoded list from the provided ProtonBuffer. The implementation must read the correct size encoding based on the type of List that this TypeDecoder handles.

Parameters:

buffer - The buffer where the size value should be read from.

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

int readSize(java.io.InputStream stream)
      throws DecodeException

Reads the size in bytes of the encoded list from the provided InputStream. The implementation must read the correct size encoding based on the type of List that this TypeDecoder handles.

Parameters:

stream - The stream where the size value should be read from.

Returns:

an integer containing the size in bytes of the encoded List.

Throws:

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

readCount

int readCount(java.io.InputStream stream)
       throws DecodeException

Reads the number of elements contained in the encoded list from the provided InputStream. The implementation must read the correct size encoding based on the type of List that this TypeDecoder handles.

Parameters:

stream - The stream where the size value should be read from.

Returns:

an integer containing the number of elements in the encoded List.

Throws:

DecodeException - if an error occurs while reading the encoded element count.

getTypeClass

default java.lang.Class<java.util.List> getTypeClass()

Specified by:

getTypeClass in interface StreamTypeDecoder<java.util.List>

Specified by:

getTypeClass in interface TypeDecoder<java.util.List>

Returns:

the Class that this decoder handles.