Package org.firebirdsql.jdbc
Class FBBlob
- java.lang.Object
- 
- org.firebirdsql.jdbc.FBBlob
 
- 
- All Implemented Interfaces:
- java.sql.Blob,- TransactionListener,- FirebirdBlob,- Synchronizable
 
 public class FBBlob extends java.lang.Object implements FirebirdBlob, TransactionListener, Synchronizable Firebird implementation ofBlob.
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from interface org.firebirdsql.jdbc.FirebirdBlobFirebirdBlob.BlobInputStream, FirebirdBlob.BlobOutputStream
 
- 
 - 
Field SummaryFields Modifier and Type Field Description static booleanSEGMENTED
 - 
Constructor SummaryConstructors Constructor Description FBBlob(GDSHelper c)Create new Blob instance.FBBlob(GDSHelper c, long blob_id)Create instance of this class to access existing Blob.FBBlob(GDSHelper c, long blob_id, FBObjectListener.BlobListener blobListener)Create instance of this class to access existing Blob.FBBlob(GDSHelper c, FBObjectListener.BlobListener blobListener)Create new Blob instance.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcopyBytes(byte[] bytes, int pos, int len)voidcopyCharacterStream(java.io.Reader reader, long length, Encoding encoding)Copy data from a character stream into this Blob.voidcopyCharacterStream(java.io.Reader reader, Encoding encoding)Copy data from a character stream into this Blob.voidcopyStream(java.io.InputStream inputStream)Copy the contents of anInputStreaminto this Blob.voidcopyStream(java.io.InputStream inputStream, long length)Copy the contents of anInputStreaminto this Blob.FirebirdBlobdetach()Detach this blob.voidfree()java.io.InputStreamgetBinaryStream()java.io.InputStreamgetBinaryStream(long pos, long length)longgetBlobId()Get the identifier for thisBlobbyte[]getBytes(long pos, int length)GDSHelpergetGdsHelper()byte[]getInfo(byte[] items, int buffer_length)Get information about this Blob.java.lang.ObjectgetSynchronizationObject()Get synchronization object.booleanisSegmented()Check if blob is segmented.longlength()longposition(byte[] pattern, long start)longposition(java.sql.Blob pattern, long start)java.io.OutputStreamsetBinaryStream(long pos)intsetBytes(long pos, byte[] bytes)intsetBytes(long pos, byte[] bytes, int offset, int len)voidtransactionStateChanged(FbTransaction transaction, TransactionState newState, TransactionState previousState)Signals that the transaction state changed.voidtruncate(long len)
 
- 
- 
- 
Field Detail- 
SEGMENTEDpublic static final boolean SEGMENTED - See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
FBBlobpublic FBBlob(GDSHelper c, FBObjectListener.BlobListener blobListener) Create new Blob instance. This constructor creates new fresh Blob, only writing to the Blob is allowed.- Parameters:
- c- connection that will be used to write data to blob
- blobListener- Blob listener instance
 
 - 
FBBlobpublic FBBlob(GDSHelper c) Create new Blob instance. This constructor creates new fresh Blob, only writing to the Blob is allowed.- Parameters:
- c- connection that will be used to write data to blob.
 
 - 
FBBlobpublic FBBlob(GDSHelper c, long blob_id, FBObjectListener.BlobListener blobListener) Create instance of this class to access existing Blob.- Parameters:
- c- connection that will be used to access Blob.
- blob_id- ID of the Blob.
- blobListener- Blob listener instance
 
 - 
FBBlobpublic FBBlob(GDSHelper c, long blob_id) Create instance of this class to access existing Blob.- Parameters:
- c- connection that will be used to access Blob.
- blob_id- ID of the Blob.
 
 
- 
 - 
Method Detail- 
getSynchronizationObjectpublic final java.lang.Object getSynchronizationObject() Description copied from interface:SynchronizableGet synchronization object.- Specified by:
- getSynchronizationObjectin interface- Synchronizable
- Returns:
- object, cannot be null.
 
 - 
freepublic void free() throws java.sql.SQLException- Specified by:
- freein interface- java.sql.Blob
- Throws:
- java.sql.SQLException
 
 - 
getBinaryStreampublic java.io.InputStream getBinaryStream(long pos, long length) throws java.sql.SQLException- Specified by:
- getBinaryStreamin interface- java.sql.Blob
- Throws:
- java.sql.SQLException
 
 - 
getInfopublic byte[] getInfo(byte[] items, int buffer_length) throws java.sql.SQLExceptionGet information about this Blob. This method should be considered as temporary because it provides access to low-level API. More information on how to use the API can be found in "API Guide".- Parameters:
- items- items in which we are interested.
- buffer_length- buffer where information will be stored.
- Returns:
- array of bytes containing information about this Blob.
- Throws:
- java.sql.SQLException- if something went wrong.
 
 - 
lengthpublic long length() throws java.sql.SQLException- Specified by:
- lengthin interface- java.sql.Blob
- Throws:
- java.sql.SQLException
 
 - 
