Class FormatIdInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

java.io.DataInputStream

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

All Implemented Interfaces:

Closeable, DataInput, ObjectInput, AutoCloseable, CloneableStream, ErrorInfo, ErrorObjectInput, Resetable

public final class FormatIdInputStream
extends 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.

Field Summary

Fields

Modifier and Type	Field	Description
protected ClassFactory	cf
private ErrorInfo	errorInfo
private Exception	myNestedException

Fields inherited from class FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
FormatIdInputStream(InputStream in)	Constructor for a FormatIdInputStream

Method Summary

Modifier and Type	Method	Description
InputStream	cloneStream()	Clone the stream.
void	closeStream()	Close.
(package private) ClassFactory	getClassFactory()
private static Context	getContextOrNull(String contextID)	Privileged lookup of a Context.
String	getErrorInfo()
InputStream	getInputStream()
Exception	getNestedException()
private ObjectInputStream	getObjectStream()
private <T extends Throwable> T	handleReadError(T cause, ObjectInputStream stream)	Handle an error that happened within readObject() when reading a Serializable object.
void	initStream()	Initialize.
Object	readObject()	Read an object from this stream.
void	resetStream()	Reset the stream to the beginning.
private void	setErrorInfo(ErrorInfo ei)
void	setInput(InputStream in)	Set the InputStream for this FormatIdInputStream to the stream provided.

Methods inherited from class DataInputStream

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

Methods inherited from class FilterInputStream

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

Methods inherited from class InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class Object

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

Methods inherited from interface DataInput

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

Methods inherited from interface ObjectInput

available, close, read, read, read, skip

Field Details

cf

protected ClassFactory cf

errorInfo

private ErrorInfo errorInfo

myNestedException

private Exception myNestedException

Constructor Details

FormatIdInputStream

public FormatIdInputStream(InputStream in)

Constructor for a FormatIdInputStream

Parameters:

in - bytes come from here.

Method Details

readObject

public Object readObject()
                  throws IOException,
ClassNotFoundException

Read an object from this stream.

Specified by:

readObject in interface ObjectInput

Returns:

The read object.

Throws:

IOException - An IO or serialization error occurred.

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

setInput

public void setInput(InputStream in)

Set the InputStream for this FormatIdInputStream to the stream provided.

Parameters:

in - The new input stream.

getInputStream

public InputStream getInputStream()

getErrorInfo

public String getErrorInfo()

Specified by:

getErrorInfo in interface ErrorInfo

Specified by:

getErrorInfo in interface ErrorObjectInput

getNestedException

public Exception getNestedException()

Specified by:

getNestedException in interface ErrorInfo

Specified by:

getNestedException in interface ErrorObjectInput

setErrorInfo

private void setErrorInfo(ErrorInfo ei)

handleReadError

private <T extends Throwable> T handleReadError(T cause,
 ObjectInputStream stream)

Handle an error that happened within readObject() when reading a Serializable object.

Type Parameters:

T - the type of exception that was thrown

Parameters:

cause - the thrown exception

stream - the stream from which the exception was thrown

Returns:

the thrown exception

getClassFactory

ClassFactory getClassFactory()

getObjectStream

private ObjectInputStream getObjectStream()
                                   throws IOException

Throws:

IOException

resetStream

public void resetStream()
                 throws IOException,
StandardException

Description copied from interface: Resetable

Reset the stream to the beginning.

Specified by:

resetStream in interface Resetable

Throws:

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

getContextOrNull

private static Context getContextOrNull(String contextID)

Privileged lookup of a Context. Must be private so that user code can't call this entry point.