public class DataInputStream

  1. Object
  2. InputStream
  3. DataInputStream

ImplementsAutoCloseable, 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. Since: JDK1.0, CLDC 1.0 See Also:DataOutputStream

Fields

protected InputStream inThe input stream.

Constructors

public DataInputStream(InputStream in)Creates a DataInputStream and saves its argument, the input stream in, for later use.

Methods

public int available() throws IOExceptionReturns the number of bytes that can be read from this input stream without blocking.
public void close() throws IOExceptionCloses this input stream and releases any system resources associated with the stream.
public void mark(int readlimit)Marks the current position in this input stream.
public boolean markSupported()Tests if this input stream supports the mark and reset methods.
public int read() throws IOExceptionReads the next byte of data from this input stream.
public final int read(byte[] b) throws IOExceptionSee the general contract of the read method of DataInput.
public final int read(byte[] b, int off, int len) throws IOExceptionReads up to len bytes of data from this input stream into an array of bytes.
public final boolean readBoolean() throws IOExceptionSee the general contract of the readBoolean method of DataInput.
public final byte readByte() throws IOExceptionSee the general contract of the readByte method of DataInput.
public final char readChar() throws IOExceptionSee the general contract of the readChar method of DataInput.
public final double readDouble() throws IOExceptionSee the general contract of the readDouble method of DataInput.
public final float readFloat() throws IOExceptionSee the general contract of the readFloat method of DataInput.
public final void readFully(byte[] b) throws IOExceptionSee the general contract of the readFully method of DataInput.
public final void readFully(byte[] b, int off, int len) throws IOExceptionSee the general contract of the readFully method of DataInput.
public final int readInt() throws IOExceptionSee the general contract of the readInt method of DataInput.
public final long readLong() throws IOExceptionSee the general contract of the readLong method of DataInput.
public final short readShort() throws IOExceptionSee the general contract of the readShort method of DataInput.
public final int readUnsignedByte() throws IOExceptionSee the general contract of the readUnsignedByte method of DataInput.
public final int readUnsignedShort() throws IOExceptionSee the general contract of the readUnsignedShort method of DataInput.
public final String readUTF() throws IOExceptionSee the general contract of the readUTF method of DataInput.
public static final String readUTF(DataInput in) throws IOExceptionReads 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.
public void reset() throws IOExceptionRepositions this stream to the position at the time the mark method was last called on this input stream.
public long skip(long n) throws IOExceptionSkips over and discards n bytes of data from the input stream.
public final int skipBytes(int n) throws IOExceptionSee the general contract of the skipBytes method of DataInput.

Inherited methods

Field details

in

protected InputStream in
The input stream.

Constructor details

DataInputStream

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

Method details

available

public int available() throws IOException
Returns the number of bytes that can be read from this input stream without blocking. This method simply performs in.available() and returns the result.

close

public void close() throws IOException
Closes this input stream and releases any system resources associated with the stream. This method simply performs in.close().

mark

public void mark(int readlimit)
Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes. The readlimit argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated. This method simply performs in.mark(readlimit).

markSupported

public boolean markSupported()
Tests if this input stream supports the mark and reset methods. This method simply performs in.markSupported().

read

public int read() throws IOException
Reads the next byte of data from this input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. This method simply performs in.read() and returns the result.

read

public final int read(byte[] b) throws IOException
See the general contract of the read method of DataInput. Bytes for this operation are read from the contained input stream.

read

public final int read(byte[] b, int off, int len) throws IOException
Reads up to len bytes of data from this input stream into an array of bytes. This method blocks until some input is available. This method simply performs in.read(b, off, len) and returns the result.

readBoolean

public final boolean readBoolean() throws IOException
See the general contract of the readBoolean method of DataInput. Bytes for this operation are read from the contained input stream.

readByte

public final byte readByte() throws IOException
See the general contract of the readByte method of DataInput. Bytes for this operation are read from the contained input stream.

readChar

public final char readChar() throws IOException
See the general contract of the readChar method of DataInput. Bytes for this operation are read from the contained input stream.

readDouble

public final double readDouble() throws IOException
See the general contract of the readDouble method of DataInput. Bytes for this operation are read from the contained input stream.

readFloat

public final float readFloat() throws IOException
See the general contract of the readFloat method of DataInput. Bytes for this operation are read from the contained input stream.

readFully

public final void readFully(byte[] b) throws IOException
See the general contract of the readFully method of DataInput. Bytes for this operation are read from the contained input stream.

readFully

public final void readFully(byte[] b, int off, int len) throws IOException
See the general contract of the readFully method of DataInput. Bytes for this operation are read from the contained input stream.

readInt

public final int readInt() throws IOException
See the general contract of the readInt method of DataInput. Bytes for this operation are read from the contained input stream.

readLong

public final long readLong() throws IOException
See the general contract of the readLong method of DataInput. Bytes for this operation are read from the contained input stream.

readShort

public final short readShort() throws IOException
See the general contract of the readShort method of DataInput. Bytes for this operation are read from the contained input stream.

readUnsignedByte

public final int readUnsignedByte() throws IOException
See the general contract of the readUnsignedByte method of DataInput. Bytes for this operation are read from the contained input stream.

readUnsignedShort

public final int readUnsignedShort() throws IOException
See the general contract of the readUnsignedShort method of DataInput. Bytes for this operation are read from the contained input stream.

readUTF

public final String readUTF() throws IOException
See the general contract of the readUTF method of DataInput. Bytes for this operation are read from the contained input stream.

readUTF

public static final String readUTF(DataInput in) throws IOException
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.

reset

public void reset() throws IOException
Repositions this stream to the position at the time the mark method was last called on this input stream. This method simply performs in.reset(). Stream marks are intended to be used in situations where you need to read ahead a little to see what’s in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.

skip

public long skip(long n) throws IOException
Skips over and discards n bytes of data from the input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. The actual number of bytes skipped is returned. This method simply performs in.skip(n).

skipBytes

public final int skipBytes(int n) throws IOException
See the general contract of the skipBytes method of DataInput. Bytes for this operation are read from the contained input stream.