Guava: Google Core Libraries for Java 32.1.2-jre · com.google.common.io.LittleEndianDataInputStream

Access	Constructor and Description
public	LittleEndianDataInputStream(InputStream the stream to delegate to in) Creates a `LittleEndianDataInputStream` that wraps the given stream.

Method Summary

Modifier and Type	Method and Description
private byte	Returns: byte read from input readAndCheckByte() Reads a byte from the input stream checking that the end of file (EOF) has not been encountered.
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	Returns: the next two bytes of the input stream, interpreted as a `char` in little-endian byte order readChar() Implements java.io.DataInput.readChar. Reads a char as specified by `DataInputStream#readChar()`, except using little-endian byte order.
public double	Returns: the next eight bytes of the input stream, interpreted as a `double` in little-endian byte order readDouble() Implements java.io.DataInput.readDouble. Reads a `double` as specified by `DataInputStream#readDouble()`, except using little-endian byte order.
public float	Returns: the next four bytes of the input stream, interpreted as a `float` in little-endian byte order readFloat() Implements java.io.DataInput.readFloat. Reads a `float` as specified by `DataInputStream#readFloat()`, except using little-endian byte order.
public void	readFully(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 void	readFully(byte[] the buffer into which the data is read. b, int an int specifying the offset in the data array `b`. off, int an int specifying the number of bytes to read. len) Implements java.io.DataInput.readFully. Reads `len` bytes from an input stream.
public int	Returns: the next four bytes of the input stream, interpreted as an `int` in little-endian byte order readInt() Implements java.io.DataInput.readInt. Reads an integer as specified by `DataInputStream#readInt()`, except using little-endian byte order.
public String	readLine() Implements java.io.DataInput.readLine. This method will throw an `UnsupportedOperationException`.
public long	Returns: the next eight bytes of the input stream, interpreted as a `long` in little-endian byte order readLong() Implements java.io.DataInput.readLong. Reads a `long` as specified by `DataInputStream#readLong()`, except using little-endian byte order.
public short	Returns: the next two bytes of the input stream, interpreted as a `short` in little-endian byte order. readShort() Implements java.io.DataInput.readShort. Reads a `short` as specified by `DataInputStream#readShort()`, except using little-endian byte order.
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	Returns: the next two bytes of the input stream, interpreted as an unsigned 16-bit integer in little-endian byte order readUnsignedShort() Implements java.io.DataInput.readUnsignedShort. Reads an unsigned `short` as specified by `DataInputStream#readUnsignedShort()`, except using little-endian byte order.
public String	readUTF() Implements java.io.DataInput.readUTF. Reads in a string that has been encoded using a modified UTF-8 format.
public int	skipBytes(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:: available close mark markSupported read read read reset skip

LittleEndianDataInputStream	back to summary
public LittleEndianDataInputStream(InputStream in) Creates a `LittleEndianDataInputStream` that wraps the given stream. Parameters in:InputStream the stream to delegate to

Method Detail

readAndCheckByte	back to summary
private byte readAndCheckByte() throws IOException, EOFException Reads a byte from the input stream checking that the end of file (EOF) has not been encountered. Returns:byte byte read from input Exceptions IOException: if an error is encountered while reading EOFException: if the end of file (EOF) is encountered.

readAndCheckByte

back to summary

private byte readAndCheckByte() throws IOException, EOFException

Reads a byte from the input stream checking that the end of file (EOF) has not been encountered.

Returns:byte

byte read from input

Exceptions

IOException:: if an error is encountered while reading
EOFException:: if the end of file (EOF) is encountered.

readBoolean back to summary

readBoolean	back to summary
public 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 @CanIgnoreReturnValue @Override Exceptions IOException: if an I/O error occurs.

public 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

@CanIgnoreReturnValue
@Override

Exceptions

IOException:: if an I/O error occurs.

readByte back to summary

readByte	back to summary
public 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 @CanIgnoreReturnValue @Override Exceptions IOException: if an I/O error occurs.

public 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

@CanIgnoreReturnValue
@Override

Exceptions

IOException:: if an I/O error occurs.

readChar back to summary

readChar	back to summary
public char readChar() throws IOException Implements java.io.DataInput.readChar. Reads a char as specified by `DataInputStream#readChar()`, except using little-endian byte order. Returns:char the next two bytes of the input stream, interpreted as a `char` in little-endian byte order Annotations @CanIgnoreReturnValue @Override Exceptions IOException: if an I/O error occurs

public char readChar() throws IOException

Implements java.io.DataInput.readChar.

Reads a char as specified by DataInputStream#readChar(), except using little-endian byte order.

Returns:char

the next two bytes of the input stream, interpreted as a char in little-endian byte order

Annotations

@CanIgnoreReturnValue
@Override

Exceptions

IOException:: if an I/O error occurs

readDouble back to summary

readDouble	back to summary
public double readDouble() throws IOException Implements java.io.DataInput.readDouble. Reads a `double` as specified by `DataInputStream#readDouble()`, except using little-endian byte order. Returns:double the next eight bytes of the input stream, interpreted as a `double` in little-endian byte order Annotations @CanIgnoreReturnValue @Override Exceptions IOException: if an I/O error occurs

public double readDouble() throws IOException

Implements java.io.DataInput.readDouble.

Reads a double as specified by DataInputStream#readDouble(), except using little-endian byte order.

Returns:double

the next eight bytes of the input stream, interpreted as a double in little-endian byte order

Annotations

@CanIgnoreReturnValue
@Override

Exceptions

IOException:: if an I/O error occurs

readFloat back to summary

readFloat	back to summary
public float readFloat() throws IOException Implements java.io.DataInput.readFloat. Reads a `float` as specified by `DataInputStream#readFloat()`, except using little-endian byte order. Returns:float the next four bytes of the input stream, interpreted as a `float` in little-endian byte order Annotations @CanIgnoreReturnValue @Override Exceptions IOException: if an I/O error occurs

public float readFloat() throws IOException

Implements java.io.DataInput.readFloat.

Reads a float as specified by DataInputStream#readFloat(), except using little-endian byte order.

Returns:float

the next four bytes of the input stream, interpreted as a float in little-endian byte order

Annotations

@CanIgnoreReturnValue
@Override

Exceptions

IOException:: if an I/O error occurs

readFully back to summary

readFully	back to summary
public void readFully(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.

public void readFully(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.

readFully back to summary

readFully	back to summary
public void readFully(byte[] b, int off, 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.

public void readFully(byte[] b, int off, 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.

readInt back to summary

readInt	back to summary
public int readInt() throws IOException Implements java.io.DataInput.readInt. Reads an integer as specified by `DataInputStream#readInt()`, except using little-endian byte order. Returns:int the next four bytes of the input stream, interpreted as an `int` in little-endian byte order Annotations @CanIgnoreReturnValue @Override Exceptions IOException: if an I/O error occurs

public int readInt() throws IOException

Implements java.io.DataInput.readInt.

Reads an integer as specified by DataInputStream#readInt(), except using little-endian byte order.

Returns:int

the next four bytes of the input stream, interpreted as an int in little-endian byte order

Annotations

@CanIgnoreReturnValue
@Override

Exceptions

IOException:: if an I/O error occurs

readLine back to summary

readLine	back to summary
public String readLine() Implements java.io.DataInput.readLine. This method will throw an `UnsupportedOperationException`. 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. Annotations @CanIgnoreReturnValue @Override @DoNotCall:Always throws UnsupportedOperationException

public String readLine()

Implements java.io.DataInput.readLine.

This method will throw an UnsupportedOperationException.

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.

Annotations

@CanIgnoreReturnValue
@Override
@DoNotCall:Always throws UnsupportedOperationException

readLong back to summary

readLong	back to summary
public long readLong() throws IOException Implements java.io.DataInput.readLong. Reads a `long` as specified by `DataInputStream#readLong()`, except using little-endian byte order. Returns:long the next eight bytes of the input stream, interpreted as a `long` in little-endian byte order Annotations @CanIgnoreReturnValue @Override Exceptions IOException: if an I/O error occurs

public long readLong() throws IOException

Implements java.io.DataInput.readLong.

Reads a long as specified by DataInputStream#readLong(), except using little-endian byte order.

Returns:long

the next eight bytes of the input stream, interpreted as a long in little-endian byte order

Annotations

@CanIgnoreReturnValue
@Override

Exceptions

IOException:: if an I/O error occurs

readShort back to summary

readShort	back to summary
public short readShort() throws IOException Implements java.io.DataInput.readShort. Reads a `short` as specified by `DataInputStream#readShort()`, except using little-endian byte order. Returns:short the next two bytes of the input stream, interpreted as a `short` in little-endian byte order. Annotations @CanIgnoreReturnValue @Override Exceptions IOException: if an I/O error occurs.

public short readShort() throws IOException

Implements java.io.DataInput.readShort.

Reads a short as specified by DataInputStream#readShort(), except using little-endian byte order.

Returns:short

the next two bytes of the input stream, interpreted as a short in little-endian byte order.

Annotations

@CanIgnoreReturnValue
@Override

Exceptions

IOException:: if an I/O error occurs.

readUnsignedByte back to summary

readUnsignedByte	back to summary
public 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 @CanIgnoreReturnValue @Override Exceptions IOException: if an I/O error occurs.

public 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

@CanIgnoreReturnValue
@Override

Exceptions

IOException:: if an I/O error occurs.

readUnsignedShort back to summary

readUnsignedShort	back to summary
public int readUnsignedShort() throws IOException Implements java.io.DataInput.readUnsignedShort. Reads an unsigned `short` as specified by `DataInputStream#readUnsignedShort()`, except using little-endian byte order. Returns:int the next two bytes of the input stream, interpreted as an unsigned 16-bit integer in little-endian byte order Annotations @CanIgnoreReturnValue @Override Exceptions IOException: if an I/O error occurs

public int readUnsignedShort() throws IOException

Implements java.io.DataInput.readUnsignedShort.

Reads an unsigned short as specified by DataInputStream#readUnsignedShort(), except using little-endian byte order.

Returns:int

the next two bytes of the input stream, interpreted as an unsigned 16-bit integer in little-endian byte order

Annotations

@CanIgnoreReturnValue
@Override

Exceptions

IOException:: if an I/O error occurs

readUTF back to summary

readUTF	back to summary
public String readUTF() throws IOException Implements java.io.DataInput.readUTF. Doc from java.io.DataInput.readUTF. Reads in a string that has been encoded using a modified UTF-8 format. The general contract of `readUTF` is that it reads a representation of a Unicode character string encoded in modified UTF-8 format; this string of characters is then returned as a `String`. First, two bytes are read and used to construct an unsigned 16-bit integer in exactly the manner of the `readUnsignedShort` method . This integer value is called the UTF length and specifies the number of additional bytes to be read. These bytes are then converted to characters by considering them in groups. The length of each group is computed from the value of the first byte of the group. The byte following a group, if any, is the first byte of the next group. If the first byte of a group matches the bit pattern `0xxxxxxx` (where `x` means "may be `0` or `1`"), then the group consists of just that byte. The byte is zero-extended to form a character. If the first byte of a group matches the bit pattern `110xxxxx`, then the group consists of that byte `a` and a second byte `b`. If there is no byte `b` (because byte `a` was the last of the bytes to be read), or if byte `b` does not match the bit pattern `10xxxxxx`, then a `UTFDataFormatException` is thrown. Otherwise, the group is converted to the character: `(char)(((a & 0x1F) << 6) \| (b & 0x3F))` If the first byte of a group matches the bit pattern `1110xxxx`, then the group consists of that byte `a` and two more bytes `b` and `c`. If there is no byte `c` (because byte `a` was one of the last two of the bytes to be read), or either byte `b` or byte `c` does not match the bit pattern `10xxxxxx`, then a `UTFDataFormatException` is thrown. Otherwise, the group is converted to the character: `(char)(((a & 0x0F) << 12) \| ((b & 0x3F) << 6) \| (c & 0x3F))` If the first byte of a group matches the pattern `1111xxxx` or the pattern `10xxxxxx`, then a `UTFDataFormatException` is thrown. If end of file is encountered at any time during this entire process, then an `EOFException` is thrown. After every group has been converted to a character by this process, the characters are gathered, in the same order in which their corresponding groups were read from the input stream, to form a `String`, which is returned. The `writeUTF` method of interface `DataOutput` may be used to write data that is suitable for reading by this method. Returns:String a Unicode string. Annotations @CanIgnoreReturnValue @Override Exceptions IOException: if an I/O error occurs.

public String readUTF() throws IOException

Implements java.io.DataInput.readUTF.

Doc from java.io.DataInput.readUTF.

Reads in a string that has been encoded using a modified UTF-8 format. The general contract of readUTF is that it reads a representation of a Unicode character string encoded in modified UTF-8 format; this string of characters is then returned as a String.

First, two bytes are read and used to construct an unsigned 16-bit integer in exactly the manner of the readUnsignedShort method . This integer value is called the UTF length and specifies the number of additional bytes to be read. These bytes are then converted to characters by considering them in groups. The length of each group is computed from the value of the first byte of the group. The byte following a group, if any, is the first byte of the next group.

If the first byte of a group matches the bit pattern 0xxxxxxx (where x means "may be 0 or 1"), then the group consists of just that byte. The byte is zero-extended to form a character.

If the first byte of a group matches the bit pattern 110xxxxx, then the group consists of that byte a and a second byte b. If there is no byte b (because byte a was the last of the bytes to be read), or if byte b does not match the bit pattern 10xxxxxx, then a UTFDataFormatException is thrown. Otherwise, the group is converted to the character:

(char)(((a & 0x1F) << 6) | (b & 0x3F))

If the first byte of a group matches the bit pattern 1110xxxx, then the group consists of that byte a and two more bytes b and c. If there is no byte c (because byte a was one of the last two of the bytes to be read), or either byte b or byte c does not match the bit pattern 10xxxxxx, then a UTFDataFormatException is thrown. Otherwise, the group is converted to the character:

(char)(((a & 0x0F) << 12) | ((b & 0x3F) << 6) | (c & 0x3F))

If the first byte of a group matches the pattern 1111xxxx or the pattern 10xxxxxx, then a UTFDataFormatException is thrown.

If end of file is encountered at any time during this entire process, then an EOFException is thrown.

After every group has been converted to a character by this process, the characters are gathered, in the same order in which their corresponding groups were read from the input stream, to form a String, which is returned.

The writeUTF method of interface DataOutput may be used to write data that is suitable for reading by this method.

Returns:String

a Unicode string.

Annotations

@CanIgnoreReturnValue
@Override

Exceptions

IOException:: if an I/O error occurs.

skipBytes back to summary

skipBytes	back to summary
public int skipBytes(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.

public int skipBytes(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.

public final Class LittleEndianDataInputStream

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail