com.simiacryptus.util.binary

Class BitInputStream

java.lang.Object

com.simiacryptus.util.binary.BitInputStream

public class BitInputStream
extends Object

The type Bit input stream.

Constructor Summary

Constructors

Constructor and Description
BitInputStream(InputStream inner) Instantiates a new Bit input stream.

Method Summary

Modifier and Type	Method and Description
int	availible() Availible int.
void	close() Close.
void	expect(Bits bits) Expect.
<T extends Enum<T>> void	expect(Enum<T> expect) Expect.
Bits	peek(int bits) Peek bits.
int	peekIntCoord(int max) Peek int coord int.
long	peekLongCoord(long max) Peek long coord long.
Bits	read(int bits) Read bits.
Bits	readAhead() Read ahead bits.
Bits	readAhead(int bytes) Read ahead bits.
boolean	readBool() Read bool boolean.
long	readBoundedLong(long max) Reads a single positive bounded integral value (up to 64-bit, including 0, excluding max)
char	readChar() Read char char.
long	readVarLong() Read var long long.
short	readVarShort() Read var short short.
short	readVarShort(int optimal) Read var short short.
static BitInputStream	toBitStream(byte[] data) To bit stream bit input stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

BitInputStream

public BitInputStream(InputStream inner)

Instantiates a new Bit input stream.

Parameters:

inner - the inner

Method Detail

toBitStream

public static BitInputStream toBitStream(byte[] data)

To bit stream bit input stream.

Parameters:

data - the data

Returns:

the bit input stream

close

public void close()
           throws IOException

Close.

Throws:

IOException - the io exception

availible

public int availible()
              throws IOException

Availible int.

Returns:

the int

Throws:

IOException - the io exception

expect

public <T extends Enum<T>> void expect(Enum<T> expect)
                                throws IOException

Expect.

Type Parameters:

T - the type parameter

Parameters:

expect - the expect

Throws:

IOException - the io exception

expect

public void expect(Bits bits)
            throws IOException

Expect.

Parameters:

bits - the bits

Throws:

IOException - the io exception

read

public Bits read(int bits)
          throws IOException

Read bits.

Parameters:

bits - the bits

Returns:

the bits

Throws:

IOException - the io exception

peek

public Bits peek(int bits)
          throws IOException

Peek bits.

Parameters:

bits - the bits

Returns:

the bits

Throws:

IOException - the io exception

readAhead

public Bits readAhead()
               throws IOException

Read ahead bits.

Returns:

the bits

Throws:

IOException - the io exception

readAhead

public Bits readAhead(int bytes)
               throws IOException

Read ahead bits.

Parameters:

bytes - the bytes

Returns:

the bits

Throws:

IOException - the io exception

readBool

public boolean readBool()
                 throws IOException

Read bool boolean.

Returns:

the boolean

Throws:

IOException - the io exception

readBoundedLong

public long readBoundedLong(long max)
                     throws IOException

Reads a single positive bounded integral value (up to 64-bit, including 0, excluding max)

Parameters:

max - Maximum value (exclusive)

Returns:

A long within the range [0, max)

Throws:

IOException - the io exception

readVarLong

public long readVarLong()
                 throws IOException

Read var long long.

Returns:

the long

Throws:

IOException - the io exception

peekLongCoord

public long peekLongCoord(long max)
                   throws IOException

Peek long coord long.

Parameters:

max - the max

Returns:

the long

Throws:

IOException - the io exception

peekIntCoord

public int peekIntCoord(int max)
                 throws IOException

Peek int coord int.

Parameters:

max - the max

Returns:

the int

Throws:

IOException - the io exception

readVarShort

public short readVarShort()
                   throws IOException

Read var short short.

Returns:

the short

Throws:

IOException - the io exception

readVarShort

public short readVarShort(int optimal)
                   throws IOException

Read var short short.

Parameters:

optimal - the optimal

Returns:

the short

Throws:

IOException - the io exception

readChar

public char readChar()
              throws IOException

Read char char.

Returns:

the char

Throws:

IOException - the io exception