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

Class BitDecoderChannel

java.lang.Object

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

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

All Implemented Interfaces:

DecoderChannel

public class BitDecoderChannel
extends AbstractDecoderChannel
implements DecoderChannel

Simple datatype decoder based on an underlying BitInputStream. Reading a single bit from the underlying stream involves several VM operations. Thus, whenever possible, whole bytes should be read instead.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected BitInputStream	istream Underlying bit input stream from which bits and bytes are read.

Fields inherited from class com.siemens.ct.exi.core.io.channel.AbstractDecoderChannel

sbHelper

Constructor Summary

Constructors

Constructor and Description
BitDecoderChannel(InputStream is) Construct a decoder from input stream

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.
int	decodeNBitUnsignedInteger(int n) Decodes and returns an n-bit unsigned integer.
int	lookAhead()
void	skip(long n) Skips over and discards n bytes of data from this channel.

Methods inherited from class com.siemens.ct.exi.core.io.channel.AbstractDecoderChannel

decodeBooleanValue, decodeDateTimeValue, decodeDecimalValue, decodeFloatValue, decodeInteger, decodeIntegerValue, decodeLong, decodeNBitUnsignedIntegerValue, decodeString, decodeStringOnly, decodeUnsignedInteger, decodeUnsignedIntegerValue, decodeUnsignedIntegerValue, decodeUnsignedLong

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.siemens.ct.exi.core.io.channel.DecoderChannel

decodeBooleanValue, decodeDateTimeValue, decodeDecimalValue, decodeFloatValue, decodeIntegerValue, decodeNBitUnsignedIntegerValue, decodeString, decodeStringOnly, decodeUnsignedInteger, decodeUnsignedIntegerValue

Field Detail

istream

protected BitInputStream istream

Underlying bit input stream from which bits and bytes are read.

Constructor Detail

BitDecoderChannel

public BitDecoderChannel(InputStream is)

Construct a decoder from input stream

Parameters:

is - input stream

Method Detail

decode

public final int decode()
                 throws IOException

Description copied from interface: DecoderChannel

Decodes a single byte

Specified by:

decode in interface DecoderChannel

Returns:

a byte as int

Throws:

IOException - IO exception

align

public void align()
           throws IOException

Description copied from interface: DecoderChannel

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

Specified by:

align in interface DecoderChannel

Throws:

IOException - IO exception

lookAhead

public int lookAhead()
              throws IOException

Throws:

IOException

skip

public void skip(long n)
          throws IOException

Description copied from interface: DecoderChannel

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

Specified by:

skip in interface DecoderChannel

Parameters:

n - number of bytes to skip

Throws:

IOException - IO exception

decodeNBitUnsignedInteger

public final int decodeNBitUnsignedInteger(int n)
                                    throws IOException

Decodes and returns an n-bit unsigned integer.

Specified by:

decodeNBitUnsignedInteger in interface DecoderChannel

Parameters:

n - number of bits

Returns:

nbit value

Throws:

IOException - IO exception

decodeBoolean

public boolean decodeBoolean()
                      throws IOException

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

Specified by:

decodeBoolean in interface DecoderChannel

Returns:

boolean value

Throws:

IOException - IO exception

decodeBinary

public byte[] decodeBinary()
                    throws IOException

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

Specified by:

decodeBinary in interface DecoderChannel

Returns:

binary data

Throws:

IOException - IO exception