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

Interface EncoderChannel

All Known Implementing Classes:

AbstractEncoderChannel, BitEncoderChannel, ByteEncoderChannel

public interface EncoderChannel

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
void	encode(byte[] b, int off, int len)
void	encode(int b)
void	encodeBinary(byte[] b) Encode a binary value as a length-prefixed sequence of octets.
void	encodeBoolean(boolean b) Encode a single boolean value.
void	encodeDateTime(DateTimeValue cal) The Date-Time datatype representation is a sequence of values representing the individual components of the Date-Time
void	encodeDecimal(boolean negative, IntegerValue integral, IntegerValue reverseFraction) Encode a decimal represented as a Boolean sign followed by two Unsigned Integers.
void	encodeFloat(FloatValue fv) Encode a Float represented as two consecutive Integers.
void	encodeInteger(int n) Encode an arbitrary precision integer using a sign bit followed by a sequence of octets.
void	encodeIntegerValue(IntegerValue iv)
void	encodeNBitUnsignedInteger(int b, int n)
void	encodeString(String s) Encode a string as a length-prefixed sequence of UCS codepoints, each of which is encoded as an integer.
void	encodeStringOnly(String s) Encode a string as a sequence of UCS codepoints, each of which is encoded as an integer.
void	encodeUnsignedInteger(int n) Encode an arbitrary precision non negative integer using a sequence of octets.
void	encodeUnsignedIntegerValue(IntegerValue iv)
void	flush()
int	getLength() Returns the number of bytes written.
OutputStream	getOutputStream()

Method Detail

getOutputStream

OutputStream getOutputStream()

flush

void flush()
    throws IOException

Throws:

IOException

getLength

int getLength()

Returns the number of bytes written.

Returns:

number of bytes

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

encode

void encode(int b)
     throws IOException

Throws:

IOException

encode

void encode(byte[] b,
            int off,
            int len)
     throws IOException

Throws:

IOException

encodeNBitUnsignedInteger

void encodeNBitUnsignedInteger(int b,
                               int n)
                        throws IOException

Throws:

IOException

encodeBoolean

void encodeBoolean(boolean b)
            throws IOException

Encode a single boolean value. A false value is encoded as bit (byte) 0 and true value is encode as bit (byte) 1.

Parameters:

b - boolean

Throws:

IOException - IO exception

encodeBinary

void encodeBinary(byte[] b)
           throws IOException

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

Parameters:

b - byte array

Throws:

IOException - IO exception

encodeString

void encodeString(String s)
           throws IOException

Encode 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.

Parameters:

s - string

Throws:

IOException - IO exception

encodeStringOnly

void encodeStringOnly(String s)
               throws IOException

Encode a string as a 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.

Parameters:

s - string

Throws:

IOException - IO exception

encodeUnsignedInteger

void encodeUnsignedInteger(int n)
                    throws IOException

Encode 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.

Parameters:

n - unsigned integer

Throws:

IOException - IO exception

encodeUnsignedIntegerValue

void encodeUnsignedIntegerValue(IntegerValue iv)
                         throws IOException

Throws:

IOException

encodeInteger

void encodeInteger(int n)
            throws IOException

Encode 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.

Parameters:

n - integer

Throws:

IOException - IO exception

encodeIntegerValue

void encodeIntegerValue(IntegerValue iv)
                 throws IOException

Throws:

IOException

encodeDecimal

void encodeDecimal(boolean negative,
                   IntegerValue integral,
                   IntegerValue reverseFraction)
            throws IOException

Encode 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.

Parameters:

negative - is negative

integral - integral value

reverseFraction - reverse fraction

Throws:

IOException - IO exception

encodeFloat

void encodeFloat(FloatValue fv)
          throws IOException

Encode 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

Parameters:

fv - float value

Throws:

IOException - IO exception

encodeDateTime

void encodeDateTime(DateTimeValue cal)
             throws IOException

The Date-Time datatype representation is a sequence of values representing the individual components of the Date-Time

Parameters:

cal - datetime

Throws:

IOException - IO exception