Package com.ardor3d.util

Class LittleEndianRandomAccessDataInput

java.lang.Object

com.ardor3d.util.LittleEndianRandomAccessDataInput

All Implemented Interfaces:

DataInput

public class LittleEndianRandomAccessDataInput
extends Object
implements DataInput

Utility class useful for reading little-endian stored data in a random access fashion. All functions work as defined in DataInput, but assume they come from a LittleEndian input stream.

Note: random access is implemented by reading the entire stream into memory.

Field Summary

Fields

Modifier and Type	Field	Description
int	CHAR_SIZE	Number of bytes to read when reading a char...

Constructor Summary

Constructors

Constructor	Description
LittleEndianRandomAccessDataInput(InputStream in)	Creates a new LittleEndian reader from the given input stream.
LittleEndianRandomAccessDataInput(ByteBuffer contents)	Creates a new LittleEndian reader from the given byte buffer.

Method Summary

Modifier and Type	Method	Description
int	capacity()
final LittleEndianRandomAccessDataInput	mark()	Sets a mark at the current position in the underlying buffer.
int	position()
final boolean	readBoolean()
final byte	readByte()
final char	readChar()
final double	readDouble()
final float	readFloat()
final void	readFully(byte[] b)
final void	readFully(byte[] b, int off, int len)
final int	readInt()
final String	readLine()	Unsupported.
final long	readLong()
final short	readShort()
String	readString(int size)	Reads a specified number of bytes to form a string.
String	readString(int size, Charset charset)	Reads a specified number of bytes to form a string.
final int	readUnsignedByte()
final long	readUnsignedInt()
final int	readUnsignedShort()
final String	readUTF()	Unsupported.
final LittleEndianRandomAccessDataInput	reset()	Seeks to the position of the last mark.
final void	seek(int pos)
final int	skipBytes(int n)

Methods inherited from class java.lang.Object

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

Field Details

CHAR_SIZE

public int CHAR_SIZE

Number of bytes to read when reading a char... For data meant to be read from C/C++ this is often 1, for Java and C# this is usually 2.

Constructor Details

LittleEndianRandomAccessDataInput

public LittleEndianRandomAccessDataInput(InputStream in)
                                  throws IOException

Creates a new LittleEndian reader from the given input stream. Note that this stream is loaded completely into memory.

Parameters:

in - The stream to read from.

Throws:

IOException - if something wrong occurs while reading

LittleEndianRandomAccessDataInput

public LittleEndianRandomAccessDataInput(ByteBuffer contents)
                                  throws IOException

Creates a new LittleEndian reader from the given byte buffer. Note that this byte buffer is not cloned or copied, so take care not to alter it during read. This constructor is useful for working with memory-mapped files.

Parameters:

contents - The contents to read from.

Throws:

IOException - if something wrong occurs while reading

Method Details

readUnsignedShort

public final int readUnsignedShort()
                            throws IOException

Specified by:

readUnsignedShort in interface DataInput

Throws:

IOException

readUnsignedInt

public final long readUnsignedInt()
                           throws IOException

Throws:

IOException

readBoolean

public final boolean readBoolean()
                          throws IOException

Specified by:

readBoolean in interface DataInput

Throws:

IOException

readByte

public final byte readByte()
                    throws IOException

Specified by:

readByte in interface DataInput

Throws:

IOException

readUnsignedByte

public final int readUnsignedByte()
                           throws IOException

Specified by:

readUnsignedByte in interface DataInput

Throws:

IOException

readShort

public final short readShort()
                      throws IOException

Specified by:

readShort in interface DataInput

Throws:

IOException

readChar

public final char readChar()
                    throws IOException

Specified by:

readChar in interface DataInput

Throws:

IOException

readInt

public final int readInt()
                  throws IOException

Specified by:

readInt in interface DataInput

Throws:

IOException

readLong

public final long readLong()
                    throws IOException

Specified by:

readLong in interface DataInput

Throws:

IOException

readFloat

public final float readFloat()
                      throws IOException

Specified by:

readFloat in interface DataInput

Throws:

IOException

readDouble

public final double readDouble()
                        throws IOException

Specified by:

readDouble in interface DataInput

Throws:

IOException

readFully

public final void readFully(byte[] b)
                     throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

readFully

public final void readFully(byte[] b,
 int off,
 int len)
                     throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

skipBytes

public final int skipBytes(int n)
                    throws IOException

Specified by:

skipBytes in interface DataInput

Throws:

IOException

mark

public final LittleEndianRandomAccessDataInput mark()

Sets a mark at the current position in the underlying buffer. This position can be returned to by calling reset.

Returns:

this object

reset

public final LittleEndianRandomAccessDataInput reset()

Seeks to the position of the last mark. The mark is not changed or discarded.

Returns:

this object

Throws:

InvalidMarkException - if mark was not previously called.

readLine

public final String readLine()
                      throws IOException

Unsupported.

Specified by:

readLine in interface DataInput

Throws:

IOException - if this method is called.

readUTF

public final String readUTF()
                     throws IOException

Unsupported.

Specified by:

readUTF in interface DataInput

Throws:

IOException - if this method is called.

readString

public String readString(int size,
 Charset charset)
                  throws IOException

Reads a specified number of bytes to form a string. The length of the string (number of characters) is required to notify when reading should stop. The index is increased the number of characters read.

Parameters:

size - the length of the string to read.

charset - the charset used to convert the bytes to a string.

Returns:

the string read.

Throws:

IOException - if EOS/EOF is reached before "size" number of bytes are read.

readString

public String readString(int size)
                  throws IOException

Reads a specified number of bytes to form a string. The length of the string (number of characters) is required to notify when reading should stop. The index is increased the number of characters read. Will use the platform's default Charset to convert the bytes to string.

Parameters:

size - the length of the string to read.

Returns:

the string read.

Throws:

IOException - if EOS/EOF is reached before "size" number of bytes are read.

seek

public final void seek(int pos)
                throws IOException

Throws:

IOException

position

public int position()

capacity

public int capacity()