Added in API level 1

DataInputStream

open class DataInputStream : FilterInputStream, DataInput
kotlin.Any
   ↳ java.io.InputStream
   ↳ java.io.FilterInputStream
   ↳ java.io.DataInputStream

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.

DataInputStream is not necessarily safe for multithreaded access. Thread safety is optional and is the responsibility of users of methods in this class.

Summary

Public constructors

Creates a DataInputStream that uses the specified underlying InputStream.

Public methods
Int

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

Int
read(b: ByteArray!, off: Int, len: Int)

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

Boolean

See the general contract of the readBoolean method of DataInput.

Byte

See the general contract of the readByte method of DataInput.

Char

See the general contract of the readChar method of DataInput.

Double

See the general contract of the readDouble method of DataInput.

Float

See the general contract of the readFloat method of DataInput.

Unit

See the general contract of the readFully method of DataInput.

Unit
readFully(b: ByteArray!, off: Int, len: Int)

See the general contract of the readFully method of DataInput.

Int

See the general contract of the readInt method of DataInput.

String!

See the general contract of the readLine method of DataInput.

Long

See the general contract of the readLong method of DataInput.

Short

See the general contract of the readShort method of DataInput.

String!

See the general contract of the readUTF method of DataInput.

static String!

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.

Int

See the general contract of the readUnsignedByte method of DataInput.

Int

See the general contract of the readUnsignedShort method of DataInput.

Int

See the general contract of the skipBytes method of DataInput.

Inherited functions
Inherited properties

Public constructors

DataInputStream

Added in API level 1
DataInputStream(in: InputStream!)

Creates a DataInputStream that uses the specified underlying InputStream.

Parameters
in InputStream!: the specified input stream

Public methods

read

Added in API level 1
fun read(b: ByteArray!): Int

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 ByteArray!: the buffer into which the data is read.
Return
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
java.io.IOException If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.
java.lang.NullPointerException if b is null.
java.io.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.

read

Added in API level 1
fun read(
    b: ByteArray!,
    off: Int,
    len: Int
): Int

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 ByteArray!: 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.
Return
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
java.io.IOException If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.
java.lang.NullPointerException If b is null.
java.lang.IndexOutOfBoundsException If off is negative, len is negative, or len is greater than b.length - off
java.lang.NullPointerException If b is null.
java.lang.IndexOutOfBoundsException If off is negative, len is negative, or len is greater than b.length - off
java.io.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.

readBoolean

Added in API level 1
fun readBoolean(): Boolean

See the general contract of the readBoolean method of DataInput.

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

Return
Boolean the boolean value read.
Exceptions
java.io.EOFException if this input stream has reached the end.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readByte

Added in API level 1
fun readByte(): Byte

See the general contract of the readByte method of DataInput.

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

Return
Byte the next byte of this input stream as a signed 8-bit byte.
Exceptions
java.io.EOFException if this input stream has reached the end.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readChar

Added in API level 1
fun readChar(): Char

See the general contract of the readChar method of DataInput.

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

Return
Char the next two bytes of this input stream, interpreted as a char.
Exceptions
java.io.EOFException if this input stream reaches the end before reading two bytes.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readDouble

Added in API level 1
fun readDouble(): Double

See the general contract of the readDouble method of DataInput.

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

Return
Double the next eight bytes of this input stream, interpreted as a double.
Exceptions
java.io.EOFException if this input stream reaches the end before reading eight bytes.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readFloat

Added in API level 1
fun readFloat(): Float

See the general contract of the readFloat method of DataInput.

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

Return
Float the next four bytes of this input stream, interpreted as a float.
Exceptions
java.io.EOFException if this input stream reaches the end before reading four bytes.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readFully

Added in API level 1
fun readFully(b: ByteArray!): Unit

See the general contract of the readFully method of DataInput.

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

Parameters
b ByteArray!: the buffer into which the data is read.
Exceptions
java.lang.NullPointerException if b is null.
java.io.EOFException if this input stream reaches the end before reading all the bytes.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readFully

Added in API level 1
fun readFully(
    b: ByteArray!,
    off: Int,
    len: Int
): Unit

See the general contract of the readFully method of DataInput.

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

Parameters
b ByteArray!: 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
java.lang.NullPointerException if b is null.
java.lang.IndexOutOfBoundsException if off is negative, len is negative, or len is greater than b.length - off.
java.io.EOFException if this stream reaches the end before reading all the bytes.
java.io.IOException if an I/O error occurs.
java.lang.NullPointerException if b is null.
java.lang.IndexOutOfBoundsException if off is negative, len is negative, or len is greater than b.length - off.
java.io.EOFException if this input stream reaches the end before reading all the bytes.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readInt

Added in API level 1
fun readInt(): Int

See the general contract of the readInt method of DataInput.

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

Return
Int the next four bytes of this input stream, interpreted as an int.
Exceptions
java.io.EOFException if this input stream reaches the end before reading four bytes.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readLine

Added in API level 1
fun readLine(): String!

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.

Return
String! the next line of text from this input stream.
Exceptions
java.io.IOException if an I/O error occurs.

readLong

Added in API level 1
fun readLong(): Long

See the general contract of the readLong method of DataInput.

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

Return
Long the next eight bytes of this input stream, interpreted as a long.
Exceptions
java.io.EOFException if this input stream reaches the end before reading eight bytes.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readShort

Added in API level 1
fun readShort(): Short

See the general contract of the readShort method of DataInput.

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

Return
Short the next two bytes of this input stream, interpreted as a signed 16-bit number.
Exceptions
java.io.EOFException if this input stream reaches the end before reading two bytes.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readUTF

Added in API level 1
fun readUTF(): String!

See the general contract of the readUTF method of DataInput.

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

Return
String! a Unicode string.
Exceptions
java.io.EOFException if this input stream reaches the end before reading all the bytes.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
java.io.UTFDataFormatException if the bytes do not represent a valid modified UTF-8 encoding of a string.

readUTF

Added in API level 1
static fun readUTF(in: DataInput!): String!

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.
Return
String! a Unicode string.
Exceptions
java.io.EOFException if the input stream reaches the end before all the bytes.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
java.io.UTFDataFormatException if the bytes do not represent a valid modified UTF-8 encoding of a Unicode string.

readUnsignedByte

Added in API level 1
fun readUnsignedByte(): Int

See the general contract of the readUnsignedByte method of DataInput.

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

Return
Int the next byte of this input stream, interpreted as an unsigned 8-bit number.
Exceptions
java.io.EOFException if this input stream has reached the end.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

readUnsignedShort

Added in API level 1
fun readUnsignedShort(): Int

See the general contract of the readUnsignedShort method of DataInput.

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

Return
Int the next two bytes of this input stream, interpreted as an unsigned 16-bit integer.
Exceptions
java.io.EOFException if this input stream reaches the end before reading two bytes.
java.io.IOException the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.

skipBytes

Added in API level 1
fun skipBytes(n: Int): Int

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.
Return
Int the actual number of bytes skipped.
Exceptions
java.io.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.