Android - An Open Handset Alliance Project

java.io
public class

java.io.DataInputStream

java.lang.Object
	java.io.InputStream			Closeable
		java.io.FilterInputStream
			java.io.DataInputStream	DataInput

DataInputStream is a filter class which can read typed data from a Stream. Typically, this stream has been written by a DataOutputStream. Types that can be read include byte, 16-bit short, 32-bit int, 32-bit float, 64-bit long, 64-bit double, byte strings, and UTF Strings.

Summary

Fields inherited from class java.io.FilterInputStream

Public Constructors

					DataInputStream(InputStream in)
					Constructs a new DataInputStream on the InputStream `in`.

Public Methods

final		int	read(byte[] buffer, int offset, int length)
			Read at most `length` bytes from this DataInputStream and stores them in byte array `buffer` starting at `offset`.
final		int	read(byte[] buffer)
			Reads bytes from the source stream into the byte array `buffer`.
final		boolean	readBoolean()
			Reads a boolean from this stream.
final		byte	readByte()
			Reads an 8-bit byte value from this stream.
final		char	readChar()
			Reads a 16-bit character value from this stream.
final		double	readDouble()
			Reads a 64-bit `double` value from this stream.
final		float	readFloat()
			Reads a 32-bit `float` value from this stream.
final		void	readFully(byte[] buffer, int offset, int length)
			Reads bytes from this stream and stores them in the byte array `buffer` starting at the position `offset`.
final		void	readFully(byte[] buffer)
			Reads bytes from this stream into the byte array `buffer`.
final		int	readInt()
			Reads a 32-bit integer value from this stream.
final		String	readLine()
			This method is deprecated. Use BufferedReader
final		long	readLong()
			Reads a 64-bit `long` value from this stream.
final		short	readShort()
			Reads a 16-bit `short` value from this stream.
final		String	readUTF()
			Reads a UTF format String from this Stream.
final	static	String	readUTF(DataInput in)
			Reads a UTF format String from the DataInput Stream `in`.
final		int	readUnsignedByte()
			Reads an unsigned 8-bit `byte` value from this stream and returns it as an int.
final		int	readUnsignedShort()
			Reads a 16-bit unsigned `short` value from this stream and returns it as an int.
final		int	skipBytes(int count)
			Skips `count` number of bytes in this stream.

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface java.io.Closeable

Methods inherited from interface java.io.DataInput

readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUTF, readUnsignedByte, readUnsignedShort, skipBytes

				boolean	readBoolean()
					Reads a boolean from this stream.
				byte	readByte()
					Reads an 8-bit byte value from this stream.
				char	readChar()
					Reads a 16-bit character value from this stream.
				double	readDouble()
					Reads a 64-bit `double` value from this stream.
				float	readFloat()
					Reads a 32-bit `float` value from this stream.
				void	readFully(byte[] buffer, int offset, int count)
					Read bytes from this stream and stores them in byte array `buffer` starting at offset `offset`.
				void	readFully(byte[] buffer)
					Reads bytes from this stream into the byte array `buffer`.
				int	readInt()
					Reads a 32-bit integer value from this stream.
				String	readLine()
					Answers a `String` representing the next line of text available in this BufferedReader.
				long	readLong()
					Reads a 64-bit `long` value from this stream.
				short	readShort()
					Reads a 16-bit `short` value from this stream.
				String	readUTF()
					Reads a UTF format String from this Stream.
				int	readUnsignedByte()
					Reads an unsigned 8-bit `byte` value from this stream and returns it as an int.
				int	readUnsignedShort()
					Reads a 16-bit unsigned `short` value from this stream and returns it as an int.
				int	skipBytes(int count)
					Skips `count` number of bytes in this stream.

Details

Public Constructors

public DataInputStream(InputStream in)

Constructs a new DataInputStream on the InputStream in. All reads can now be filtered through this stream. Note that data read by this Stream is not in a human readable format and was most likely created by a DataOutputStream.

Parameters

in	the target InputStream to filter reads on.

Public Methods

public final int read(byte[] buffer, int offset, int length)

Read at most length bytes from this DataInputStream and stores them in byte array buffer starting at offset. Answer the number of bytes actually read or -1 if no bytes were read and end of stream was encountered.

Parameters

buffer	the byte array in which to store the read bytes.
offset	the offset in `buffer` to store the read bytes.
length	the maximum number of bytes to store in `buffer`.

Returns

the number of bytes actually read or -1 if end of stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final int read(byte[] buffer)

Reads bytes from the source stream into the byte array buffer. The number of bytes actually read is returned.

Parameters

buffer	the buffer to read bytes into

Returns

the number of bytes actually read or -1 if end of stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final boolean readBoolean()

Reads a boolean from this stream.

Returns

the next boolean value from the source stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final byte readByte()

Reads an 8-bit byte value from this stream.

Returns

the next byte value from the source stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final char readChar()

Reads a 16-bit character value from this stream.

Returns

the next char value from the source stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final double readDouble()

Reads a 64-bit double value from this stream.

Returns

the next double value from the source stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final float readFloat()

Reads a 32-bit float value from this stream.

Returns

the next float value from the source stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final void readFully(byte[] buffer, int offset, int length)

