saker.util Documentation TaskDoc JavaDoc Packages
public class DataInputUnsyncByteArrayInputStream extends UnsyncByteArrayInputStream implements DataInputByteSource
UnsyncByteArrayInputStream subclass that also implements DataInput to read binary formatted data from the buffer.
Constructors
public
Creates a new stream that is backed by the argument byte array region.
public
Creates a new stream that is backed by the argument buffer.
public
DataInputUnsyncByteArrayInputStream(byte[] buf, int offset, int length)
Creates a new stream that is backed by a region in the argument array.
Methods
public final int
Reads an int from the stream without incrementing its position.
public final boolean
Reads one input byte and returns true if that byte is nonzero, false if that byte is zero.
public final byte
Reads and returns one input byte.
public final char
Reads two input bytes and returns a char value.
public final double
Reads eight input bytes and returns a double value.
public final float
Reads four input bytes and returns a float value.
public final void
readFully(byte[] b)
Reads some bytes from an input stream and stores them into the buffer array b.
public final void
readFully(byte[] b, int offset, int length)
Reads len bytes from an input stream.
public final void
readFully(char[] b)
Reads chars from the stream and stores them in the argument array.
public final void
readFully(char[] b, int offset, int length)
Reads chars from the stream and stores them in the argument array range.
public final void
readFully(double[] b)
Reads doubles from the stream and stores them in the argument array.
public final void
readFully(double[] b, int offset, int length)
Reads doubles from the stream and stores them in the argument array range.
public final void
readFully(float[] b)
Reads floats from the stream and stores them in the argument array.
public final void
readFully(float[] b, int offset, int length)
Reads floats from the stream and stores them in the argument array range.
public final void
readFully(int[] b)
Reads ints from the stream and stores them in the argument array.
public final void
readFully(int[] b, int offset, int length)
Reads ints from the stream and stores them in the argument array range.
public final void
readFully(long[] b)
Reads longs from the stream and stores them in the argument array.
public final void
readFully(long[] b, int offset, int length)
Reads longs from the stream and stores them in the argument array range.
public final void
readFully(short[] b)
Reads shorts from the stream and stores them in the argument array.
public final void
readFully(short[] b, int offset, int length)
Reads shorts from the stream and stores them in the argument array range.
public final void
readFully(boolean[] b)
Reads booleans from the stream and stores them in the argument array.
public final void
readFully(boolean[] b, int offset, int length)
Reads booleans from the stream and stores them in the argument array range.
public final int
Reads four input bytes and returns an int value.
public final String
Reads the next line of text from the input stream.
public final long
Reads eight input bytes and returns a long value.
public final short
Reads two input bytes and returns a short value.
public final String
Reads an int length and the respective number of chars for a string.
public static String
Static implementation for readStringLengthChars(), that reads the string from a plain DataInput.
public final String
Reads in a string that has been encoded using a modified UTF-8 format.
public final int
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
Reads two input bytes and returns an int value in the range 0 through 65535.
public final int
skipBytes(int n)
Makes an attempt to skip over n bytes of data from the input stream, discarding the skipped bytes.
Creates a new stream that is backed by the argument byte array region.
bytesThe byte array region.
NullPointerExceptionIf the argument is null.
Creates a new stream that is backed by the argument buffer.
bufThe byte buffer.
NullPointerExceptionIf the buffer is null.
public DataInputUnsyncByteArrayInputStream(byte[] buf, int offset, int length) throws NullPointerException
Creates a new stream that is backed by a region in the argument array.
bufThe byte buffer.
offsetThe region start offset. (inclusive)
lengthThe number of bytes that is available for reading from the buffer starting at the offset.
NullPointerExceptionIf the buffer is null.
public final int peekInt() throws EOFException
Reads an int from the stream without incrementing its position.
The read int.
EOFExceptionIf there are not enough data to read an int.
public final boolean readBoolean() throws EOFException
Overridden from: DataInput
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.
the boolean value read.
EOFExceptionif this stream reaches the end before reading all the bytes.
public final byte readByte() throws EOFException
Overridden from: DataInput
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.
the 8-bit value read.
EOFExceptionif this stream reaches the end before reading all the bytes.
public final char readChar() throws EOFException
Overridden from: DataInput
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.
the char value read.
EOFExceptionif this stream reaches the end before reading all the bytes.
public final double readDouble() throws EOFException
Overridden from: DataInput
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.
the double value read.
EOFExceptionif this stream reaches the end before reading all the bytes.
public final float readFloat() throws EOFException
Overridden from: DataInput
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.
the float value read.
EOFExceptionif this stream reaches the end before reading all the bytes.
public final void readFully(byte[] b) throws EOFException
Overridden from: DataInput
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.

