java.sql
Interface Blob

All Known Implementing Classes:
SerialBlob sample code for javax.sql.rowset.serial.SerialBlob definition code for javax.sql.rowset.serial.SerialBlob

public interface Blob

The representation (mapping) in the JavaTM programming language of an SQL BLOB value. An SQL BLOB is a built-in type that stores a Binary Large Object as a column value in a row of a database table. By default drivers implement Blob using an SQL locator(BLOB), which means that a Blob object contains a logical pointer to the SQL BLOB data rather than the data itself. A Blob object is valid for the duration of the transaction in which is was created.

Methods in the interfaces ResultSet sample code for java.sql.ResultSet definition code for java.sql.ResultSet , CallableStatement sample code for java.sql.CallableStatement definition code for java.sql.CallableStatement , and PreparedStatement sample code for java.sql.PreparedStatement definition code for java.sql.PreparedStatement , such as getBlob and setBlob allow a programmer to access an SQL BLOB value. The Blob interface provides methods for getting the length of an SQL BLOB (Binary Large Object) value, for materializing a BLOB value on the client, and for determining the position of a pattern of bytes within a BLOB value. In addition, this interface has methods for updating a BLOB value.

Since:
1.2

Method Summary
 InputStream sample code for java.io.InputStream definition code for java.io.InputStream getBinaryStream sample code for java.sql.Blob.getBinaryStream() definition code for java.sql.Blob.getBinaryStream() ()
          Retrieves the BLOB value designated by this Blob instance as a stream.
 byte[] getBytes sample code for java.sql.Blob.getBytes(long, int) definition code for java.sql.Blob.getBytes(long, int) (long pos, int length)
          Retrieves all or part of the BLOB value that this Blob object represents, as an array of bytes.
 long length sample code for java.sql.Blob.length() definition code for java.sql.Blob.length() ()
          Returns the number of bytes in the BLOB value designated by this Blob object.
 long position sample code for java.sql.Blob.position(java.sql.Blob, long) definition code for java.sql.Blob.position(java.sql.Blob, long) (Blob sample code for java.sql.Blob definition code for java.sql.Blob  pattern, long start)
          Retrieves the byte position in the BLOB value designated by this Blob object at which pattern begins.
 long position sample code for java.sql.Blob.position(byte[], long) definition code for java.sql.Blob.position(byte[], long) (byte[] pattern, long start)
          Retrieves the byte position at which the specified byte array pattern begins within the BLOB value that this Blob object represents.
 OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream setBinaryStream sample code for java.sql.Blob.setBinaryStream(long) definition code for java.sql.Blob.setBinaryStream(long) (long pos)
          Retrieves a stream that can be used to write to the BLOB value that this Blob object represents.
 int setBytes sample code for java.sql.Blob.setBytes(long, byte[]) definition code for java.sql.Blob.setBytes(long, byte[]) (long pos, byte[] bytes)
          Writes the given array of bytes to the BLOB value that this Blob object represents, starting at position pos, and returns the number of bytes written.
 int setBytes sample code for java.sql.Blob.setBytes(long, byte[], int, int) definition code for java.sql.Blob.setBytes(long, byte[], int, int) (long pos, byte[] bytes, int offset, int len)
          Writes all or part of the given byte array to the BLOB value that this Blob object represents and returns the number of bytes written.
 void truncate sample code for java.sql.Blob.truncate(long) definition code for java.sql.Blob.truncate(long) (long len)
          Truncates the BLOB value that this Blob object represents to be len bytes in length.
 

Method Detail

length sample code for java.sql.Blob.length() definition code for java.sql.Blob.length()

long length()
            throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Returns the number of bytes in the BLOB value designated by this Blob object.

Returns:
length of the BLOB in bytes
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the length of the BLOB
Since:
1.2

getBytes sample code for java.sql.Blob.getBytes(long, int) definition code for java.sql.Blob.getBytes(long, int)

byte[] getBytes(long pos,
                int length)
                throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Retrieves all or part of the BLOB value that this Blob object represents, as an array of bytes. This byte array contains up to length consecutive bytes starting at position pos.

Parameters:
pos - the ordinal position of the first byte in the BLOB value to be extracted; the first byte is at position 1
length - the number of consecutive bytes to be copied
Returns:
a byte array containing up to length consecutive bytes from the BLOB value designated by this Blob object, starting with the byte at position pos
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the BLOB value
Since:
1.2
See Also:
setBytes(long, byte[]) sample code for java.sql.Blob.setBytes(long, byte[]) definition code for java.sql.Blob.setBytes(long, byte[])