Reads bytes from this stream and stores them in the byte array buffer starting at the position offset. This method blocks until count bytes have been read.

Parameters

buffer	the byte array into which the data is read
offset	the offset the operation start at
length	the maximum number of bytes to read

Throws

IOException	if a problem occurs while reading from this stream
EOFException	if reaches the end of the stream before enough bytes have been read

public final void readFully(byte[] buffer)

Reads bytes from this stream into the byte array buffer. This method will block until buffer.length number of bytes have been read.

Parameters

buffer	to read bytes into

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final int readInt()

Reads a 32-bit integer value from this stream.

Returns

the next int value from the source stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final String readLine()

This method is deprecated. Use BufferedReader

Answers a String representing the next line of text available in this BufferedReader. A line is represented by 0 or more characters followed by '\n', '\r', "\n\r" or end of stream. The String does not include the newline sequence.

Returns

the contents of the line or null if no characters were read before end of stream.

Throws

IOException	If the DataInputStream is already closed or some other IO error occurs.

public final long readLong()

Reads a 64-bit long value from this stream.

Returns

the next long value from the source stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final short readShort()

Reads a 16-bit short value from this stream.

Returns

the next short value from the source stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final String readUTF()

Reads a UTF format String from this Stream.

Returns

the next UTF String from the source stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public static final String readUTF(DataInput in)

Reads a UTF format String from the DataInput Stream in.

Parameters

in	the input stream to read from

Returns

the next UTF String from the source stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final int readUnsignedByte()

Reads an unsigned 8-bit byte value from this stream and returns it as an int.

Returns

the next unsigned byte value from the source stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final int readUnsignedShort()

Reads a 16-bit unsigned short value from this stream and returns it as an int.

Returns

the next unsigned short value from the source stream.

Throws

IOException	If a problem occurs reading from this DataInputStream.

public final int skipBytes(int count)

Skips count number of bytes in this stream. Subsequent read()'s will not return these bytes unless reset() is used.

Parameters

count	the number of bytes to skip.

Returns

the number of bytes actually skipped.

Throws

IOException	If the stream is already closed or another IOException occurs.

	int	available()
		Answers a int representing the number of bytes that are available before this FilterInputStream will block.
	void	close()
		Close this FilterInputStream.
synchronized	void	mark(int readlimit)
		Set a Mark position in this FilterInputStream.
	boolean	markSupported()
		Answers a boolean indicating whether or not this FilterInputStream supports mark() and reset().
	int	read(byte[] buffer, int offset, int count)
		Reads at most `count` bytes from this FilterInputStream and stores them in byte array `buffer` starting at `offset`.
	int	read(byte[] buffer)
		Reads bytes from this FilterInputStream and stores them in byte array `buffer`.
	int	read()
		Reads a single byte from this FilterInputStream and returns the result as an int.
synchronized	void	reset()
		Reset this FilterInputStream to the last marked location.
	long	skip(long count)
		Skips `count` number of bytes in this InputStream.

		int	available()
			Answers a int representing then number of bytes that are available before this InputStream will block.
		void	close()
			Close the InputStream.
		void	mark(int readlimit)
			Set a Mark position in this InputStream.
		boolean	markSupported()
			Answers a boolean indicating whether or not this InputStream supports mark() and reset().
		int	read(byte[] b, int offset, int length)
			Reads at most `length` bytes from the Stream and stores them in byte array `b` starting at `offset`.
		int	read(byte[] b)
			Reads bytes from the Stream and stores them in byte array `b`.
abstract		int	read()
			Reads a single byte from this InputStream and returns the result as an int.
	synchronized	void	reset()
			Reset this InputStream to the last marked location.
		long	skip(long n)
			Skips `n` number of bytes in this InputStream.

				void	close()
					Close the object and release any system resources it holds.


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

java.io.DataInputStream

See Also

Summary

Fields inherited from class java.io.FilterInputStream

Public Constructors

Public Methods

Methods inherited from class java.io.FilterInputStream

Methods inherited from class java.io.InputStream

Methods inherited from class java.lang.Object

Methods inherited from interface java.io.Closeable

Methods inherited from interface java.io.DataInput

Details

Public Constructors

public DataInputStream(InputStream in)

Parameters

See Also

Public Methods

public final int read(byte[] buffer, int offset, int length)

Parameters

Returns

Throws

See Also

public final int read(byte[] buffer)

Parameters

Returns

Throws

See Also

public final boolean readBoolean()

Returns

Throws

See Also

public final byte readByte()

Returns

Throws

See Also

public final char readChar()

Returns

Throws

See Also

public final double readDouble()

Returns

Throws

See Also

public final float readFloat()

Returns

Throws

See Also

public final void readFully(byte[] buffer, int offset, int length)

Parameters

Throws

See Also

public final void readFully(byte[] buffer)

Parameters

Throws

See Also

public final int readInt()

Returns

Throws

See Also

public final String readLine()

Returns

Throws

public final long readLong()

Returns

Throws

See Also

public final short readShort()

Returns

Throws

See Also

public final String readUTF()

Returns

Throws

See Also

public static final String readUTF(DataInput in)

Parameters

Returns