java.io
Class DataInputStream

public class DataInputStream
extends FilterInputStream
implements DataInput
A data input stream lets an application read primitive Java data types from an underlying input stream in a machine-independent way. An application uses a data output stream to write data that can later be read by a data input stream.

Data input streams and data output streams represent Unicode strings in a format that is a slight modification of UTF-8. (For more information, see X/Open Company Ltd., "File System Safe UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification, Document Number: P316. This information also appears in ISO/IEC 10646, Annex P.)

All characters in the range '\u0001' to '\u007F' are represented by a single byte:

0 bits 0-7

The null character '\u0000' and characters in the range '\u0080' to '\u07FF' are represented by a pair of bytes:

1 1 0 bits 6-10
1 0 bits 0-5

Characters in the range '\u0800' to '\uFFFF' are represented by three bytes:
1 1 1 0 bits 12-15
1 0 bits 6-11
1 0 bits 0-5

The two differences between this format and the "standard" UTF-8 format are the following:

Version:
1.51, 02/28/00
Author:
Arthur van Hoff
Since:
JDK1.0
See Also:
java.io.DataOutputStream
Constructor Detail

DataInputStream

public DataInputStream(InputStream in)
Creates a FilterInputStream and saves its argument, the input stream in, for later use. An internal
Parameters:
in - the input stream.

Method Detail

read

public final int read(byte[] b)
See the general contract of the read method of DataInput.

Bytes for this operation are read from the contained input stream.

Parameters:
b - the buffer into which the data is read.
Returns:
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.
Throws:
IOException - if an I/O error occurs.
See Also:
java.io.FilterInputStream#in
java.io.InputStream#read(byte[], int, int)

read

public final int read(byte[] b,
                      int off,
                      int len)
See the general contract of the read method of DataInput.

Bytes for this operation are read from the contained input stream.

Parameters:
b - the buffer into which the data is read.
off - the start offset of the data.
len - the maximum number of bytes read.
Returns:
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.
Throws:
IOException - if an I/O error occurs.
See Also:
java.io.FilterInputStream#in
java.io.InputStream#read(byte[], int, int)

readFully

public final void readFully(byte[] b)
See the general contract of the readFully method of DataInput.

Bytes for this operation are read from the contained input stream.

Parameters:
b - the buffer into which the data is read.
Throws:
EOFException - if this input stream reaches the end before reading all the bytes.
IOException - if an I/O error occurs.
See Also:
java.io.FilterInputStream#in

readFully

public final void readFully(byte[] b,
                            int off,
                            int len)
See the general contract of the readFully method of DataInput.

Bytes for this operation are read from the contained input stream.

Parameters:
b - the buffer into which the data is read.
off - the start offset of the data.
len - the number of bytes to read.
Throws:
EOFException - if this input stream reaches the end before reading all the bytes.
IOException - if an I/O error occurs.
See Also:
java.io.FilterInputStream#in

skipBytes

public final int skipBytes(int n)
See the general contract of the skipBytes method of DataInput.

Bytes for this operation are read from the contained input stream.

Parameters:
n - the number of bytes to be skipped.
Returns:
the actual number of bytes skipped.
Throws:
IOException - if an I/O error occurs.

readBoolean

public final boolean readBoolean()
See the general contract of the readBoolean method of DataInput.

Bytes for this operation are read from the contained input stream.

Returns:
the boolean value read.
Throws:
EOFException - if this input stream has reached the end.
IOException - if an I/O error occurs.
See Also:
java.io.FilterInputStream#in

readByte

public final byte readByte()
See the general contract of the readByte method of DataInput.

Bytes for this operation are read from the contained input stream.

Returns:
the next byte of this input stream as a signed 8-bit byte.
Throws:
EOFException - if this input stream has reached the end.
IOException - if an I/O error occurs.
See Also:
java.io.FilterInputStream#in

readUnsignedByte

public final int readUnsignedByte()
See the general contract of the readUnsignedByte method of DataInput.

Bytes for this operation are read from the contained input stream.

Returns:
the next byte of this input stream, interpreted as an unsigned 8-bit number.
Throws:
EOFException - if this input stream has reached the end.
IOException - if an I/O error occurs.
See Also:
java.io.FilterInputStream#in

readShort

public final short readShort()
See the general contract of the readShort method of DataInput.

Bytes for this operation are read from the contained input stream.

Returns:
the next two bytes of this input stream, interpreted as a signed 16-bit number.
Throws:
EOFException - if this input stream reaches the end before reading two bytes.
IOException - if an I/O error occurs.
See Also:
java.io.FilterInputStream#in

readUnsignedShort

public final int readUnsignedShort()
See the general contract of the readUnsignedShort method of DataInput.

Bytes for this operation are read from the contained input stream.

Returns:
the next two bytes of this input stream, interpreted as an unsigned 16-bit integer.
Throws:
EOFException - if this input stream reaches the end before reading two bytes.
IOException - if an I/O error occurs.
See Also:
java.io.FilterInputStream#in

readChar

public final char readChar()
See the general contract of the readChar method of DataInput.

Bytes for this operation are read from the contained input stream.

Returns:
the next two bytes of this input stream as a Unicode character.
Throws:
EOFException - if this input stream reaches the end before reading two bytes.
IOException - if an I/O error occurs.
See Also:
java.io.FilterInputStream#in

readInt

public final int readInt()
See the general contract of the readInt method of DataInput.

Bytes for this operation are read from the contained input stream.

Returns:
the next four bytes of this input stream, interpreted as an int.
Throws:
EOFException - if this input stream reaches the end before reading four bytes.
IOException - if an I/O error occurs.
See Also:
java.io.FilterInputStream#in

readLong

public final long readLong()
See the general contract of the readLong method of DataInput.

Bytes for this operation are read from the contained input stream.

Returns:
the next eight bytes of this input stream, interpreted as a long.
Throws:
EOFException - if this input stream reaches the end before reading eight bytes.
IOException - if an I/O error occurs.
See Also:
java.io.FilterInputStream#in

readFloat

public final float readFloat()
See the general contract of the readFloat method of DataInput.

Bytes for this operation are read from the contained input stream.

Returns:
the next four bytes of this input stream, interpreted as a float.
Throws:
EOFException - if this input stream reaches the end before reading four bytes.
IOException - if an I/O error occurs.
See Also:
java.io.DataInputStream#readInt()
java.lang.Float#intBitsToFloat(int)

readDouble

public final double readDouble()
See the general contract of the readDouble method of DataInput.

Bytes for this operation are read from the contained input stream.

Returns:
the next eight bytes of this input stream, interpreted as a double.
Throws:
EOFException - if this input stream reaches the end before reading eight bytes.
IOException - if an I/O error occurs.
See Also:
java.io.DataInputStream#readLong()
java.lang.Double#longBitsToDouble(long)

readLine

public final String readLine()
Deprecated.  This method does not properly convert bytes to characters. As of JDK 1.1, the preferred way to read lines of text is via the BufferedReader.readLine() method. Programs that use the DataInputStream class to read lines can be converted to use the BufferedReader class by replacing code of the form:
     DataInputStream d = new DataInputStream(in);
 
with:
     BufferedReader d
          = new BufferedReader(new InputStreamReader(in));
 
See the general contract of the readLine method of DataInput.

Bytes for this operation are read from the contained input stream.

Returns:
the next line of text from this input stream.
Throws:
IOException - if an I/O error occurs.
See Also:
java.io.BufferedReader#readLine()
java.io.FilterInputStream#in

readUTF

public final String readUTF()
See the general contract of the readUTF method of DataInput.

Bytes for this operation are read from the contained input stream.

Returns:
a Unicode string.
Throws:
EOFException - if this input stream reaches the end before reading all the bytes.
IOException - if an I/O error occurs.
See Also:
java.io.DataInputStream#readUTF(java.io.DataInput)

readUTF

public static final String readUTF(DataInput in)
Reads from the stream in a representation of a Unicode character string encoded in Java modified UTF-8 format; this string of characters is then returned as a String. The details of the modified UTF-8 representation are exactly the same as for the readUTF method of DataInput.
Parameters:
in - a data input stream.
Returns:
a Unicode string.
Throws:
EOFException - if the input stream reaches the end before all the bytes.
IOException - if an I/O error occurs.
UTFDataFormatException - if the bytes do not represent a valid UTF-8 encoding of a Unicode string.
See Also:
java.io.DataInputStream#readUnsignedShort()