Top Description Fields Constructors Methods
java.io

public Class DataInputStream

extends FilterInputStream
implements DataInput
Class Inheritance
All Implemented Interfaces
java.io.DataInput
Imports
jdk.internal.util.ByteArray, java.util.Objects

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.

A DataInputStream is not safe for use by multiple concurrent threads. If a DataInputStream is to be used by more than one thread then access to the data input stream should be controlled by appropriate synchronization.

Author
Arthur van Hoff
Since
1.0
See Also
java.io.DataOutputStream

Field Summary

Modifier and TypeField and Description
private byte[]
bytearr

working arrays initialized on demand by readUTF

private char[]
private static final byte[]
private static final char[]
private char[]
private final byte[]
Inherited from java.io.FilterInputStream:
in

Constructor Summary

AccessConstructor and Description
public
DataInputStream(InputStream
the specified input stream
in
)

Creates a DataInputStream that uses the specified underlying InputStream.

Method Summary

Modifier and TypeMethod and Description
public final int

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.
read
(byte[]
the buffer into which the data is read.
b
)

Overrides java.io.FilterInputStream.read.

Reads some number of bytes from the contained input stream and stores them into the buffer array b.

public final int

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.
read
(byte[]
the buffer into which the data is read.
b
,
int
the start offset in the destination array b
off
,
int
the maximum number of bytes read.
len
)

Overrides java.io.FilterInputStream.read.

Reads up to len bytes of data from the contained input stream into an array of bytes.

public final boolean

Returns:

the boolean value read.
readBoolean
()

Implements java.io.DataInput.readBoolean.

See the general contract of the readBoolean method of DataInput.

public final byte

Returns:

the next byte of this input stream as a signed 8-bit byte.
readByte
()

Implements java.io.DataInput.readByte.

See the general contract of the readByte method of DataInput.

public final char

Returns:

the next two bytes of this input stream, interpreted as a char.
readChar
()

Implements java.io.DataInput.readChar.

See the general contract of the readChar method of DataInput.

public final double

Returns:

the next eight bytes of this input stream, interpreted as a double.
readDouble
()

Implements java.io.DataInput.readDouble.

See the general contract of the readDouble method of DataInput.

public final float

Returns:

the next four bytes of this input stream, interpreted as a float.
readFloat
()

Implements java.io.DataInput.readFloat.

See the general contract of the readFloat method of DataInput.

public final void
readFully(byte[]
the buffer into which the data is read.
b
)

Implements java.io.DataInput.readFully.

See the general contract of the readFully method of DataInput.

public final void
readFully(byte[]
the buffer into which the data is read.
b
,
int
the start offset in the data array b.
off
,
int
the number of bytes to read.
len
)

Implements java.io.DataInput.readFully.

See the general contract of the readFully method of DataInput.

public final int

Returns:

the next four bytes of this input stream, interpreted as an int.
readInt
()

Implements java.io.DataInput.readInt.

See the general contract of the readInt method of DataInput.

public final String

Returns:

the next line of text from this input stream.
readLine
()

Implements java.io.DataInput.readLine.

Deprecated This method does not properly convert bytes to characters.

See the general contract of the readLine method of DataInput.

public final long

Returns:

the next eight bytes of this input stream, interpreted as a long.
readLong
()

Implements java.io.DataInput.readLong.

See the general contract of the readLong method of DataInput.

public final short

Returns:

the next two bytes of this input stream, interpreted as a signed 16-bit number.
readShort
()

Implements java.io.DataInput.readShort.

See the general contract of the readShort method of DataInput.

public final int

Returns:

the next byte of this input stream, interpreted as an unsigned 8-bit number.
readUnsignedByte
()

Implements java.io.DataInput.readUnsignedByte.

See the general contract of the readUnsignedByte method of DataInput.

public final int

Returns:

the next two bytes of this input stream, interpreted as an unsigned 16-bit integer.
readUnsignedShort
()

Implements java.io.DataInput.readUnsignedShort.

See the general contract of the readUnsignedShort method of DataInput.

public final String

Returns:

a Unicode string.
readUTF
()

Implements java.io.DataInput.readUTF.

See the general contract of the readUTF method of DataInput.

public static final String

Returns:

a Unicode string.
readUTF
(DataInput
a data input stream.
in
)

Reads from the stream in a representation of a Unicode character string encoded in modified UTF-8 format; this string of characters is then returned as a String.

