FileDocCategorySizeDatePackage
ObjectInput.javaAPI DocJava SE 5 API3057Fri Aug 26 14:57:00 BST 2005java.io

ObjectInput

public interface ObjectInput implements DataInput
ObjectInput extends the DataInput interface to include the reading of objects. DataInput includes methods for the input of primitive types, ObjectInput extends that interface to include objects, arrays, and Strings.
author
unascribed
version
1.19, 12/19/03
see
java.io.InputStream
see
java.io.ObjectOutputStream
see
java.io.ObjectInputStream
since
JDK1.1

Fields Summary
Constructors Summary
Methods Summary
public intavailable()
Returns the number of bytes that can be read without blocking.

return
the number of available bytes.
exception
IOException If an I/O error has occurred.

public voidclose()
Closes the input stream. Must be called to release any resources associated with the stream.

exception
IOException If an I/O error has occurred.

public intread()
Reads a byte of data. This method will block if no input is available.

return
the byte read, or -1 if the end of the stream is reached.
exception
IOException If an I/O error has occurred.

public intread(byte[] b)
Reads into an array of bytes. This method will block until some input is available.

param
b the buffer into which the data is read
return
the actual number of bytes read, -1 is returned when the end of the stream is reached.
exception
IOException If an I/O error has occurred.

public intread(byte[] b, int off, int len)
Reads into an array of bytes. This method will block until some input is available.

param
b the buffer into which the data is read
param
off the start offset of the data
param
len the maximum number of bytes read
return
the actual number of bytes read, -1 is returned when the end of the stream is reached.
exception
IOException If an I/O error has occurred.

public java.lang.ObjectreadObject()
Read and return an object. The class that implements this interface defines where the object is "read" from.

return
the object read from the stream
exception
java.lang.ClassNotFoundException If the class of a serialized object cannot be found.
exception
IOException If any of the usual Input/Output related exceptions occur.

public longskip(long n)
Skips n bytes of input.

param
n the number of bytes to be skipped
return
the actual number of bytes skipped.
exception
IOException If an I/O error has occurred.