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

public Class LEDataOutputStream

extends FilterOutputStream
implements DataOutput
Class Inheritance
All Implemented Interfaces
java.io.DataOutput
Imports
java.io.DataOutput, .DataOutputStream, .FilterOutputStream, .OutputStream, .IOException
Little Endian Data Output Stream. This class implements an output stream filter to allow writing of java native datatypes to an output stream which has those native datatypes stored in a little endian byte order.

This is the sister class of the DataOutputStream which allows for writing of java native datatypes to an output stream with the datatypes stored in big endian byte order.

This class implements the minimum required and calls DataOutputStream for some of the required methods for DataOutput.

Not all methods are implemented due to lack of immediate 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

Field Summary

Modifier and TypeField and Description
pack-priv DataOutputStream
dataOut

To reuse some of the non endian dependent methods from DataOutputStream's methods.

Inherited from java.io.FilterOutputStream:
out

Constructor Summary

AccessConstructor and Description
public
LEDataOutputStream(final OutputStream out)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Overrides java.io.FilterOutputStream.close.

Implements java.io.Closeable.close.

Closes this output stream and releases any system resources associated with the stream.
public final synchronized void
write(final byte[]
the data.
b)

Overrides java.io.FilterOutputStream.write.

Implements java.io.DataOutput.write.

Writes to the output stream all the bytes in array b.
public final synchronized void
write(final byte[]
the data.
b, final int
the start offset in the data.
off, final int
the number of bytes to write.
len)

Overrides java.io.FilterOutputStream.write.

Implements java.io.DataOutput.write.

Writes len bytes from array b, in order, to the output stream.
public final void
write(final int
the byte to be written.
b)

Overrides java.io.FilterOutputStream.write.

Implements java.io.DataOutput.write.

Writes to the output stream the eight low-order bits of the argument b.
public final void
writeBoolean(final boolean
the boolean to be written.
v)

Implements java.io.DataOutput.writeBoolean.

Writes a boolean value to this output stream.
public final void
writeByte(final int
the byte value to be written.
v)

Implements java.io.DataOutput.writeByte.

Writes to the output stream the eight low-order bits of the argument v.
public final void
writeBytes(final String
the string of bytes to be written.
s)

Implements java.io.DataOutput.writeBytes.

Don't call this -- not implemented
public final void
writeChar(final int
the char value to be written.
v)

Implements java.io.DataOutput.writeChar.

Writes a char value, which is comprised of two bytes, to the output stream.
public final void
writeChars(final String
the string value to be written.
s)

Implements java.io.DataOutput.writeChars.

Don't call this -- not implemented
public final void
writeDouble(final double
the double value to be written.
v)

Implements java.io.DataOutput.writeDouble.

Writes a double value, which is comprised of eight bytes, to the output stream.
public final void
writeFloat(final float
the float value to be written.
v)

Implements java.io.DataOutput.writeFloat.

Writes a float value, which is comprised of four bytes, to the output stream.
public final void
writeInt(final int
the int value to be written.
v)

Implements java.io.DataOutput.writeInt.

Writes an int value, which is comprised of four bytes, to the output stream.
public final void
writeLong(final long
the long value to be written.
v)

Implements java.io.DataOutput.writeLong.

Writes a long value, which is comprised of eight bytes, to the output stream.
public final void
writeShort(final int
the short value to be written.
v)

Implements java.io.DataOutput.writeShort.

Writes two bytes to the output stream to represent the value of the argument.
public final void
writeUTF(final String
the string value to be written.
s)

Implements java.io.DataOutput.writeUTF.

Don't call this -- not implemented
Inherited from java.io.FilterOutputStream:
flush

Field Detail

dataOutback to summary
pack-priv DataOutputStream dataOut

To reuse some of the non endian dependent methods from DataOutputStream's methods.

Constructor Detail

LEDataOutputStreamback to summary
public LEDataOutputStream(final OutputStream out)

Method Detail

closeback to summary
public void close() throws IOException

Overrides java.io.FilterOutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.FilterOutputStream.close.

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

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

Overrides java.io.FilterOutputStream.write.

Implements java.io.DataOutput.write.

Doc from java.io.DataOutput.write.

Writes to the output stream all the bytes in array b. If b is null, a NullPointerException is thrown. If b.length is zero, then no bytes are written. Otherwise, the byte b[0] is written first, then b[1], and so on; the last byte written is b[b.length-1].

Parameters
b:byte[]

the data.

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

Overrides java.io.FilterOutputStream.write.

Implements java.io.DataOutput.write.

Doc from java.io.DataOutput.write.

Writes len bytes from array b, in order, to the output stream. 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 written. Otherwise, the byte b[off] is written first, then b[off+1], and so on; the last byte written is b[off+len-1].

Parameters
b:byte[]

the data.

off:int

the start offset in the data.

len:int

the number of bytes to write.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeback to summary
public final void write(final int b) throws IOException

Overrides java.io.FilterOutputStream.write.

Implements java.io.DataOutput.write.

Doc from java.io.DataOutput.write.

Writes to the output stream the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters
b:int

the byte to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeBooleanback to summary
public final void writeBoolean(final boolean v) throws IOException

