commons-io 1.3.2 · org.apache.commons.io.input.SwappedDataInputStream

Access	Constructor and Description
public	SwappedDataInputStream(InputStream InputStream to read from input) Constructs a SwappedDataInputStream.

Method Summary

Modifier and Type	Method and Description
public 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 byte	readByte() Implements java.io.DataInput.readByte. Reads and returns one input byte.
public char	readChar() Implements java.io.DataInput.readChar. Reads two input bytes and returns a `char` value.
public double	readDouble() Implements java.io.DataInput.readDouble. Reads eight input bytes and returns a `double` value.
public float	readFloat() Implements java.io.DataInput.readFloat. Reads four input bytes and returns a `float` value.
public void	readFully(byte[] the buffer into which the data is read. data) Implements java.io.DataInput.readFully. Reads some bytes from an input stream and stores them into the buffer array `b`.
public void	readFully(byte[] the buffer into which the data is read. data, int an int specifying the offset in the data array `b`. offset, int an int specifying the number of bytes to read. length) Implements java.io.DataInput.readFully. Reads `len` bytes from an input stream.
public int	readInt() Implements java.io.DataInput.readInt. Reads four input bytes and returns an `int` value.
public String	readLine() Implements java.io.DataInput.readLine. Not currently supported.
public long	readLong() Implements java.io.DataInput.readLong. Reads eight input bytes and returns a `long` value.
public short	readShort() Implements java.io.DataInput.readShort. Reads two input bytes and returns a `short` value.
public 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 int	readUnsignedShort() Implements java.io.DataInput.readUnsignedShort. Reads two input bytes and returns an `int` value in the range `0` through `65535`.
public String	readUTF() Implements java.io.DataInput.readUTF. Not currently supported.
public int	skipBytes(int the number of bytes to be skipped. count) 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 org.apache.commons.io.input.ProxyInputStream:: available close mark markSupported read read read reset skip

SwappedDataInputStream	back to summary
public SwappedDataInputStream(InputStream input) Constructs a SwappedDataInputStream. Parameters input:InputStream InputStream to read from

Method Detail

readBoolean back to summary

readBoolean	back to summary
public boolean readBoolean() throws IOException, EOFException 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. Exceptions IOException: if an I/O error occurs. EOFException: if this stream reaches the end before reading all the bytes. See Also `java.io.DataInput#readBoolean()`

public boolean readBoolean() throws IOException, EOFException

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.

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if this stream reaches the end before reading all the bytes.

See Also

java.io.DataInput#readBoolean()

readByte back to summary

readByte	back to summary
public byte readByte() throws IOException, EOFException 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. Exceptions IOException: if an I/O error occurs. EOFException: if this stream reaches the end before reading all the bytes. See Also `java.io.DataInput#readByte()`

public byte readByte() throws IOException, EOFException

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.

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if this stream reaches the end before reading all the bytes.

See Also

java.io.DataInput#readByte()

readChar back to summary

readChar	back to summary
public char readChar() throws IOException, EOFException 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. Exceptions IOException: if an I/O error occurs. EOFException: if this stream reaches the end before reading all the bytes. See Also `java.io.DataInput#readChar()`

public char readChar() throws IOException, EOFException

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.

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if this stream reaches the end before reading all the bytes.

See Also

java.io.DataInput#readChar()

readDouble back to summary

readDouble	back to summary
public double readDouble() throws IOException, EOFException 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. Exceptions IOException: if an I/O error occurs. EOFException: if this stream reaches the end before reading all the bytes. See Also `java.io.DataInput#readDouble()`

public double readDouble() throws IOException, EOFException

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.

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if this stream reaches the end before reading all the bytes.

See Also

java.io.DataInput#readDouble()

readFloat back to summary

readFloat	back to summary
public float readFloat() throws IOException, EOFException 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. Exceptions IOException: if an I/O error occurs. EOFException: if this stream reaches the end before reading all the bytes. See Also `java.io.DataInput#readFloat()`

public float readFloat() throws IOException, EOFException

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.

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if this stream reaches the end before reading all the bytes.

See Also

java.io.DataInput#readFloat()

readFully back to summary

readFully	back to summary
public void readFully(byte[] data) throws IOException, EOFException 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 data:byte[] the buffer into which the data is read. Exceptions IOException: if an I/O error occurs. EOFException: if this stream reaches the end before reading all the bytes. See Also `java.io.DataInput#readFully(byte[])`

public void readFully(byte[] data) throws IOException, EOFException

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

data:byte[]: the buffer into which the data is read.

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if this stream reaches the end before reading all the bytes.

See Also

java.io.DataInput#readFully(byte[])

readFully back to summary

readFully	back to summary
public void readFully(byte[] data, int offset, int length) throws IOException, EOFException 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 data:byte[] the buffer into which the data is read. offset:int an int specifying the offset in the data array `b`. length:int an int specifying the number of bytes to read. Exceptions IOException: if an I/O error occurs. EOFException: if this stream reaches the end before reading all the bytes. See Also `java.io.DataInput#readFully(byte[], int, int)`