public final int

Returns:

the actual number of bytes skipped.
skipBytes
(int
the number of bytes to be skipped.
n
)

Implements java.io.DataInput.skipBytes.

See the general contract of the skipBytes method of DataInput.

Inherited from java.io.FilterInputStream:
availableclosemarkmarkSupportedreadresetskip

Field Detail

bytearrback to summary
private byte[] bytearr

working arrays initialized on demand by readUTF

chararrback to summary
private char[] chararr
EMPTY_BYTE_ARRAYback to summary
private static final byte[] EMPTY_BYTE_ARRAY
EMPTY_CHAR_ARRAYback to summary
private static final char[] EMPTY_CHAR_ARRAY
lineBufferback to summary
private char[] lineBuffer
readBufferback to summary
private final byte[] readBuffer

Constructor Detail

DataInputStreamback to summary
public DataInputStream(InputStream in)

Creates a DataInputStream that uses the specified underlying InputStream.

Parameters
in:InputStream

the specified input stream

Method Detail

readback to summary
public final int read(byte[] b) throws IOException

Overrides java.io.FilterInputStream.read.

Reads some number of bytes from the contained input stream and stores them into the buffer array b. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown.

If b is null, a NullPointerException is thrown. If the length of b is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[0], the next one into b[1], and so on. The number of bytes read is, at most, equal to the length of b. Let k be the number of bytes actually read; these bytes will be stored in elements b[0] through b[k-1], leaving elements b[k] through b[b.length-1] unaffected.

The read(b) method has the same effect as:

read(b, 0, b.length)
Parameters
b:byte[]

the buffer into which the data is read.

Returns:int

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.

Exceptions
IOException:
if the first byte cannot be read for any reason other than end of file, the stream has been closed and the underlying input stream does not support reading after close, or another I/O error occurs.
See Also
java.io.FilterInputStream#in, java.io.InputStream#read(byte[], int, int)
readback to summary
public final int read(byte[] b, int off, int len) throws IOException

Overrides java.io.FilterInputStream.read.

Reads up to len bytes of data from the contained input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read, possibly zero. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

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. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters
b:byte[]

the buffer into which the data is read.

off:int

the start offset in the destination array b

len:int

the maximum number of bytes read.

Returns:int

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.

Exceptions
IOException:
if the first byte cannot be read for any reason other than end of file, the stream has been closed and the underlying input stream does not support reading after close, or another I/O error occurs.
NullPointerException:
If b is null.
IndexOutOfBoundsException:
If off is negative, len is negative, or len is greater than b.length - off
See Also
java.io.FilterInputStream#in, java.io.InputStream#read(byte[], int, int)
readBooleanback to summary
public final boolean readBoolean() throws IOException

Implements java.io.DataInput.readBoolean.

See the general contract of the readBoolean method of DataInput.

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

Returns:boolean

the boolean value read.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
EOFException:
if this input stream has reached the end.
See Also
java.io.FilterInputStream#in
readByteback to summary
public final byte readByte() throws IOException

Implements java.io.DataInput.readByte.

See the general contract of the readByte method of DataInput.

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

Returns:byte

the next byte of this input stream as a signed 8-bit byte.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
EOFException:
if this input stream has reached the end.
See Also
java.io.FilterInputStream#in
readCharback to summary
public final char readChar() throws IOException

Implements java.io.DataInput.readChar.

See the general contract of the readChar method of DataInput.

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

Returns:char

the next two bytes of this input stream, interpreted as a char.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
EOFException:
if this input stream reaches the end before reading two bytes.
See Also
java.io.FilterInputStream#in
readDoubleback to summary
public final double readDouble() throws IOException

Implements java.io.DataInput.readDouble.

See the general contract of the readDouble method of DataInput.

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

Returns:double

the next eight bytes of this input stream, interpreted as a double.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
EOFException:
if this input stream reaches the end before reading eight bytes.
See Also
java.io.DataInputStream#readLong(), java.lang.Double#longBitsToDouble(long)
readFloatback to summary
public final float readFloat() throws IOException

Implements java.io.DataInput.readFloat.

See the general contract of the readFloat method of DataInput.

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

Returns:float

