Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.iapi.services.io.FormatIdInputStream

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

Access	Constructor and Description
public	FormatIdInputStream(InputStream bytes come from here. in) Constructor for a FormatIdInputStream

Method Summary

Modifier and Type	Method and Description
public InputStream	cloneStream() Implements org.apache.derby.iapi.services.io.CloneableStream.cloneStream. Clone the stream.
public void	closeStream() Implements org.apache.derby.iapi.types.Resetable.closeStream. Close.
pack-priv ClassFactory	getClassFactory()
private static Context	getContextOrNull(final String contextID) Must be private so that user code can't call this entry point.
public String	getErrorInfo() Implements org.apache.derby.iapi.services.io.ErrorObjectInput.getErrorInfo.
public InputStream	getInputStream()
public Exception	getNestedException() Implements org.apache.derby.iapi.services.io.ErrorObjectInput.getNestedException.
private ObjectInputStream	getObjectStream()
private < the type of exception that was thrown T extends Throwable> T	Returns: the thrown exception handleReadError(T the thrown exception cause, ObjectInputStream the stream from which the exception was thrown stream) Handle an error that happened within `readObject()` when reading a `Serializable` object.
public void	initStream() Implements org.apache.derby.iapi.types.Resetable.initStream. Initialize.
public Object	Returns: The read object. readObject() Implements java.io.ObjectInput.readObject. Read an object from this stream.
public void	resetStream() Implements org.apache.derby.iapi.types.Resetable.resetStream. Reset the stream to the beginning.
private void	setErrorInfo(ErrorInfo ei)
public void	setInput(InputStream The new input stream. in) Set the InputStream for this FormatIdInputStream to the stream provided.

Inherited from java.io.DataInputStream:: read read readBoolean readByte readChar readDouble readFloat readFully readFully readInt readLine readLong readShort readUnsignedByte readUnsignedShort readUTF readUTF skipBytes

cf	back to summary
protected ClassFactory cf

errorInfo	back to summary
private ErrorInfo errorInfo

myNestedException	back to summary
private Exception myNestedException

FormatIdInputStream	back to summary
public FormatIdInputStream(InputStream in) Constructor for a FormatIdInputStream Parameters in:InputStream bytes come from here.

Method Detail

cloneStream back to summary

cloneStream	back to summary
public InputStream cloneStream() Implements org.apache.derby.iapi.services.io.CloneableStream.cloneStream. Doc from org.apache.derby.iapi.services.io.CloneableStream.cloneStream. 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. Returns:InputStream The cloned stream. See Also `CloneableStream#cloneStream()`

public InputStream cloneStream()

Implements org.apache.derby.iapi.services.io.CloneableStream.cloneStream.

Doc from org.apache.derby.iapi.services.io.CloneableStream.cloneStream.

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.

Returns:InputStream: The cloned stream.
See Also: CloneableStream#cloneStream()

closeStream back to summary

closeStream	back to summary
public void closeStream() Implements org.apache.derby.iapi.types.Resetable.closeStream. Doc from org.apache.derby.iapi.types.Resetable.closeStream. Close. Free resources (such as open containers and locks) associated with the stream. See Also `Resetable#closeStream()`

public void closeStream()

Implements org.apache.derby.iapi.types.Resetable.closeStream.

Doc from org.apache.derby.iapi.types.Resetable.closeStream.

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

See Also: Resetable#closeStream()

getClassFactory	back to summary
pack-priv ClassFactory getClassFactory()

getContextOrNull	back to summary
private static Context getContextOrNull(final String contextID) Must be private so that user code can't call this entry point.

getErrorInfo	back to summary
public String getErrorInfo() Implements org.apache.derby.iapi.services.io.ErrorObjectInput.getErrorInfo.

getInputStream	back to summary
public InputStream getInputStream()

getNestedException	back to summary
public Exception getNestedException() Implements org.apache.derby.iapi.services.io.ErrorObjectInput.getNestedException.

getObjectStream	back to summary
private ObjectInputStream getObjectStream() throws IOException

handleReadError back to summary

handleReadError	back to summary
private <T extends Throwable> T handleReadError(T cause, ObjectInputStream stream) Handle an error that happened within `readObject()` when reading a `Serializable` object. Parameters <T> the type of exception that was thrown cause:T the thrown exception stream:ObjectInputStream the stream from which the exception was thrown Returns:T the thrown exception

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

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

Parameters

<T>: the type of exception that was thrown
cause:T: the thrown exception
stream:ObjectInputStream: the stream from which the exception was thrown

Returns:T

the thrown exception

initStream back to summary

initStream	back to summary
public void initStream() throws StandardException Implements org.apache.derby.iapi.types.Resetable.initStream. Doc from org.apache.derby.iapi.types.Resetable.initStream. Initialize. Needs to be called first, before a resetable stream can be used. Exceptions StandardException: on error See Also `Resetable#initStream()`

public void initStream() throws StandardException

Implements org.apache.derby.iapi.types.Resetable.initStream.

Doc from org.apache.derby.iapi.types.Resetable.initStream.

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

Exceptions

StandardException:: on error

See Also

Resetable#initStream()

readObject	back to summary
public Object readObject() throws IOException, ClassNotFoundException Implements java.io.ObjectInput.readObject. Read an object from this stream. Returns:Object The read object. Exceptions IOException: An IO or serialization error occurred. ClassNotFoundException: A class for an object in the stream could not be found.

readObject

back to summary

public Object readObject() throws IOException, ClassNotFoundException

Implements java.io.ObjectInput.readObject.

Read an object from this stream.

Returns:Object

The read object.

Exceptions

IOException:: An IO or serialization error occurred.
ClassNotFoundException:: A class for an object in the stream could not be found.

resetStream back to summary

resetStream	back to summary
public void resetStream() throws IOException, StandardException Implements org.apache.derby.iapi.types.Resetable.resetStream. Doc from org.apache.derby.iapi.types.Resetable.resetStream. Reset the stream to the beginning. Exceptions IOException: on error StandardException: on error See Also `Resetable#resetStream()`

public void resetStream() throws IOException, StandardException

Implements org.apache.derby.iapi.types.Resetable.resetStream.

Doc from org.apache.derby.iapi.types.Resetable.resetStream.

Reset the stream to the beginning.

Exceptions

IOException:: on error
StandardException:: on error

See Also

Resetable#resetStream()

setErrorInfo	back to summary
private void setErrorInfo(ErrorInfo ei)

setInput	back to summary
public void setInput(InputStream in) Set the InputStream for this FormatIdInputStream to the stream provided. Parameters in:InputStream The new input stream.

setInput

back to summary

public void setInput(InputStream in)

Set the InputStream for this FormatIdInputStream to the stream provided.

Parameters

in:InputStream: The new input stream.

public final Class FormatIdInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail