Module org.apache.qpid.protonj2

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

Interface BinaryTypeDecoder

All Superinterfaces:

PrimitiveTypeDecoder<Binary>, StreamTypeDecoder<Binary>, TypeDecoder<Binary>

All Known Implementing Classes:

AbstractBinaryTypeDecoder, Binary32TypeDecoder, Binary8TypeDecoder

public interface BinaryTypeDecoder
extends PrimitiveTypeDecoder<Binary>

Base for all Binary type value decoders.

Method Summary

Modifier and Type	Method	Description
default Class<Binary>	getTypeClass()	Returns the Class that this decoder handles.
byte[]	readValueAsArray(InputStream stream, StreamDecoderState state)	Read and decode an AMQP Binary into a byte array instance and return it.
byte[]	readValueAsArray(ProtonBuffer buffer, DecoderState state)	Read and decode an AMQP Binary into a byte array instance and return it.
ProtonBuffer	readValueAsBuffer(InputStream stream, StreamDecoderState state)	Read and decode an AMQP Binary into a ProtonBuffer instance and return it.
ProtonBuffer	readValueAsBuffer(ProtonBuffer buffer, DecoderState state)	Read and decode an AMQP Binary into a ProtonBuffer instance and return it.

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

getTypeCode, isJavaPrimitive, isPrimitive, isZeroWidth, readPrimitiveArray, readPrimitiveArray

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

isArrayType, isNull, readArrayElements, readSize, readValue, skipValue

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

isArrayType, isNull, readArrayElements, readSize, readValue, skipValue

Method Details

getTypeClass

default Class<Binary> getTypeClass()

Description copied from interface: TypeDecoder

Returns the Class that this decoder handles.

Specified by:

getTypeClass in interface StreamTypeDecoder<Binary>

Specified by:

getTypeClass in interface TypeDecoder<Binary>

Returns:

the Class that this decoder handles

readValueAsBuffer

ProtonBuffer readValueAsBuffer(ProtonBuffer buffer,
 DecoderState state)
                        throws DecodeException

Read and decode an AMQP Binary into a ProtonBuffer instance and return it.

Parameters:

buffer - The ProtonBuffer where the Binary encoding should be read from.

state - The EncoderState that can be used when reading the encoded value.

Returns:

the bytes that comprise the encoded Binary wrapped in a ProtonBuffer instance.

Throws:

DecodeException - if an error occurs while reading the Binary value.

readValueAsArray

byte[] readValueAsArray(ProtonBuffer buffer,
 DecoderState state)
                 throws DecodeException

Read and decode an AMQP Binary into a byte array instance and return it.

Parameters:

buffer - The ProtonBuffer where the Binary encoding should be read from.

state - The EncoderState that can be used when reading the encoded value.

Returns:

the bytes that comprise the encoded Binary copied into a byte array instance.

Throws:

DecodeException - if an error occurs while reading the Binary value.

readValueAsBuffer

ProtonBuffer readValueAsBuffer(InputStream stream,
 StreamDecoderState state)
                        throws DecodeException

Read and decode an AMQP Binary into a ProtonBuffer instance and return it.

Parameters:

stream - The InputStream where the Binary encoding should be read from.

state - The EncoderState that can be used when reading the encoded value.

Returns:

the bytes that comprise the encoded Binary wrapped in a ProtonBuffer instance.

Throws:

DecodeException - if an error occurs while reading the Binary value.

readValueAsArray

byte[] readValueAsArray(InputStream stream,
 StreamDecoderState state)
                 throws DecodeException

Read and decode an AMQP Binary into a byte array instance and return it.

Parameters:

stream - The InputStream where the Binary encoding should be read from.

state - The EncoderState that can be used when reading the encoded value.

Returns:

the bytes that comprise the encoded Binary copied into a byte array instance.

Throws:

DecodeException - if an error occurs while reading the Binary value.