org.pdfclown.bytes
Interface IInputStream

All Superinterfaces:

Closeable, IDataWrapper, IStream

All Known Subinterfaces:

IBuffer

All Known Implementing Classes:

Buffer, FileInputStream

public interface IInputStream
extends IStream, IDataWrapper

Input stream.

Its pivotal concept is the access pointer.

Version:

0.1.0

Author:

Stefano Chizzolini (http://www.stefanochizzolini.it)

Method Summary

ByteOrder	getByteOrder() Gets the byte order.
long	getPosition() Gets the pointer position.
int	hashCode() Gets the hash representation of the sequence.
void	read(byte[] data) Reads a sequence of bytes.
void	read(byte[] data, int offset, int length) Reads a sequence of bytes.
byte	readByte() Reads a byte.
int	readInt() Reads an integer.
int	readInt(int length) Reads a variable-length integer.
String	readLine() Reads the next line of text.
short	readShort() Reads a short integer.
String	readString(int length) Reads a string.
int	readUnsignedByte() Reads an unsigned byte integer.
int	readUnsignedShort() Reads an unsigned short integer.
void	seek(long position) Sets the pointer absolute position.
void	setByteOrder(ByteOrder value) Sets the byte order.
void	setPosition(long value) Sets the pointer position.
void	skip(long offset) Sets the pointer relative position.

Methods inherited from interface org.pdfclown.bytes.IStream

getLength

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.pdfclown.util.IDataWrapper

toByteArray

Method Detail

getByteOrder

ByteOrder getByteOrder()

Gets the byte order.

getPosition

long getPosition()

Gets the pointer position.

hashCode

int hashCode()

Gets the hash representation of the sequence.

Overrides:

hashCode in class Object

read

void read(byte[] data)
          throws EOFException

Reads a sequence of bytes.

This operation causes the stream pointer to advance after the read data.

Parameters:

data - Target byte array.

Throws:

EOFException

read

void read(byte[] data,
          int offset,
          int length)
          throws EOFException

Reads a sequence of bytes.

This operation causes the stream pointer to advance after the read data.

Parameters:

data - Target byte array.

offset - Location in the byte array at which storing begins.

length - Number of bytes to read.

Throws:

EOFException

readByte

byte readByte()
              throws EOFException

Reads a byte.

This operation causes the stream pointer to advance after the read data.

Throws:

EOFException

readInt

int readInt()
            throws EOFException

Reads an integer.

This operation causes the stream pointer to advance after the read data.

Throws:

EOFException

readInt

int readInt(int length)
            throws EOFException

Reads a variable-length integer.

This operation causes the stream pointer to advance after the read data.

Parameters:

length - Number of bytes to read.

Throws:

EOFException

readLine

String readLine()
                throws EOFException

Reads the next line of text.

This operation causes the stream pointer to advance after the read data.

Throws:

EOFException

readShort

short readShort()
                throws EOFException

Reads a short integer.

This operation causes the stream pointer to advance after the read data.

Throws:

EOFException

readString

String readString(int length)
                  throws EOFException

Reads a string.

This operation causes the stream pointer to advance after the read data.

Parameters:

length - Number of bytes to read.

Throws:

EOFException

readUnsignedByte

int readUnsignedByte()
                     throws EOFException

Reads an unsigned byte integer.

This operation causes the stream pointer to advance after the read data.

Throws:

EOFException

readUnsignedShort

int readUnsignedShort()
                      throws EOFException

Reads an unsigned short integer.

This operation causes the stream pointer to advance after the read data.

Throws:

EOFException

seek

void seek(long position)

Sets the pointer absolute position.

setByteOrder

void setByteOrder(ByteOrder value)

Sets the byte order.

setPosition

void setPosition(long value)

Sets the pointer position.

skip

void skip(long offset)

Sets the pointer relative position.