Top Description Fields Constructors Methods
com.jogamp.opengl.util.texture.spi

public Class LEDataInputStream

extends FilterInputStream
implements DataInput
Class Inheritance
All Implemented Interfaces
java.io.DataInput
Imports
java.io.DataInput, .DataInputStream, .FilterInputStream, .InputStream, .FileInputStream, .EOFException, .IOException
Little Endian Data Input Stream. This class implements an input stream filter to allow reading of java native datatypes from an input stream which has those native datatypes stored in a little endian byte order.

This is the sister class of the DataInputStream which allows for reading of java native datatypes from an input stream with the datatypes stored in big endian byte order.

This class implements the minimum required and calls DataInputStream for some of the required methods for DataInput.

Not all methods are implemented due to lack of immediatte requirement for that functionality. It is not clear if it is ever going to be functionally required to be able to read UTF data in a LittleEndianManner

Author
Robin Luiten
Version
1.1 15/Dec/1997

Field Summary

Modifier and TypeField and Description
pack-priv DataInputStream
dataIn

To reuse some of the non endian dependent methods from DataInputStreams methods.

Inherited from java.io.FilterInputStream:
in

Constructor Summary

AccessConstructor and Description
public
LEDataInputStream(final InputStream in)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Overrides java.io.FilterInputStream.close.

Implements java.io.Closeable.close.

Closes this input stream and releases any system resources associated with the stream.
public final synchronized int
read(final byte[]
the buffer into which the data is read.
b)

Overrides java.io.FilterInputStream.read.

Reads up to b.length bytes of data from this input stream into an array of bytes.
public final synchronized int
read(final byte[]
the buffer into which the data is read.
b, final int
the start offset in array b at which the data is written.
off, final int
the maximum number of bytes to read.
len)

Overrides java.io.FilterInputStream.read.

Reads up to len bytes of data from this input stream into an array of bytes.
public final boolean
readBoolean()

Implements java.io.DataInput.readBoolean.

Reads one input byte and returns true if that byte is nonzero, false if that byte is zero.
public final byte
readByte()

Implements java.io.DataInput.readByte.

Reads and returns one input byte.
public final char
readChar()

Implements java.io.DataInput.readChar.

Reads two input bytes and returns a char value.
public final double
readDouble()

Implements java.io.DataInput.readDouble.

Reads eight input bytes and returns a double value.
public final float
readFloat()

Implements java.io.DataInput.readFloat.

Reads four input bytes and returns a float value.
public final void
readFully(final byte[]
the buffer into which the data is read.
b)

Implements java.io.DataInput.readFully.

Reads some bytes from an input stream and stores them into the buffer array b.
public final void
readFully(final byte[]
the buffer into which the data is read.
b, final int
an int specifying the offset in the data array b.
off, final int
an int specifying the number of bytes to read.
len)

Implements java.io.DataInput.readFully.

Reads len bytes from an input stream.
public final int
readInt()

Implements java.io.DataInput.readInt.

Reads four input bytes and returns an int value.
public final String

Returns:

empty new string
readLine()

Implements java.io.DataInput.readLine.

dont call this it is not implemented.
public final long
readLong()

Implements java.io.DataInput.readLong.

Reads eight input bytes and returns a long value.
public final short
readShort()

Implements java.io.DataInput.readShort.

Reads two input bytes and returns a short value.
public final int
readUnsignedByte()

Implements java.io.DataInput.readUnsignedByte.

Reads one input byte, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255.
public final int
readUnsignedShort()

Implements java.io.DataInput.readUnsignedShort.

Reads two input bytes and returns an int value in the range 0 through 65535.
public final String

Returns:

empty new string
readUTF()

Implements java.io.DataInput.readUTF.

dont call this it is not implemented
public static final String

Returns:

empty new string
readUTF(final DataInput in)

dont call this it is not implemented

public final int
skipBytes(final int
the number of bytes to be skipped.
n)

Implements java.io.DataInput.skipBytes.

Makes an attempt to skip over n bytes of data from the input stream, discarding the skipped bytes.
Inherited from java.io.FilterInputStream:
availablemarkmarkSupportedreadresetskip

Field Detail

