DataInputStream JDK 1.6)

Methods

public int available () throws IOException [Inherited From FilterInputStream]

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.

public void close () throws IOException [Inherited From FilterInputStream]

Closes this input stream and releases any system resources associated with the stream.

Closes this input stream and releases any system resources
associated with the stream.
This
method simply performs in.close().
Throws:
- IOException - if an I/O error occurs.
See Also: FilterInputStream.in,

publicsynchronized void mark (int readlimit) [Inherited From FilterInputStream]

Marks the current position in this input stream.

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).
Parameters:
- readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.
See Also: FilterInputStream.in, FilterInputStream.reset(),

public boolean markSupported () [Inherited From FilterInputStream]

Tests if this input stream supports the mark and reset methods.

Tests if this input stream supports the mark
and reset methods.
This method
simply performs in.markSupported().
Returns: true if this stream type supports the mark and reset method; false otherwise.
See Also: FilterInputStream.in, InputStream.mark(int), InputStream.reset(),

public int read () throws IOException [Inherited From FilterInputStream] [Specified in InputStream]

Reads the next byte of data from this input stream.

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.
Returns: the next byte of data, or -1 if the end of the stream is reached.
Throws:
- IOException - if an I/O error occurs.
See Also: FilterInputStream.in,

publicfinal int read (byte[] b) throws IOException [Overrides FilterInputStream]

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

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)

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.
Parameters:
- b - the buffer into which the data is read.
Throws:
- 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: FilterInputStream.in, InputStream.read(byte[], int, int),

publicfinal int read (byte[] b, int off, int len) throws IOException [Overrides FilterInputStream]

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

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.
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.
Parameters:
- 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.
Throws:
- 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.
See Also: FilterInputStream.in, InputStream.read(byte[], int, int),

publicfinal boolean readBoolean () throws IOException [Specified in DataInput]

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 - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
See Also: FilterInputStream.in,

publicfinal byte readByte () throws IOException [Specified in DataInput]

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 - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
See Also: FilterInputStream.in,

publicfinal char readChar () throws IOException [Specified in DataInput]

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, interpreted as a char.
Throws:
- 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.
See Also: FilterInputStream.in,

publicfinal double readDouble () throws IOException [Specified in DataInput]

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 - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
See Also: DataInputStream.readLong(), Double.longBitsToDouble(long),

publicfinal float readFloat () throws IOException [Specified in DataInput]

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 - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
See Also: DataInputStream.readInt(), Float.intBitsToFloat(int),

publicfinal void readFully (byte[] b) throws IOException [Specified in DataInput]

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 - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
See Also: FilterInputStream.in,

publicfinal void readFully (byte[] b, int off, int len) throws IOException [Specified in DataInput]

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 - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
See Also: FilterInputStream.in,

publicfinal int readInt () throws IOException [Specified in DataInput]

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 - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
See Also: FilterInputStream.in,

@Deprecated

publicfinal String ~~readLine~~ () throws IOException [Specified in DataInput]

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: BufferedReader.readLine(), FilterInputStream.in,

publicfinal long readLong () throws IOException [Specified in DataInput]

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 - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
See Also: FilterInputStream.in,

publicfinal short readShort () throws IOException [Specified in DataInput]

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 - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
See Also: FilterInputStream.in,

publicfinal int readUnsignedByte () throws IOException [Specified in DataInput]

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 - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
See Also: FilterInputStream.in,

publicfinal int readUnsignedShort () throws IOException [Specified in DataInput]

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 - the stream has been closed and the contained input stream does not support reading after close, or another I/O error occurs.
See Also: FilterInputStream.in,

publicfinal String readUTF () throws IOException [Specified in DataInput]

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 - 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.
See Also: DataInputStream.readUTF(java.io.DataInput),

publicfinalstatic 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.

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.
Returns: a Unicode string.
Parameters:
- in - a data input stream.
Throws:
- 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.
See Also: DataInputStream.readUnsignedShort(),

publicsynchronized void reset () throws IOException [Inherited From FilterInputStream]

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.
Throws:
- IOException - if the stream has not been marked or if the mark has been invalidated.
See Also: FilterInputStream.in, FilterInputStream.mark(int),

public long skip (long n) throws IOException [Inherited From FilterInputStream]

Skips over and discards n bytes of data from this input stream.

Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, no bytes are skipped.

The skip method of this class creates a byte array and then repeatedly reads into it until n bytes have been read or the end of the stream has been reached. Subclasses are encouraged to provide a more efficient implementation of this method. For instance, the implementation may depend on the ability to seek.

This method simply performs in.skip(n).

publicfinal int skipBytes (int n) throws IOException [Specified in DataInput]

See the general contract of the skipBytes method of DataInput.

Bytes for this operation are read from the contained input stream.
Returns: the actual number of bytes skipped.
Parameters:
- n - the number of bytes to be skipped.
Throws:
- 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.