the next four bytes of this input stream, interpreted as a float.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
EOFException:
if this input stream reaches the end before reading four bytes.
See Also
java.io.DataInputStream#readInt(), java.lang.Float#intBitsToFloat(int)
readFullyback to summary
public final void readFully(byte[] b) throws IOException

Implements java.io.DataInput.readFully.

See the general contract of the readFully method of DataInput.

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

Parameters
b:byte[]

the buffer into which the data is read.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
NullPointerException:
if b is null.
EOFException:
if this input stream reaches the end before reading all the bytes.
See Also
java.io.FilterInputStream#in
readFullyback to summary
public final void readFully(byte[] b, int off, int len) throws IOException

Implements java.io.DataInput.readFully.

See the general contract of the readFully method of DataInput.

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

Parameters
b:byte[]

the buffer into which the data is read.

off:int

the start offset in the data array b.

len:int

the number of bytes to read.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
NullPointerException:
if b is null.
IndexOutOfBoundsException:
if off is negative, len is negative, or len is greater than b.length - off.
EOFException:
if this input stream reaches the end before reading all the bytes.
See Also
java.io.FilterInputStream#in
readIntback to summary
public final int readInt() throws IOException

Implements java.io.DataInput.readInt.

See the general contract of the readInt method of DataInput.

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

Returns:int

the next four bytes of this input stream, interpreted as an int.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
EOFException:
if this input stream reaches the end before reading four bytes.
See Also
java.io.FilterInputStream#in
readLineback to summary
public final String readLine() throws IOException

Implements java.io.DataInput.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:String

the next line of text from this input stream.

Annotations
@Deprecated
Exceptions
IOException:
if an I/O error occurs.
See Also
java.io.BufferedReader#readLine(), java.io.FilterInputStream#in
readLongback to summary
public final long readLong() throws IOException

Implements java.io.DataInput.readLong.

See the general contract of the readLong method of DataInput.

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

Returns:long

the next eight bytes of this input stream, interpreted as a long.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
EOFException:
if this input stream reaches the end before reading eight bytes.
See Also
java.io.FilterInputStream#in
readShortback to summary
public final short readShort() throws IOException

Implements java.io.DataInput.readShort.

See the general contract of the readShort method of DataInput.

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

Returns:short

the next two bytes of this input stream, interpreted as a signed 16-bit number.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
EOFException:
if this input stream reaches the end before reading two bytes.
See Also
java.io.FilterInputStream#in
readUnsignedByteback to summary
public final int readUnsignedByte() throws IOException

Implements java.io.DataInput.readUnsignedByte.

See the general contract of the readUnsignedByte method of DataInput.

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

Returns:int

the next byte of this input stream, interpreted as an unsigned 8-bit number.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
EOFException:
if this input stream has reached the end.
See Also
java.io.FilterInputStream#in
readUnsignedShortback to summary
public final int readUnsignedShort() throws IOException

Implements java.io.DataInput.readUnsignedShort.

See the general contract of the readUnsignedShort method of DataInput.

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

Returns:int

the next two bytes of this input stream, interpreted as an unsigned 16-bit integer.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
EOFException:
if this input stream reaches the end before reading two bytes.
See Also
java.io.FilterInputStream#in
readUTFback to summary
public final String readUTF() throws IOException

Implements java.io.DataInput.readUTF.

See the general contract of the readUTF method of DataInput.

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

Returns:String

a Unicode string.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
EOFException:
if this input stream reaches the end before reading all the bytes.
UTFDataFormatException:
if the bytes do not represent a valid modified UTF-8 encoding of a string.
See Also
java.io.DataInputStream#readUTF(java.io.DataInput)
readUTFback to summary
public static final String readUTF(DataInput in) throws IOException

Reads from the stream in a representation of a Unicode character string encoded in 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:DataInput

a data input stream.

Returns:String

a Unicode string.

Exceptions
IOException:
the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
EOFException:
if the input stream reaches the end before all the bytes.
UTFDataFormatException:
if the bytes do not represent a valid modified UTF-8 encoding of a Unicode string.
See Also
java.io.DataInputStream#readUnsignedShort()
skipBytesback to summary
public final int skipBytes(int n) throws IOException

Implements java.io.DataInput.skipBytes.

See the general contract of the skipBytes method of DataInput.

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

Parameters
n:int

the number of bytes to be skipped.

Returns:int

the actual number of bytes skipped.

Exceptions
IOException:
if the contained input stream does not support seek, or the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.