Package org.apache.qpid.protonj2.codec

Interface StreamDecoderState

All Known Implementing Classes:

ProtonStreamDecoderState

public interface StreamDecoderState

Retains state of the InputStream based decode either between calls or across decode iterations

Method Summary

Modifier and Type	Method	Description
String	decodeUTF8(InputStream stream, int length)	Given a stream that will provide UTF-8 encoded bytes, decode and return the String that represents that UTF-8 value.
StreamDecoder	getDecoder()
StreamDecoderState	reset()	Resets any intermediate state back to default values.

Method Details

reset

StreamDecoderState reset()

Resets any intermediate state back to default values.

Returns:

this StreamDecoderState instance.

getDecoder

StreamDecoder getDecoder()

Returns:

the StreamDecoder that created this state object

decodeUTF8

String decodeUTF8(InputStream stream,
 int length)
           throws DecodeException

Given a stream that will provide UTF-8 encoded bytes, decode and return the String that represents that UTF-8 value.

Parameters:

stream - A stream from which the UTF-8 encoded bytes are to be decoded.

length - The number of bytes in the passed InputStream 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.