ilog.views.maps.format

Class IlvMapInput

java.lang.Object

ilog.views.maps.format.IlvMapInput

public final class IlvMapInput
extends Object

This class defines an input stream with extended reading capabilities.

Since:

Perforce JViews 3.0

Constructor Summary

Constructors

Constructor and Description
IlvMapInput(DataInput input) Initializes an instance of IlvMapInput.

Method Summary

Modifier and Type	Method and Description
long	getIndex() Returns the current index in the stream.
DataInput	getInput() Returns the input data.
void	read(byte[] data, int off, int length) Reads up to length bytes of data from the specified file and stores it in a byte array.
double	readBigDouble() Reads a 64-bit IIIE double coded in big endian format.
int	readBigInt() Reads a 32-bit integer coded in big endian format.
short	readBigShort() Reads a 16-bit integer coded in big endian format.
long	readBigUnsignedInt() Reads a 32-bit unsigned integer coded in big endian format.
int	readBigUnsignedShort() Reads a 16-bit unsigned integer coded in big endian format.
byte	readByte() Reads and returns one input byte.
double	readLittleDouble() Reads a 64-bit IIIE double coded in little endian format.
int	readLittleInt() Reads a 32-bit integer coded in little endian format.
short	readLittleShort() Reads a 16-bit integer coded in little endian format.
int	readUnsignedByte() Reads an unsigned byte.
void	setLocation(long loc) Sets the location where the next read operation will occur to the specified index.
int	skipBytes(int n) Skips exactly n bytes of input.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvMapInput

public IlvMapInput(DataInput input)

Initializes an instance of IlvMapInput.

Parameters:

input - The input data.

Method Detail

getInput

public DataInput getInput()

Returns the input data.

readUnsignedByte

public int readUnsignedByte()
                     throws IOException

Reads an unsigned byte.

Throws:

IOException

readLittleDouble

public double readLittleDouble()
                        throws IOException

Reads a 64-bit IIIE double coded in little endian format.

Throws:

IOException - If an exception occurs while reading the data.

readBigDouble

public double readBigDouble()
                     throws IOException

Reads a 64-bit IIIE double coded in big endian format.

Throws:

IOException - If an exception occurs while reading the data.

readLittleInt

public int readLittleInt()
                  throws IOException

Reads a 32-bit integer coded in little endian format.

Throws:

IOException - If an exception occurs while reading the data.

readBigInt

public int readBigInt()
               throws IOException

Reads a 32-bit integer coded in big endian format.

Throws:

IOException - If an exception occurs while reading the data.

readBigUnsignedInt

public long readBigUnsignedInt()
                        throws IOException

Reads a 32-bit unsigned integer coded in big endian format.

Throws:

IOException - If an exception occurs while reading the data.

readLittleShort

public short readLittleShort()
                      throws IOException

Reads a 16-bit integer coded in little endian format.

Throws:

IOException - If an exception occurs while reading the data.

readBigShort

public short readBigShort()
                   throws IOException

Reads a 16-bit integer coded in big endian format.

Throws:

IOException - If an exception occurs while reading the data.

readBigUnsignedShort

public int readBigUnsignedShort()
                         throws IOException

Reads a 16-bit unsigned integer coded in big endian format.

Throws:

IOException - If an exception occurs while reading the data.

skipBytes

public int skipBytes(int n)
              throws IOException

Skips exactly n bytes of input.

Parameters:

n - The number of bytes to be skipped.

Returns:

The number of bytes skipped, which is always n.

Throws:

IOException - If the end of this stream is reached before all the bytes have been skipped or if the argument is negative and the backward seeking is not supported.

setLocation

public void setLocation(long loc)
                 throws IOException

Sets the location where the next read operation will occur to the specified index.

Parameters:

loc - The index where the next read operation will occur.

Throws:

IOException - If an errors occurs while setting location.

See Also:

getIndex()

getIndex

public long getIndex()

Returns the current index in the stream.

read

public void read(byte[] data,
                 int off,
                 int length)
          throws IOException

Reads up to length bytes of data from the specified file and stores it in a byte array.

Throws:

IOException - If an exception occurs while reading the data.

readByte

public byte readByte()
              throws IOException

Reads and returns one input byte.

Throws:

IOException - If an exception occurs while reading the data.