isSegmentedpublic boolean isSegmented() throws java.sql.SQLExceptionDescription copied from interface:FirebirdBlobCheck if blob is segmented. If Blob is segmented, you cannot useFirebirdBlob.BlobInputStream.seek(int)method.- Specified by:
- isSegmentedin interface- FirebirdBlob
- Returns:
- trueif this blob is segmented, otherwise- false
- Throws:
- java.sql.SQLException
 
 - 
detachpublic FirebirdBlob detach() throws java.sql.SQLException Description copied from interface:FirebirdBlobDetach this blob. This method creates new instance of the same blob database object that is not under result set control. When result set is closed, all associated resources are also released, including open blob streams. This method creates an new instance of blob object with the same blob ID that can be used even when result set is closed.Note, detached blob will not remember the stream position of this object. This means that you cannot start reading data from the blob, then detach it, and then continue reading. Reading from detached blob will begin at the blob start. - Specified by:
- detachin interface- FirebirdBlob
- Returns:
- instance of FirebirdBlobthat is not under result set control.
- Throws:
- java.sql.SQLException- if Blob cannot be detached.
 
 - 
getBytespublic byte[] getBytes(long pos, int length) throws java.sql.SQLException- Specified by:
- getBytesin interface- java.sql.Blob
- Throws:
- java.sql.SQLException
 
 - 
getBinaryStreampublic java.io.InputStream getBinaryStream() throws java.sql.SQLException- Specified by:
- getBinaryStreamin interface- java.sql.Blob
- Throws:
- java.sql.SQLException
 
 - 
positionpublic long position(byte[] pattern, long start) throws java.sql.SQLException- Specified by:
- positionin interface- java.sql.Blob
- Throws:
- java.sql.SQLException
 
 - 
positionpublic long position(java.sql.Blob pattern, long start) throws java.sql.SQLException- Specified by:
- positionin interface- java.sql.Blob
- Throws:
- java.sql.SQLException
 
 - 
truncatepublic void truncate(long len) throws java.sql.SQLException- Specified by:
- truncatein interface- java.sql.Blob
- Throws:
- java.sql.SQLException
 
 - 
setBytespublic int setBytes(long pos, byte[] bytes) throws java.sql.SQLException- Specified by:
- setBytesin interface- java.sql.Blob
- Throws:
- java.sql.SQLException
 
 - 
setBytespublic int setBytes(long pos, byte[] bytes, int offset, int len) throws java.sql.SQLException- Specified by:
- setBytesin interface- java.sql.Blob
- Throws:
- java.sql.SQLException
 
 - 
setBinaryStreampublic java.io.OutputStream setBinaryStream(long pos) throws java.sql.SQLException- Specified by:
- setBinaryStreamin interface- java.sql.Blob
- Throws:
- java.sql.SQLException
 
 - 
getBlobIdpublic long getBlobId() throws java.sql.SQLExceptionGet the identifier for thisBlob- Returns:
- This Blob's identifier
- Throws:
- java.sql.SQLException- if a database access error occurs
 
 - 
copyBytespublic void copyBytes(byte[] bytes, int pos, int len) throws java.sql.SQLException- Throws:
- java.sql.SQLException
 
 - 
getGdsHelperpublic GDSHelper getGdsHelper() 
 - 
copyStreampublic void copyStream(java.io.InputStream inputStream, long length) throws java.sql.SQLExceptionCopy the contents of anInputStreaminto this Blob.Calling with length -1is equivalent to callingcopyStream(InputStream), and will copy the whole stream.- Parameters:
- inputStream- the stream from which data will be copied
- length- The maximum number of bytes to read from the InputStream,- -1to read whole stream
- Throws:
- java.sql.SQLException- if a database access error occurs
 
 - 
copyStreampublic void copyStream(java.io.InputStream inputStream) throws java.sql.SQLExceptionCopy the contents of anInputStreaminto this Blob. Unlike thecopyStream(InputStream, long)method, this one copies bytes until the EOF is reached.- Parameters:
- inputStream- the stream from which data will be copied
- Throws:
- java.sql.SQLException- if a database access error occurs
 
 - 
copyCharacterStreampublic void copyCharacterStream(java.io.Reader reader, long length, Encoding encoding) throws java.sql.SQLExceptionCopy data from a character stream into this Blob.Calling with length -1is equivalent to callingcopyCharacterStream(Reader, Encoding).- Parameters:
- reader- the source of data to copy
- length- The maximum number of bytes to copy, or- -1to read the whole stream
- encoding- The encoding used in the character stream
- Throws:
- java.sql.SQLException
 
 - 
copyCharacterStreampublic void copyCharacterStream(java.io.Reader reader, Encoding encoding) throws java.sql.SQLExceptionCopy data from a character stream into this Blob. Unlike thecopyCharacterStream(Reader, long, Encoding))} method, this one copies bytes until the EOF is reached.- Parameters:
- reader- the source of data to copy
- encoding- The encoding used in the character stream
- Throws:
- java.sql.SQLException
 
 - 
transactionStateChangedpublic void transactionStateChanged(FbTransaction transaction, TransactionState newState, TransactionState previousState) Description copied from interface:TransactionListenerSignals that the transaction state changed.- Specified by:
- transactionStateChangedin interface- TransactionListener
- Parameters:
- transaction-- FbTransactionthat changed state
 
 
- 
 
-