com.siemens.ct.exi.core.io.channel

Interface DecoderChannel

All Known Implementing Classes:

AbstractDecoderChannel, BitDecoderChannel, ByteDecoderChannel

public interface DecoderChannel

Author:

Daniel.Peintner.EXT@siemens.com, Richard.Kuntschke@siemens.com

Method Summary

Modifier and Type	Method and Description
void	align() Align to next byte-aligned boundary in the stream if it is not already at such a boundary
int	decode() Decodes a single byte
byte[]	decodeBinary() Decode a binary value as a length-prefixed sequence of octets.
boolean	decodeBoolean() Decode a single boolean value.
BooleanValue	decodeBooleanValue()
DateTimeValue	decodeDateTimeValue(DateTimeType type) Decode Date-Time as sequence of values representing the individual components of the Date-Time.
DecimalValue	decodeDecimalValue() Decode a decimal represented as a Boolean sign followed by two Unsigned Integers.
FloatValue	decodeFloatValue() Decode a Float represented as two consecutive Integers.
IntegerValue	decodeIntegerValue() Decode an arbitrary precision integer using a sign bit followed by a sequence of octets.
int	decodeNBitUnsignedInteger(int n) Decodes and returns an n-bit unsigned integer.
IntegerValue	decodeNBitUnsignedIntegerValue(int n)
char[]	decodeString() Decode a string as a length-prefixed sequence of UCS codepoints, each of which is encoded as an integer.
char[]	decodeStringOnly(int length) Decode the characters of a string whose length has already been read.
int	decodeUnsignedInteger() Decode an arbitrary precision non negative integer using a sequence of octets.
IntegerValue	decodeUnsignedIntegerValue()
void	skip(long n) Skips over and discards n bytes of data from this channel.

Method Detail

decode

int decode()
    throws IOException

Decodes a single byte

Returns:

a byte as int

Throws:

IOException - IO exception

align

void align()
    throws IOException

Align to next byte-aligned boundary in the stream if it is not already at such a boundary

Throws:

IOException - IO exception

skip

void skip(long n)
   throws IOException

Skips over and discards n bytes of data from this channel.

Parameters:

n - number of bytes to skip

Throws:

IOException - IO exception

decodeNBitUnsignedInteger

int decodeNBitUnsignedInteger(int n)
                       throws IOException

Decodes and returns an n-bit unsigned integer.

Parameters:

n - number of bits

Returns:

nbit value

Throws:

IOException - IO exception

decodeNBitUnsignedIntegerValue

IntegerValue decodeNBitUnsignedIntegerValue(int n)
                                     throws IOException

Throws:

IOException

decodeBoolean

boolean decodeBoolean()
               throws IOException

Decode a single boolean value. The value false is represented by the bit (byte) 0, and the value true is represented by the bit (byte) 1.

Returns:

boolean value

Throws:

IOException - IO exception

decodeBooleanValue

BooleanValue decodeBooleanValue()
                         throws IOException

Throws:

IOException

decodeBinary

byte[] decodeBinary()
             throws IOException

Decode a binary value as a length-prefixed sequence of octets.

Returns:

binary data

Throws:

IOException - IO exception

decodeString

char[] decodeString()
             throws IOException

Decode a string as a length-prefixed sequence of UCS codepoints, each of which is encoded as an integer. Look for codepoints of more than 16 bits that are represented as UTF-16 surrogate pairs in Java.

Returns:

characters

Throws:

IOException - IO exception

decodeStringOnly

char[] decodeStringOnly(int length)
                 throws IOException

Decode the characters of a string whose length has already been read. Look for codepoints of more than 16 bits that are represented as UTF-16 surrogate pairs in Java.

Parameters:

length - Length of the character sequence to read.

Returns:

The character sequence

Throws:

IOException - IO exception

decodeUnsignedInteger

int decodeUnsignedInteger()
                   throws IOException

Decode an arbitrary precision non negative integer using a sequence of octets. The most significant bit of the last octet is set to zero to indicate sequence termination. Only seven bits per octet are used to store the integer's value.

Returns:

unsigned integer

Throws:

IOException - IO exception

decodeUnsignedIntegerValue

IntegerValue decodeUnsignedIntegerValue()
                                 throws IOException

Throws:

IOException

decodeIntegerValue

IntegerValue decodeIntegerValue()
                         throws IOException

Decode an arbitrary precision integer using a sign bit followed by a sequence of octets. The most significant bit of the last octet is set to zero to indicate sequence termination. Only seven bits per octet are used to store the integer's value.

Returns:

integer value

Throws:

IOException - IO exception

decodeDecimalValue

DecimalValue decodeDecimalValue()
                         throws IOException

Decode a decimal represented as a Boolean sign followed by two Unsigned Integers. A sign value of zero (0) is used to represent positive Decimal values and a sign value of one (1) is used to represent negative Decimal values The first Integer represents the integral portion of the Decimal value. The second positive integer represents the fractional portion of the decimal with the digits in reverse order to preserve leading zeros.

Returns:

decimal value

Throws:

IOException - IO exception

decodeFloatValue

FloatValue decodeFloatValue()
                     throws IOException

Decode a Float represented as two consecutive Integers. The first Integer represents the mantissa of the floating point number and the second Integer represents the 10-based exponent of the floating point number

Returns:

float value

Throws:

IOException - IO exception

decodeDateTimeValue

DateTimeValue decodeDateTimeValue(DateTimeType type)
                           throws IOException

Decode Date-Time as sequence of values representing the individual components of the Date-Time.

Parameters:

type - date-Time type

Returns:

date-time value

Throws:

IOException - IO exception