bthe buffer into which the data is read.
EOFExceptionif this stream reaches the end before reading all the bytes.
public final void readFully(byte[] b, int offset, int length) throws EOFException
Overridden from: DataInput
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.

bthe buffer into which the data is read.
offsetan int specifying the offset into the data.
lengthan int specifying the number of bytes to read.
EOFExceptionif this stream reaches the end before reading all the bytes.
public final void readFully(char[] b) throws EOFException, NullPointerException
Reads chars from the stream and stores them in the argument array.

The argument array will be filled during the reading. An exception is thrown if there are not enough data to fill the array.

The format of each char is the same as in readChar().

bThe char array to fill.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
public final void readFully(char[] b, int offset, int length) throws EOFException, NullPointerException, IndexOutOfBoundsException
Reads chars from the stream and stores them in the argument array range.

The range in the array will be filled during the reading. An exception is thrown if there are not enough data to fill the range.

The format of each char is the same as in readChar().

bThe char array to fill.
offsetThe starting index of the range. (inclusive)
lengthThe number of elements to read.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
IndexOutOfBoundsExceptionIf the specified range is not within the array.
public final void readFully(double[] b) throws EOFException, NullPointerException
Reads doubles from the stream and stores them in the argument array.

The argument array will be filled during the reading. An exception is thrown if there are not enough data to fill the array.

The format of each double is the same as in readDouble().

bThe double array to fill.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
public final void readFully(double[] b, int offset, int length) throws EOFException, NullPointerException, IndexOutOfBoundsException
Reads doubles from the stream and stores them in the argument array range.

The range in the array will be filled during the reading. An exception is thrown if there are not enough data to fill the range.

The format of each double is the same as in readDouble().

bThe double array to fill.
offsetThe starting index of the range. (inclusive)
lengthThe number of elements to read.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
IndexOutOfBoundsExceptionIf the specified range is not within the array.
public final void readFully(float[] b) throws EOFException, NullPointerException
Reads floats from the stream and stores them in the argument array.

The argument array will be filled during the reading. An exception is thrown if there are not enough data to fill the array.

The format of each float is the same as in readFloat().

bThe float array to fill.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
public final void readFully(float[] b, int offset, int length) throws EOFException, NullPointerException, IndexOutOfBoundsException
Reads floats from the stream and stores them in the argument array range.

The range in the array will be filled during the reading. An exception is thrown if there are not enough data to fill the range.

The format of each float is the same as in readFloat().

bThe float array to fill.
offsetThe starting index of the range. (inclusive)
lengthThe number of elements to read.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
IndexOutOfBoundsExceptionIf the specified range is not within the array.
public final void readFully(int[] b) throws EOFException, NullPointerException
Reads ints from the stream and stores them in the argument array.

The argument array will be filled during the reading. An exception is thrown if there are not enough data to fill the array.

The format of each int is the same as in readInt().

bThe int array to fill.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
public final void readFully(int[] b, int offset, int length) throws EOFException, NullPointerException, IndexOutOfBoundsException
Reads ints from the stream and stores them in the argument array range.

The range in the array will be filled during the reading. An exception is thrown if there are not enough data to fill the range.

The format of each int is the same as in readInt().

bThe int array to fill.
offsetThe starting index of the range. (inclusive)
lengthThe number of elements to read.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
IndexOutOfBoundsExceptionIf the specified range is not within the array.
public final void readFully(long[] b) throws EOFException, NullPointerException
Reads longs from the stream and stores them in the argument array.

The argument array will be filled during the reading. An exception is thrown if there are not enough data to fill the array.

The format of each long is the same as in readLong().

bThe long array to fill.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
public final void readFully(long[] b, int offset, int length) throws EOFException, NullPointerException, IndexOutOfBoundsException
Reads longs from the stream and stores them in the argument array range.

The range in the array will be filled during the reading. An exception is thrown if there are not enough data to fill the range.

