org.apache.derby.iapi.services.io

Class FormatIdInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

java.io.DataInputStream

org.apache.derby.iapi.services.io.FormatIdInputStream

All Implemented Interfaces:

java.io.Closeable, java.io.DataInput, java.io.ObjectInput, java.lang.AutoCloseable, CloneableStream, ErrorObjectInput, Resetable

public final class FormatIdInputStream
extends java.io.DataInputStream
implements ErrorObjectInput, Resetable, CloneableStream

A stream for reading objects with format id tags which was produced by a FormatIdOutputStream.

Please see the documentation for FormatIdOutputStream for information about the streams format and capabilites.

Constructor Summary

Constructors

Constructor and Description
FormatIdInputStream(java.io.InputStream in) Constructor for a FormatIdInputStream

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	cloneStream() Clone the stream.
void	closeStream() Close.
java.lang.String	getErrorInfo()
java.io.InputStream	getInputStream()
java.lang.Exception	getNestedException()
void	initStream() Initialize.
java.lang.Object	readObject() Read an object from this stream.
void	resetStream() Reset the stream to the beginning.
void	setInput(java.io.InputStream in) Set the InputStream for this FormatIdInputStream to the stream provided.

Methods inherited from class java.io.DataInputStream

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

Methods inherited from class java.io.FilterInputStream

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.ObjectInput

available, close, read, read, read, skip

Methods inherited from interface java.io.DataInput

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

Constructor Detail

FormatIdInputStream

public FormatIdInputStream(java.io.InputStream in)

Constructor for a FormatIdInputStream

Parameters:

in - bytes come from here.

Method Detail

readObject

public java.lang.Object readObject()
                            throws java.io.IOException,
                                   java.lang.ClassNotFoundException

Read an object from this stream.

Specified by:

readObject in interface java.io.ObjectInput

Returns:

The read object.

Throws:

java.io.IOException - An IO or serialization error occurred.

java.lang.ClassNotFoundException - A class for an object in the stream could not be found.

setInput

public void setInput(java.io.InputStream in)

Set the InputStream for this FormatIdInputStream to the stream provided.

Parameters:

in - The new input stream.

getInputStream

public java.io.InputStream getInputStream()

getErrorInfo

public java.lang.String getErrorInfo()

Specified by:

getErrorInfo in interface ErrorObjectInput

getNestedException

public java.lang.Exception getNestedException()

Specified by:

getNestedException in interface ErrorObjectInput

resetStream

public void resetStream()
                 throws java.io.IOException,
                        StandardException

Description copied from interface: Resetable

Reset the stream to the beginning.

Specified by:

resetStream in interface Resetable

Throws:

java.io.IOException

StandardException

See Also:

Resetable.resetStream()

initStream

public void initStream()
                throws StandardException

Description copied from interface: Resetable

Initialize. Needs to be called first, before a resetable stream can be used.

Specified by:

initStream in interface Resetable

Throws:

StandardException

See Also:

Resetable.initStream()

closeStream

public void closeStream()

Description copied from interface: Resetable

Close. Free resources (such as open containers and locks) associated with the stream.

Specified by:

closeStream in interface Resetable

See Also:

Resetable.closeStream()

cloneStream

public java.io.InputStream cloneStream()

Description copied from interface: CloneableStream

Clone the stream.

To be used when a "deep" clone of a stream is required rather than multiple references to the same stream.

The resulting clone should support reads, resets, closes which do not affect the original stream source of the clone.

Specified by:

cloneStream in interface CloneableStream

Returns:

The cloned stream.

See Also:

CloneableStream.cloneStream()