EXIficient

com.siemens.ct.exi.io.channel
Interface DecoderChannel

All Known Implementing Classes:
AbstractDecoderChannel, BitDecoderChannel, ByteDecoderChannel

public interface DecoderChannel

TODO Description

Version:
0.4.20081117
Author:
Daniel.Peintner.EXT@siemens.com, Joerg.Heuer@siemens.com

Method Summary
 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
 BinaryValue 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.
 DoubleValue decodeDoubleValue()
           
 FloatValue decodeFloatValue()
          Decode a Float represented as two consecutive Integers.
 HugeIntegerValue decodeHugeIntegerValue()
           
 IntegerValue decodeIntegerValue()
          Decode an arbitrary precision integer using a sign bit followed by a sequence of octets.
 LongValue decodeLongValue()
           
 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.
 HugeIntegerValue decodeUnsignedHugeIntegerValue()
           
 int decodeUnsignedInteger()
          Decode an arbitrary precision non negative integer using a sequence of octets.
 IntegerValue decodeUnsignedIntegerValue()
           
 LongValue decodeUnsignedLongValue()
           
 

Method Detail

decode

int decode()
           throws java.io.IOException
Decodes a single byte

Returns:
a byte as int
Throws:
java.io.IOException

align

void align()
           throws java.io.IOException
Align to next byte-aligned boundary in the stream if it is not already at such a boundary

Throws:
java.io.IOException

decodeNBitUnsignedInteger

int decodeNBitUnsignedInteger(int n)
                              throws java.io.IOException
Decodes and returns an n-bit unsigned integer.

Throws:
java.io.IOException

decodeNBitUnsignedIntegerValue

IntegerValue decodeNBitUnsignedIntegerValue(int n)
                                            throws java.io.IOException
Throws:
java.io.IOException

decodeBoolean

boolean decodeBoolean()
                      throws java.io.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.

Throws:
java.io.IOException

decodeBooleanValue

BooleanValue decodeBooleanValue()
                                throws java.io.IOException
Throws:
java.io.IOException

decodeBinary

BinaryValue decodeBinary()
                         throws java.io.IOException
Decode a binary value as a length-prefixed sequence of octets.

Throws:
java.io.IOException

decodeString

char[] decodeString()
                    throws java.io.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.

Throws:
java.io.IOException

decodeStringOnly

char[] decodeStringOnly(int length)
                        throws java.io.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:
java.io.IOException

decodeUnsignedInteger

int decodeUnsignedInteger()
                          throws java.io.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.

Throws:
java.io.IOException

decodeUnsignedIntegerValue

IntegerValue decodeUnsignedIntegerValue()
                                        throws java.io.IOException
Throws:
java.io.IOException

decodeUnsignedLongValue

LongValue decodeUnsignedLongValue()
                                  throws java.io.IOException
Throws:
java.io.IOException

decodeUnsignedHugeIntegerValue

HugeIntegerValue decodeUnsignedHugeIntegerValue()
                                                throws java.io.IOException
Throws:
java.io.IOException

decodeIntegerValue

IntegerValue decodeIntegerValue()
                                throws java.io.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.

Throws:
java.io.IOException

decodeLongValue

LongValue decodeLongValue()
                          throws java.io.IOException
Throws:
java.io.IOException

decodeHugeIntegerValue

HugeIntegerValue decodeHugeIntegerValue()
                                        throws java.io.IOException
Throws:
java.io.IOException

decodeDecimalValue

DecimalValue decodeDecimalValue()
                                throws java.io.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.

Throws:
java.io.IOException

decodeFloatValue

FloatValue decodeFloatValue()
                            throws java.io.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

Throws:
java.io.IOException

decodeDoubleValue

DoubleValue decodeDoubleValue()
                              throws java.io.IOException
Throws:
java.io.IOException

decodeDateTimeValue

DateTimeValue decodeDateTimeValue(DatetimeType type)
                                  throws java.io.IOException
Decode Date-Time as sequence of values representing the individual components of the Date-Time.

Throws:
java.io.IOException

EXIficient