public void readFully(byte[] data, int offset, int length) throws IOException, EOFException

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

data:byte[]: the buffer into which the data is read.
offset:int: an int specifying the offset in the data array b.
length:int: an int specifying the number of bytes to read.

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if this stream reaches the end before reading all the bytes.

readInt back to summary

readInt	back to summary
public int readInt() throws IOException, EOFException 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. Exceptions IOException: if an I/O error occurs. EOFException: if this stream reaches the end before reading all the bytes. See Also `java.io.DataInput#readInt()`

public int readInt() throws IOException, EOFException

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.

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if this stream reaches the end before reading all the bytes.

See Also

java.io.DataInput#readInt()

readLine back to summary

readLine	back to summary
public String readLine() throws IOException, EOFException Implements java.io.DataInput.readLine. Not currently supported. Returns:String Doc from java.io.DataInput.readLine. the next line of text from the input stream, or `null` if the end of file is encountered before a byte can be read. Exceptions IOException: Doc from java.io.DataInput.readLine. if an I/O error occurs. See Also `java.io.DataInput#readLine()`

public String readLine() throws IOException, EOFException

Implements java.io.DataInput.readLine.

Not currently supported.

Returns:String

Doc from java.io.DataInput.readLine.

the next line of text from the input stream, or null if the end of file is encountered before a byte can be read.

Exceptions

IOException:

Doc from java.io.DataInput.readLine.

if an I/O error occurs.

See Also

java.io.DataInput#readLine()

readLong back to summary

readLong	back to summary
public long readLong() throws IOException, EOFException 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. Exceptions IOException: if an I/O error occurs. EOFException: if this stream reaches the end before reading all the bytes. See Also `java.io.DataInput#readLong()`

public long readLong() throws IOException, EOFException

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.

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if this stream reaches the end before reading all the bytes.

See Also

java.io.DataInput#readLong()

readShort back to summary

readShort	back to summary
public short readShort() throws IOException, EOFException 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. Exceptions IOException: if an I/O error occurs. EOFException: if this stream reaches the end before reading all the bytes. See Also `java.io.DataInput#readShort()`

public short readShort() throws IOException, EOFException

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.

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if this stream reaches the end before reading all the bytes.

See Also

java.io.DataInput#readShort()

readUnsignedByte back to summary

readUnsignedByte	back to summary
public int readUnsignedByte() throws IOException, EOFException 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. Exceptions IOException: if an I/O error occurs. EOFException: if this stream reaches the end before reading all the bytes. See Also `java.io.DataInput#readUnsignedByte()`

public int readUnsignedByte() throws IOException, EOFException

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.

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if this stream reaches the end before reading all the bytes.

See Also

java.io.DataInput#readUnsignedByte()

readUnsignedShort back to summary

readUnsignedShort	back to summary
public int readUnsignedShort() throws IOException, EOFException 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. Exceptions IOException: if an I/O error occurs. EOFException: if this stream reaches the end before reading all the bytes. See Also `java.io.DataInput#readUnsignedShort()`

public int readUnsignedShort() throws IOException, EOFException

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.

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if this stream reaches the end before reading all the bytes.

See Also

java.io.DataInput#readUnsignedShort()

readUTF back to summary

readUTF	back to summary
public String readUTF() throws IOException, EOFException Implements java.io.DataInput.readUTF. Not currently supported. Returns:String Doc from java.io.DataInput.readUTF. a Unicode string. Exceptions IOException: Doc from java.io.DataInput.readUTF. if an I/O error occurs. EOFException: Doc from java.io.DataInput.readUTF. if this stream reaches the end before reading all the bytes. See Also `java.io.DataInput#readUTF()`

public String readUTF() throws IOException, EOFException

Implements java.io.DataInput.readUTF.

Not currently supported.

Returns:String

Doc from java.io.DataInput.readUTF.

a Unicode string.

Exceptions

IOException:

Doc from java.io.DataInput.readUTF.

if an I/O error occurs.

EOFException:

Doc from java.io.DataInput.readUTF.

if this stream reaches the end before reading all the bytes.

See Also

java.io.DataInput#readUTF()

skipBytes back to summary

skipBytes	back to summary
public int skipBytes(int count) throws IOException, EOFException 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 count:int the number of bytes to be skipped. Returns:int the number of bytes actually skipped. Exceptions IOException: if an I/O error occurs. See Also `java.io.DataInput#skipBytes(int)`

public int skipBytes(int count) throws IOException, EOFException

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

count:int: the number of bytes to be skipped.

Returns:int

the number of bytes actually skipped.

Exceptions

IOException:: if an I/O error occurs.

See Also

java.io.DataInput#skipBytes(int)

public Class SwappedDataInputStream

Constructor Summary

Method Summary

Constructor Detail

Method Detail