Java Platform 1.2 API Specification: Class DataInputStream

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java Platform 1.2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.io
Class DataInputStream

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

public class DataInputStream
extends FilterInputStream
implements 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.

Data input streams and data output streams represent Unicode strings in a format that is a slight modification of UTF-8. (For more information, see X/Open Company Ltd., "File System Safe UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification, Document Number: P316. This information also appears in ISO/IEC 10646, Annex P.)

All characters in the range '\u0001' to '\u007F' are represented by a single byte:

bits 0-7

The null character '\u0000' and characters in the range '\u0080' to '\u07FF' are represented by a pair of bytes:

1	1	0	bits 6-10
1	0	bits 0-5

Characters in the range '\u0800' to '\uFFFF' are represented by three bytes:

1	1	1	0	bits 12-15
1	0	bits 6-11
1	0	bits 0-5

The two differences between this format and the "standard" UTF-8 format are the following:

The null byte '\u0000' is encoded in 2-byte format rather than 1-byte, so that the encoded strings never have embedded nulls.
Only the 1-byte, 2-byte, and 3-byte formats are used.

Since:: JDK1.0
See Also:: DataOutputStream

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary
`DataInputStream(InputStream in)` Creates a `FilterInputStream` and saves its argument, the input stream `in`, for later use.

Method Summary
`int`	`read(byte[] b)` See the general contract of the `read` method of `DataInput`.
`int`	`read(byte[] b, int off, int len)` See the general contract of the `read` method of `DataInput`.
`boolean`	`readBoolean()` See the general contract of the `readBoolean` method of `DataInput`.
`byte`	`readByte()` See the general contract of the `readByte` method of `DataInput`.
`char`	`readChar()` See the general contract of the `readChar` method of `DataInput`.
`double`	`readDouble()` See the general contract of the `readDouble` method of `DataInput`.
`float`	`readFloat()` See the general contract of the `readFloat` method of `DataInput`.
`void`	`readFully(byte[] b)` See the general contract of the `readFully` method of `DataInput`.
`void`	`readFully(byte[] b, int off, int len)` See the general contract of the `readFully` method of `DataInput`.
`int`	`readInt()` 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()` See the general contract of the `readLong` method of `DataInput`.
`short`	`readShort()` See the general contract of the `readShort` method of `DataInput`.
`int`	`readUnsignedByte()` See the general contract of the `readUnsignedByte` method of `DataInput`.
`int`	`readUnsignedShort()` See the general contract of the `readUnsignedShort` method of `DataInput`.
`String`	`readUTF()` See the general contract of the `readUTF` method of `DataInput`.
`static String`	`readUTF(DataInput in)` 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)` 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.lang.Object

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

Constructor Detail

DataInputStream

public DataInputStream(InputStream in)

Creates a FilterInputStream and saves its argument, the input stream in, for later use. An internal

Parameters:: in - the input stream.

Method Detail