Closeable
, DataInput
, AutoCloseable
public class DataInputStream extends FilterInputStream implements DataInput
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.
in
Constructor | Description |
---|---|
DataInputStream |
Creates a DataInputStream that uses the specified underlying InputStream. |
Modifier and Type | Method | Description |
---|---|---|
final int |
read |
Reads some number of bytes from the contained input stream and stores them into the buffer array b . |
final int |
read |
Reads up to len bytes of data from the contained input stream into an array of bytes. |
final boolean |
readBoolean() |
See the general contract of the readBoolean method of DataInput . |
final byte |
readByte() |
See the general contract of the readByte method of DataInput . |
final char |
readChar() |
See the general contract of the readChar method of DataInput . |
final double |
readDouble() |
See the general contract of the readDouble method of DataInput . |
final float |
readFloat() |
See the general contract of the readFloat method of DataInput . |
final void |
readFully |
See the general contract of the readFully method of DataInput . |
final void |
readFully |
See the general contract of the readFully method of DataInput . |
final int |
readInt() |
See the general contract of the readInt method of DataInput . |
final String |
readLine() |
Deprecated. This method does not properly convert bytes to characters. |
final long |
readLong() |
See the general contract of the readLong method of DataInput . |
final short |
readShort() |
See the general contract of the readShort method of DataInput . |
final int |
readUnsignedByte() |
See the general contract of the readUnsignedByte method of DataInput . |
final int |
readUnsignedShort() |
See the general contract of the readUnsignedShort method of DataInput . |
final String |
readUTF() |
See the general contract of the readUTF method of DataInput . |
static final String |
readUTF |
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 . |
final int |
skipBytes |
See the general contract of the skipBytes method of DataInput . |
available, close, mark, markSupported, read, reset, skip
nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo
public DataInputStream(InputStream in)
in
- the specified input streampublic final int read(byte[] b) throws IOException
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)
read
in class FilterInputStream
b
- the buffer into which the data is read.-1
if there is no more data because the end of the stream has been reached.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.public final int read(byte[] b, int off, int len) throws IOException
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.
read
in class FilterInputStream
b
- the buffer into which the data is read.off
- the start offset in the destination array b
len
- the maximum number of bytes read.-1
if there is no more data because the end of the stream has been reached.NullPointerException
- If b
is null
.IndexOutOfBoundsException
- If off
is negative, len
is negative, or len
is greater than b.length - off
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.public final void readFully(byte[] b) throws IOException
readFully
method of DataInput
. Bytes for this operation are read from the contained input stream.
readFully
in interface DataInput
b
- the buffer into which the data is read.NullPointerException
- if b
is null
.EOFException
- if this input stream reaches the end before reading all the bytes.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.public final void readFully(byte[] b, int off, int len) throws IOException
readFully
method of DataInput
. Bytes for this operation are read from the contained input stream.
readFully
in interface DataInput
b
- the buffer into which the data is read.off
- the start offset in the data array b
.len
- the number of bytes to read.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.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.public final int skipBytes(int n) throws IOException
skipBytes
method of DataInput
. Bytes for this operation are read from the contained input stream.
skipBytes
in interface DataInput
n
- the number of bytes to be skipped.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.public final boolean readBoolean() throws IOException
readBoolean
method of DataInput
. Bytes for this operation are read from the contained input stream.
readBoolean
in interface DataInput
boolean
value read.EOFException
- if this input stream has reached the end.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.public final byte readByte() throws IOException
readByte
method of DataInput
. Bytes for this operation are read from the contained input stream.
readByte
in interface DataInput
byte
.EOFException
- if this input stream has reached the end.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.public final int readUnsignedByte() throws IOException
readUnsignedByte
method of DataInput
. Bytes for this operation are read from the contained input stream.
readUnsignedByte
in interface DataInput
EOFException
- if this input stream has reached the end.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.public final short readShort() throws IOException
readShort
method of DataInput
. Bytes for this operation are read from the contained input stream.
readShort
in interface DataInput
EOFException
- if this input stream reaches the end before reading two bytes.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.public final int readUnsignedShort() throws IOException
readUnsignedShort
method of DataInput
. Bytes for this operation are read from the contained input stream.
readUnsignedShort
in interface DataInput
EOFException
- if this input stream reaches the end before reading two bytes.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.public final char readChar() throws IOException
readChar
method of DataInput
. Bytes for this operation are read from the contained input stream.
readChar
in interface DataInput
char
.EOFException
- if this input stream reaches the end before reading two bytes.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.public final int readInt() throws IOException
readInt
method of DataInput
. Bytes for this operation are read from the contained input stream.
readInt
in interface DataInput
int
.EOFException
- if this input stream reaches the end before reading four bytes.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.public final long readLong() throws IOException
readLong
method of DataInput
. Bytes for this operation are read from the contained input stream.
readLong
in interface DataInput
long
.EOFException
- if this input stream reaches the end before reading eight bytes.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.public final float readFloat() throws IOException
readFloat
method of DataInput
. Bytes for this operation are read from the contained input stream.
readFloat
in interface DataInput
float
.EOFException
- if this input stream reaches the end before reading four bytes.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.public final double readDouble() throws IOException
readDouble
method of DataInput
. Bytes for this operation are read from the contained input stream.
readDouble
in interface DataInput
double
.EOFException
- if this input stream reaches the end before reading eight bytes.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.@Deprecated public final String readLine() throws IOException
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: with:DataInputStream d = new DataInputStream(in);
BufferedReader d = new BufferedReader(new InputStreamReader(in));
readLine
method of DataInput
. Bytes for this operation are read from the contained input stream.
readLine
in interface DataInput
IOException
- if an I/O error occurs.public final String readUTF() throws IOException
readUTF
method of DataInput
. Bytes for this operation are read from the contained input stream.
readUTF
in interface DataInput
EOFException
- if this input stream reaches the end before reading all the bytes.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.UTFDataFormatException
- if the bytes do not represent a valid modified UTF-8 encoding of a string.public static final String readUTF(DataInput in) throws IOException
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
.in
- a data input stream.EOFException
- if the input stream reaches the end before all the bytes.IOException
- the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.UTFDataFormatException
- if the bytes do not represent a valid modified UTF-8 encoding of a Unicode string.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/DataInputStream.html