org.apache.derby.iapi.services.io
Interface StreamStorable

All Known Subinterfaces:
BitDataValue
All Known Implementing Classes:
CollatorSQLChar, CollatorSQLClob, CollatorSQLLongvarchar, CollatorSQLVarchar, SQLBinary, SQLBit, SQLBlob, SQLChar, SQLClob, SQLLongVarbit, SQLLongvarchar, SQLVarbit, SQLVarchar, XML

public interface StreamStorable

Streaming interface for a data value. The format of the stream is data type dependent and represents the on-disk format of the value. That is it is different to the value an application will see through JDBC with methods like getBinaryStream and getAsciiStream.
If the value is NULL (DataValueDescriptor.isNull returns true then these methods should not be used to get the value.

See Also:
Formatable

Method Summary
 void loadStream()
          Set the value by reading the stream and converting it to an object form.
 java.io.InputStream returnStream()
          Return the on-disk stream state of the object.
 void setStream(java.io.InputStream newStream)
          sets the on-disk stream state for the object.
 

Method Detail

returnStream

java.io.InputStream returnStream()
Return the on-disk stream state of the object.


setStream

void setStream(java.io.InputStream newStream)
sets the on-disk stream state for the object.


loadStream

void loadStream()
                throws StandardException
Set the value by reading the stream and converting it to an object form.

Throws:
StandardException - on error

Built on Thu 2010-12-23 20:49:13+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.