Implements java.io.DataOutput.writeBoolean.

Doc from java.io.DataOutput.writeBoolean.

Writes a boolean value to this output stream. If the argument v is true, the value (byte)1 is written; if v is false, the value (byte)0 is written. The byte written by this method may be read by the readBoolean method of interface DataInput, which will then return a boolean equal to v.

Parameters
v:boolean

the boolean to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeByteback to summary
public final void writeByte(final int v) throws IOException

Implements java.io.DataOutput.writeByte.

Doc from java.io.DataOutput.writeByte.

Writes to the output stream the eight low-order bits of the argument v. The 24 high-order bits of v are ignored. (This means that writeByte does exactly the same thing as write for an integer argument.) The byte written by this method may be read by the readByte method of interface DataInput, which will then return a byte equal to (byte)v.

Parameters
v:int

the byte value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeBytesback to summary
public final void writeBytes(final String s) throws IOException

Implements java.io.DataOutput.writeBytes.

Don't call this -- not implemented

Parameters
s:String

Doc from java.io.DataOutput.writeBytes.

the string of bytes to be written.

Annotations
@Override
Exceptions
IOException:

Doc from java.io.DataOutput.writeBytes.

if an I/O error occurs.

writeCharback to summary
public final void writeChar(final int v) throws IOException

Implements java.io.DataOutput.writeChar.

Doc from java.io.DataOutput.writeChar.

Writes a char value, which is comprised of two bytes, to the output stream. The byte values to be written, in the order shown, are: 

(byte)(0xff & (v >> 8))
(byte)(0xff & v)

The bytes written by this method may be read by the readChar method of interface DataInput, which will then return a char equal to (char)v.

Parameters
v:int

the char value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeCharsback to summary
public final void writeChars(final String s) throws IOException

Implements java.io.DataOutput.writeChars.

Don't call this -- not implemented

Parameters
s:String

Doc from java.io.DataOutput.writeChars.

the string value to be written.

Annotations
@Override
Exceptions
IOException:

Doc from java.io.DataOutput.writeChars.

if an I/O error occurs.

writeDoubleback to summary
public final void writeDouble(final double v) throws IOException

Implements java.io.DataOutput.writeDouble.

Doc from java.io.DataOutput.writeDouble.

Writes a double value, which is comprised of eight bytes, to the output stream. It does this as if it first converts this double value to a long in exactly the manner of the Double.doubleToLongBits method and then writes the long value in exactly the manner of the writeLong method. The bytes written by this method may be read by the readDouble method of interface DataInput, which will then return a double equal to v.

Parameters
v:double

the double value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeFloatback to summary
public final void writeFloat(final float v) throws IOException

Implements java.io.DataOutput.writeFloat.

Doc from java.io.DataOutput.writeFloat.

Writes a float value, which is comprised of four bytes, to the output stream. It does this as if it first converts this float value to an int in exactly the manner of the Float.floatToIntBits method and then writes the int value in exactly the manner of the writeInt method. The bytes written by this method may be read by the readFloat method of interface DataInput, which will then return a float equal to v.

Parameters
v:float

the float value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeIntback to summary
public final void writeInt(final int v) throws IOException

Implements java.io.DataOutput.writeInt.

Doc from java.io.DataOutput.writeInt.

Writes an int value, which is comprised of four bytes, to the output stream. The byte values to be written, in the order shown, are: 

(byte)(0xff & (v >> 24))
(byte)(0xff & (v >> 16))
(byte)(0xff & (v >>  8))
(byte)(0xff & v)

The bytes written by this method may be read by the readInt method of interface DataInput, which will then return an int equal to v.

Parameters
v:int

the int value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeLongback to summary
public final void writeLong(final long v) throws IOException

Implements java.io.DataOutput.writeLong.

Doc from java.io.DataOutput.writeLong.

Writes a long value, which is comprised of eight bytes, to the output stream. The byte values to be written, in the order shown, are: 

(byte)(0xff & (v >> 56))
(byte)(0xff & (v >> 48))
(byte)(0xff & (v >> 40))
(byte)(0xff & (v >> 32))
(byte)(0xff & (v >> 24))
(byte)(0xff & (v >> 16))
(byte)(0xff & (v >>  8))
(byte)(0xff & v)

The bytes written by this method may be read by the readLong method of interface DataInput, which will then return a long equal to v.

Parameters
v:long

the long value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeShortback to summary
public final void writeShort(final int v) throws IOException

Implements java.io.DataOutput.writeShort.

Doc from java.io.DataOutput.writeShort.

Writes two bytes to the output stream to represent the value of the argument. The byte values to be written, in the order shown, are: 

(byte)(0xff & (v >> 8))
(byte)(0xff & v)

The bytes written by this method may be read by the readShort method of interface DataInput, which will then return a short equal to (short)v.

Parameters
v:int

the short value to be written.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
writeUTFback to summary
public final void writeUTF(final String s) throws IOException

Implements java.io.DataOutput.writeUTF.

Don't call this -- not implemented

Parameters
s:String

Doc from java.io.DataOutput.writeUTF.

the string value to be written.

Annotations
@Override
Exceptions
IOException:

Doc from java.io.DataOutput.writeUTF.

if an I/O error occurs.