The format of each long is the same as in readLong().

bThe long array to fill.
offsetThe starting index of the range. (inclusive)
lengthThe number of elements to read.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
IndexOutOfBoundsExceptionIf the specified range is not within the array.
public final void readFully(short[] b) throws EOFException, NullPointerException
Reads shorts from the stream and stores them in the argument array.

The argument array will be filled during the reading. An exception is thrown if there are not enough data to fill the array.

The format of each short is the same as in readShort().

bThe short array to fill.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
public final void readFully(short[] b, int offset, int length) throws EOFException, NullPointerException, IndexOutOfBoundsException
Reads shorts from the stream and stores them in the argument array range.

The range in the array will be filled during the reading. An exception is thrown if there are not enough data to fill the range.

The format of each short is the same as in readShort().

bThe short array to fill.
offsetThe starting index of the range. (inclusive)
lengthThe number of elements to read.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
IndexOutOfBoundsExceptionIf the specified range is not within the array.
public final void readFully(boolean[] b) throws EOFException, NullPointerException
Reads booleans from the stream and stores them in the argument array.

The argument array will be filled during the reading. An exception is thrown if there are not enough data to fill the array.

The format of each boolean is the same as in readBoolean().

bThe boolean array to fill.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
public final void readFully(boolean[] b, int offset, int length) throws EOFException, NullPointerException, IndexOutOfBoundsException
Reads booleans from the stream and stores them in the argument array range.

The range in the array will be filled during the reading. An exception is thrown if there are not enough data to fill the range.

The format of each boolean is the same as in readBoolean().

bThe boolean array to fill.
offsetThe starting index of the range. (inclusive)
lengthThe number of elements to read.
EOFExceptionIf there are not enough data in the stream to fill the buffer.
NullPointerExceptionIf the array is null.
IndexOutOfBoundsExceptionIf the specified range is not within the array.
public final int readInt() throws EOFException
Overridden from: DataInput
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.
the int value read.
EOFExceptionif this stream reaches the end before reading all the bytes.
public final String readLine()
Overridden from: DataInput
Reads the next line of text from the input stream. It reads successive bytes, converting each byte separately into a character, until it encounters a line terminator or end of file; the characters read are then returned as a String. Note that because this method processes bytes, it does not support input of the full Unicode character set.

If end of file is encountered before even one byte can be read, then null is returned. Otherwise, each byte that is read is converted to type char by zero-extension. If the character '\n' is encountered, it is discarded and reading ceases. If the character '\r' is encountered, it is discarded and, if the following byte converts to the character '\n', then that is discarded also; reading then ceases. If end of file is encountered before either of the characters '\n' and '\r' is encountered, reading ceases. Once reading has ceased, a String is returned that contains all the characters read and not discarded, taken in order. Note that every character in this string will have a value less than \u0100, that is, (char)256.

the next line of text from the input stream, or null if the end of file is encountered before a byte can be read.
public final long readLong() throws EOFException
Overridden from: DataInput
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.

the long value read.
EOFExceptionif this stream reaches the end before reading all the bytes.
public final short readShort() throws EOFException
Overridden from: DataInput
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.
the 16-bit value read.
EOFExceptionif this stream reaches the end before reading all the bytes.
Reads an int length and the respective number of chars for a string.

This method reads the length of a char sequence, and length number of characters after that.

The constructed string from the read characters.
EOFExceptionIf there are no more input available to complete the operation.
Static implementation for readStringLengthChars(), that reads the string from a plain DataInput.
inThe data input.
The constructed string from the read characters.
IOExceptionIn case of I/O error.
NullPointerExceptionIf the input is null.
public final String readUTF() throws IOException
Overridden from: DataInput
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.

a Unicode string.
IOExceptionif an I/O error occurs.
public final int readUnsignedByte() throws EOFException
Overridden from: DataInput
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.
the unsigned 8-bit value read.
EOFExceptionif this stream reaches the end before reading all the bytes.
public final int readUnsignedShort() throws EOFException
Overridden from: DataInput
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.
the unsigned 16-bit value read.
EOFExceptionif this stream reaches the end before reading all the bytes.
public final int skipBytes(int n)
Overridden from: DataInput
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.
nthe number of bytes to be skipped.
the number of bytes actually skipped.