java.io
Class DataInputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--java.io.FilterInputStream
              |
              +--java.io.DataInputStream

All Implemented Interfaces:

DataInput

public class DataInputStream

extends FilterInputStream

implements DataInput

Safe:

Field Summary

private char[]

lineBuffer

Fields inherited from class java.io.FilterInputStream

in

Fields inherited from class java.io.InputStream

Constructor Summary

DataInputStream(InputStream in)
Enabled: Creates a DataInputStream that uses the specified underlying InputStream.

Method Summary

int	read(byte[] b) Enabled: Reads some number of bytes from the contained input stream and stores them into the buffer array b.
int	read(byte[] b, int off, int len) Enabled: Reads up to len bytes of data from the contained input stream into an array of bytes.
boolean	readBoolean() Enabled: See the general contract of the readBoolean method of DataInput.
byte	readByte() Enabled: See the general contract of the readByte method of DataInput.
char	readChar() Enabled: See the general contract of the readChar method of DataInput.
double	readDouble() Enabled: See the general contract of the readDouble method of DataInput.
float	readFloat() Enabled: See the general contract of the readFloat method of DataInput.
void	readFully(byte[] b) Enabled: See the general contract of the readFully method of DataInput.
void	readFully(byte[] b, int off, int len) Enabled: See the general contract of the readFully method of DataInput.
int	readInt() Enabled: See the general contract of the readInt method of DataInput.
String	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));
long	readLong() Enabled: See the general contract of the readLong method of DataInput.
short	readShort() Enabled: See the general contract of the readShort method of DataInput.
int	readUnsignedByte() Enabled: See the general contract of the readUnsignedByte method of DataInput.
int	readUnsignedShort() Enabled: See the general contract of the readUnsignedShort method of DataInput.
String	readUTF() Enabled: See the general contract of the readUTF method of DataInput.
static String	readUTF(DataInput in) Enabled: 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.
int	skipBytes(int n) Enabled: See the general contract of the skipBytes method of DataInput.

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, reset, skip

Methods inherited from class java.io.InputStream

__printOn, getCryptoHash, readAvailable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.io.DataInput

readWholeNum

Field Detail

lineBuffer

private char[] lineBuffer

Constructor Detail

DataInputStream

public DataInputStream(InputStream in)

Enabled: Creates a DataInputStream that uses the specified underlying InputStream.

Parameters:

in - the specified input stream

Method Detail

read

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

Enabled: 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.

If the first byte cannot be read for any reason other than end of file, then an IOException is thrown. In particular, an IOException is thrown if the input stream has been closed.

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

 read(b, 0, b.length) 
 

Overrides:

read in class FilterInputStream

Parameters:

b - the buffer into which the data is read.

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.

IOException

See Also:

java.io.FilterInputStream#in, java.io.InputStream#read(byte[], int, int)

read

public final int read(byte[] b,
                      int off,
                      int len)
               throws IOException

Enabled: 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 b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException 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.

If the first byte cannot be read for any reason other than end of file, then an IOException is thrown. In particular, an IOException is thrown if the input stream has been closed.

Overrides:

read in class FilterInputStream

Parameters:

b - the buffer into which the data is read.

off - the start offset of the data.

len - the maximum number of bytes read.

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.

IOException

See Also:

java.io.FilterInputStream#in, java.io.InputStream#read(byte[], int, int)

readFully

public final void readFully(byte[] b)
                     throws IOException

Enabled: See the general contract of the readFully method of DataInput.

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

Specified by:

readFully in interface DataInput

Parameters:

b - the buffer into which the data is read.

IOException

See Also:

java.io.FilterInputStream#in

readFully

public final void readFully(byte[] b,
                            int off,
                            int len)
                     throws IOException

Enabled: See the general contract of the readFully method of DataInput.

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

Specified by:

readFully in interface DataInput

Parameters:

b - the buffer into which the data is read.