getBinaryStream sample code for java.sql.Blob.getBinaryStream() definition code for java.sql.Blob.getBinaryStream()

InputStream sample code for java.io.InputStream definition code for java.io.InputStream  getBinaryStream()
                            throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Retrieves the BLOB value designated by this Blob instance as a stream.

Returns:
a stream containing the BLOB data
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the BLOB value
Since:
1.2
See Also:
setBinaryStream(long) sample code for java.sql.Blob.setBinaryStream(long) definition code for java.sql.Blob.setBinaryStream(long)

position sample code for java.sql.Blob.position(byte[], long) definition code for java.sql.Blob.position(byte[], long)

long position(byte[] pattern,
              long start)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Retrieves the byte position at which the specified byte array pattern begins within the BLOB value that this Blob object represents. The search for pattern begins at position start.

Parameters:
pattern - the byte array for which to search
start - the position at which to begin searching; the first position is 1
Returns:
the position at which the pattern appears, else -1
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the BLOB
Since:
1.2

position sample code for java.sql.Blob.position(java.sql.Blob, long) definition code for java.sql.Blob.position(java.sql.Blob, long)

long position(Blob sample code for java.sql.Blob definition code for java.sql.Blob  pattern,
              long start)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Retrieves the byte position in the BLOB value designated by this Blob object at which pattern begins. The search begins at position start.

Parameters:
pattern - the Blob object designating the BLOB value for which to search
start - the position in the BLOB value at which to begin searching; the first position is 1
Returns:
the position at which the pattern begins, else -1
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the BLOB value
Since:
1.2

setBytes sample code for java.sql.Blob.setBytes(long, byte[]) definition code for java.sql.Blob.setBytes(long, byte[])

int setBytes(long pos,
             byte[] bytes)
             throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Writes the given array of bytes to the BLOB value that this Blob object represents, starting at position pos, and returns the number of bytes written.

Parameters:
pos - the position in the BLOB object at which to start writing
bytes - the array of bytes to be written to the BLOB value that this Blob object represents
Returns:
the number of bytes written
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the BLOB value
Since:
1.4
See Also:
getBytes(long, int) sample code for java.sql.Blob.getBytes(long, int) definition code for java.sql.Blob.getBytes(long, int)

setBytes sample code for java.sql.Blob.setBytes(long, byte[], int, int) definition code for java.sql.Blob.setBytes(long, byte[], int, int)

int setBytes(long pos,
             byte[] bytes,
             int offset,
             int len)
             throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Writes all or part of the given byte array to the BLOB value that this Blob object represents and returns the number of bytes written. Writing starts at position pos in the BLOB value; len bytes from the given byte array are written.

Parameters:
pos - the position in the BLOB object at which to start writing
bytes - the array of bytes to be written to this BLOB object
offset - the offset into the array bytes at which to start reading the bytes to be set
len - the number of bytes to be written to the BLOB value from the array of bytes bytes
Returns:
the number of bytes written
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the BLOB value
Since:
1.4
See Also:
getBytes(long, int) sample code for java.sql.Blob.getBytes(long, int) definition code for java.sql.Blob.getBytes(long, int)

setBinaryStream sample code for java.sql.Blob.setBinaryStream(long) definition code for java.sql.Blob.setBinaryStream(long)

OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream  setBinaryStream(long pos)
                             throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Retrieves a stream that can be used to write to the BLOB value that this Blob object represents. The stream begins at position pos.

Parameters:
pos - the position in the BLOB value at which to start writing
Returns:
a java.io.OutputStream object to which data can be written
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the BLOB value
Since:
1.4
See Also:
getBinaryStream() sample code for java.sql.Blob.getBinaryStream() definition code for java.sql.Blob.getBinaryStream()

truncate sample code for java.sql.Blob.truncate(long) definition code for java.sql.Blob.truncate(long)

void truncate(long len)
              throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException 
Truncates the BLOB value that this Blob object represents to be len bytes in length.

Parameters:
len - the length, in bytes, to which the BLOB value that this Blob object represents should be truncated
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if there is an error accessing the BLOB value
Since:
1.4