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

Class ProtonDecoderState

java.lang.Object

org.apache.qpid.protonj2.codec.decoders.ProtonDecoderState

All Implemented Interfaces:

DecoderState

public final class ProtonDecoderState
extends java.lang.Object
implements DecoderState

State object used by the Built in Decoder implementation.

Constructor Summary

Constructors

Constructor	Description
ProtonDecoderState(ProtonDecoder decoder)	Create a new DecoderState instance that is joined forever to the given Decoder.

Method Summary

Modifier and Type	Method	Description
java.lang.String	decodeUTF8(ProtonBuffer buffer, int length)	Given a set of UTF-8 encoded bytes decode and return the String that represents that UTF-8 value.
ProtonDecoder	getDecoder()
UTF8Decoder	getStringDecoder()
ProtonDecoderState	reset()	Resets any intermediate state back to default values.
ProtonDecoderState	setStringDecoder(UTF8Decoder stringDecoder)	Sets a custom UTF-8 String decoder that will be used for all String decoding done from the encoder associated with this DecoderState instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtonDecoderState

public ProtonDecoderState(ProtonDecoder decoder)

Create a new DecoderState instance that is joined forever to the given Decoder.

Parameters:

decoder - The Decoder that this state instance is assigned to.

Method Detail

getDecoder

public ProtonDecoder getDecoder()

Specified by:

getDecoder in interface DecoderState

Returns:

the decoder that created this state object

reset

public ProtonDecoderState reset()

Description copied from interface: DecoderState

Resets any intermediate state back to default values.

Specified by:

reset in interface DecoderState

Returns:

this DecoderState instance.

getStringDecoder

public UTF8Decoder getStringDecoder()

Returns:

the currently set custom UTF-8 String decoder or null if non set.

setStringDecoder

public ProtonDecoderState setStringDecoder(UTF8Decoder stringDecoder)

Sets a custom UTF-8 String decoder that will be used for all String decoding done from the encoder associated with this DecoderState instance. If no decoder is registered then the implementation uses its own decoding algorithm.

Parameters:

stringDecoder - a custom UTF8Decoder that will be used for all String decoding.

Returns:

this Decoder instance.

decodeUTF8

public java.lang.String decodeUTF8(ProtonBuffer buffer,
                                   int length)
                            throws DecodeException

Description copied from interface: DecoderState

Given a set of UTF-8 encoded bytes decode and return the String that represents that UTF-8 value.

Specified by:

decodeUTF8 in interface DecoderState

Parameters:

buffer - A buffer containing the UTF-8 encoded bytes to be decoded.

length - The number of bytes in the passed buffer that comprise the UTF-8 encoding.

Returns:

a String that represents the UTF-8 decoded bytes.

Throws:

DecodeException - if an error occurs while decoding the string value.