off - the start offset of the data.

len - the number of bytes to read.

IOException

See Also:

java.io.FilterInputStream#in

skipBytes

public final int skipBytes(int n)
                    throws IOException

Enabled: See the general contract of the skipBytes method of DataInput.

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

Specified by:

skipBytes in interface DataInput

Parameters:

n - the number of bytes to be skipped.

Returns:

the actual number of bytes skipped.

IOException

readBoolean

public final boolean readBoolean()
                          throws IOException

Enabled: See the general contract of the readBoolean method of DataInput.

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

Specified by:

readBoolean in interface DataInput

Returns:

the boolean value read.

IOException

See Also:

java.io.FilterInputStream#in

readByte

public final byte readByte()
                    throws IOException

Enabled: See the general contract of the readByte method of DataInput.

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

Specified by:

readByte in interface DataInput

Returns:

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

IOException

See Also:

java.io.FilterInputStream#in

readUnsignedByte

public final int readUnsignedByte()
                           throws IOException

Enabled: See the general contract of the readUnsignedByte method of DataInput.

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

Specified by:

readUnsignedByte in interface DataInput

Returns:

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

IOException

See Also:

java.io.FilterInputStream#in

readShort

public final short readShort()
                      throws IOException

Enabled: See the general contract of the readShort method of DataInput.

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

Specified by:

readShort in interface DataInput

Returns:

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

IOException

See Also:

java.io.FilterInputStream#in

readUnsignedShort

public final int readUnsignedShort()
                            throws IOException

Enabled: See the general contract of the readUnsignedShort method of DataInput.

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

Specified by:

readUnsignedShort in interface DataInput

Returns:

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

IOException

See Also:

java.io.FilterInputStream#in

readChar

public final char readChar()
                    throws IOException

Enabled: See the general contract of the readChar method of DataInput.

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

Specified by:

readChar in interface DataInput

Returns:

the next two bytes of this input stream as a Unicode character.

IOException

See Also:

java.io.FilterInputStream#in

readInt

public final int readInt()
                  throws IOException

Enabled: See the general contract of the readInt method of DataInput.

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

Specified by:

readInt in interface DataInput

Returns:

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

IOException

See Also:

java.io.FilterInputStream#in

readLong

public final long readLong()
                    throws IOException

Enabled: See the general contract of the readLong method of DataInput.

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

Specified by:

readLong in interface DataInput

Returns:

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

IOException

See Also:

java.io.FilterInputStream#in

readFloat

public final float readFloat()
                      throws IOException

Enabled: See the general contract of the readFloat method of DataInput.

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

Specified by:

readFloat in interface DataInput

Returns:

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

IOException

See Also:

java.io.DataInputStream#readInt(), java.lang.Float#intBitsToFloat(int)

readDouble

public final double readDouble()
                        throws IOException

Enabled: See the general contract of the readDouble method of DataInput.

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

Specified by:

readDouble in interface DataInput

Returns:

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

IOException

See Also:

java.io.DataInputStream#readLong(), java.lang.Double#longBitsToDouble(long)

readLine

public final String readLine()
                      throws IOException

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));
 

Enabled: See the general contract of the readLine method of DataInput.

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

Specified by:

readLine in interface DataInput

Returns:

the next line of text from this input stream.

IOException

See Also:

java.io.BufferedReader#readLine(), java.io.FilterInputStream#in

readUTF

public final String readUTF()
                     throws IOException

Enabled: See the general contract of the readUTF method of DataInput.

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

Specified by:

readUTF in interface DataInput

Returns:

a Unicode string.

IOException

See Also:

java.io.DataInputStream#readUTF(java.io.DataInput)

readUTF

public static final String readUTF(DataInput in)
                            throws IOException

Enabled: 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.

Parameters:

in - a data input stream.

Returns:

a Unicode string.

IOException

See Also:

java.io.DataInputStream#readUnsignedShort()