dataInback to summary
pack-priv DataInputStream dataIn

To reuse some of the non endian dependent methods from DataInputStreams methods.

Constructor Detail

LEDataInputStreamback to summary
public LEDataInputStream(final InputStream in)

Method Detail

closeback to summary
public void close() throws IOException

Overrides java.io.FilterInputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.FilterInputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readback to summary
public final synchronized int read(final byte[] b) throws IOException

Overrides java.io.FilterInputStream.read.

Doc from java.io.FilterInputStream.read.

Reads up to b.length bytes of data from this input stream into an array of bytes. This method blocks until some input is available.

Parameters
b:byte[]

the buffer into which the data is read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readback to summary
public final synchronized int read(final byte[] b, final int off, final int len) throws IOException

Overrides java.io.FilterInputStream.read.

Doc from java.io.FilterInputStream.read.

Reads up to len bytes of data from this input stream into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

Parameters
b:byte[]

the buffer into which the data is read.

off:int

the start offset in array b at which the data is written.

len:int

the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readBooleanback to summary
public final boolean readBoolean() throws IOException

Implements java.io.DataInput.readBoolean.

Doc from java.io.DataInput.readBoolean.

Reads one input byte and returns true if that byte is nonzero, false if that byte is zero. This method is suitable for reading the byte written by the writeBoolean method of interface DataOutput.

Returns:boolean

the boolean value read.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readByteback to summary
public final byte readByte() throws IOException

Implements java.io.DataInput.readByte.

Doc from java.io.DataInput.readByte.

Reads and returns one input byte. The byte is treated as a signed value in the range -128 through 127, inclusive. This method is suitable for reading the byte written by the writeByte method of interface DataOutput.

Returns:byte

the 8-bit value read.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readCharback to summary
public final char readChar() throws IOException

Implements java.io.DataInput.readChar.

Doc from java.io.DataInput.readChar.

Reads two input bytes and returns a char value. Let a be the first byte read and b be the second byte. The value returned is: 

(char)((a << 8) | (b & 0xff))
This method is suitable for reading bytes written by the writeChar method of interface DataOutput.
Returns:char

the char value read.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readDoubleback to summary
public final double readDouble() throws IOException

Implements java.io.DataInput.readDouble.

Doc from java.io.DataInput.readDouble.

Reads eight input bytes and returns a double value. It does this by first constructing a long value in exactly the manner of the readLong method, then converting this long value to a double in exactly the manner of the method Double.longBitsToDouble. This method is suitable for reading bytes written by the writeDouble method of interface DataOutput.

Returns:double

the double value read.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readFloatback to summary
public final float readFloat() throws IOException

Implements java.io.DataInput.readFloat.

Doc from java.io.DataInput.readFloat.

Reads four input bytes and returns a float value. It does this by first constructing an int value in exactly the manner of the readInt method, then converting this int value to a float in exactly the manner of the method Float.intBitsToFloat. This method is suitable for reading bytes written by the writeFloat method of interface DataOutput.

Returns:float

the float value read.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readFullyback to summary
public final void readFully(final byte[] b) throws IOException

Implements java.io.DataInput.readFully.

Doc from java.io.DataInput.readFully.

Reads some bytes from an input stream and stores them into the buffer array b. The number of bytes read is equal to the length of b.

This method blocks until one of the following conditions occurs:

  • b.length bytes of input data are available, in which case a normal return is made.
  • End of file is detected, in which case an EOFException is thrown.
  • An I/O error occurs, in which case an IOException other than EOFException is thrown.

If b is null, a NullPointerException is thrown. If b.length is zero, then no bytes are read. Otherwise, the first byte read is stored into element b[0], the next one into b[1], and so on. If an exception is thrown from this method, then it may be that some but not all bytes of b have been updated with data from the input stream.

Parameters
b:byte[]

the buffer into which the data is read.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readFullyback to summary
public final void readFully(final byte[] b, final int off, final int len) throws IOException

Implements java.io.DataInput.readFully.

Doc from java.io.DataInput.readFully.

Reads len bytes from an input stream.

This method blocks until one of the following conditions occurs:

  • len bytes of input data are available, in which case a normal return is made.
  • End of file is detected, in which case an EOFException is thrown.
  • An I/O error occurs, in which case an IOException other than EOFException is thrown.

If b is null, a NullPointerException is thrown. If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown. If len is zero, then no bytes are read. Otherwise, the first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len.

Parameters
b:byte[]

the buffer into which the data is read.

off:int

an int specifying the offset in the data array b.

len:int

an int specifying the number of bytes to read.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readIntback to summary
public final int readInt() throws IOException

Implements java.io.DataInput.readInt.

Doc from java.io.DataInput.readInt.

Reads four input bytes and returns an int value. Let a-d be the first through fourth bytes read. The value returned is: 

(((a & 0xff) << 24) | ((b & 0xff) << 16) |
 ((c & 0xff) <<  8) | (d & 0xff))
This method is suitable for reading bytes written by the writeInt method of interface DataOutput.
Returns:int

the int value read.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readLineback to summary
public final String readLine() throws IOException

Implements java.io.DataInput.readLine.

dont call this it is not implemented.

Returns:String

empty new string

Annotations
@Override
Exceptions
IOException:

Doc from java.io.DataInput.readLine.

if an I/O error occurs.

readLongback to summary
public final long readLong() throws IOException

Implements java.io.DataInput.readLong.

Doc from java.io.DataInput.readLong.

Reads eight input bytes and returns a long value. Let a-h be the first through eighth bytes read. The value returned is: 

(((long)(a & 0xff) << 56) |
 ((long)(b & 0xff) << 48) |
 ((long)(c & 0xff) << 40) |
 ((long)(d & 0xff) << 32) |
 ((long)(e & 0xff) << 24) |
 ((long)(f & 0xff) << 16) |
 ((long)(g & 0xff) <<  8) |
 ((long)(h & 0xff)))

This method is suitable for reading bytes written by the writeLong method of interface DataOutput.

Returns:long

the long value read.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readShortback to summary
public final short readShort() throws IOException

Implements java.io.DataInput.readShort.

Doc from java.io.DataInput.readShort.

Reads two input bytes and returns a short value. Let a be the first byte read and b be the second byte. The value returned is: 

(short)((a << 8) | (b & 0xff))
This method is suitable for reading the bytes written by the writeShort method of interface DataOutput.
Returns:short

the 16-bit value read.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readUnsignedByteback to summary
public final int readUnsignedByte() throws IOException

Implements java.io.DataInput.readUnsignedByte.

Doc from java.io.DataInput.readUnsignedByte.

Reads one input byte, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255. This method is suitable for reading the byte written by the writeByte method of interface DataOutput if the argument to writeByte was intended to be a value in the range 0 through 255.

Returns:int

the unsigned 8-bit value read.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readUnsignedShortback to summary
public final int readUnsignedShort() throws IOException

Implements java.io.DataInput.readUnsignedShort.

Doc from java.io.DataInput.readUnsignedShort.

Reads two input bytes and returns an int value in the range 0 through 65535. Let a be the first byte read and b be the second byte. The value returned is: 

(((a & 0xff) << 8) | (b & 0xff))
This method is suitable for reading the bytes written by the writeShort method of interface DataOutput if the argument to writeShort was intended to be a value in the range 0 through 65535.
Returns:int

the unsigned 16-bit value read.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readUTFback to summary
public final String readUTF() throws IOException

Implements java.io.DataInput.readUTF.

dont call this it is not implemented

Returns:String

empty new string

Annotations
@Override
Exceptions
IOException:

Doc from java.io.DataInput.readUTF.

if an I/O error occurs.

readUTFback to summary
public static final String readUTF(final DataInput in) throws IOException

dont call this it is not implemented

Returns:String

empty new string

skipBytesback to summary
public final int skipBytes(final int n) throws IOException

Implements java.io.DataInput.skipBytes.

Doc from java.io.DataInput.skipBytes.

Makes an attempt to skip over n bytes of data from the input stream, discarding the skipped bytes. However, it may skip over some smaller number of bytes, possibly zero. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. This method never throws an EOFException. The actual number of bytes skipped is returned.

Parameters
n:int

the number of bytes to be skipped.

Returns:int

the number of bytes actually skipped.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.