| java.sql.Blob
| Blob | | public interface Blob (Code) | | A Java interface mapping for the SQL BLOB type.
An SQL CLOB type stores a large array of bytes (binary data) as the value in
a column of a database.
The java.sql.Blob interface provides methods for setting and retrieving data
in the Blob, for querying Clob data length, for searching for data within the
Blob.
|
| Method Summary | |
| public InputStream | getBinaryStream()
Retrieves this Blob object as a binary stream. | | public byte[] | getBytes(long pos, int length)
Gets a portion of the value of this Blob as an array of bytes. | | public long | length()
Gets the number of bytes in this Blob object. | | public long | position(Blob pattern, long start)
Search for the position in this Blob at which a specified pattern begins,
starting at a specified position within the Blob.
Parameters:
pattern - a Blob containing the pattern of data to search for in thisBlob
Parameters:
start - the position within this Blob to start the search, where thefirst position in the Blob is 1 a long value with the position at which the pattern begins. | | public long | position(byte[] pattern, long start)
Search for the position in this Blob at which the specified pattern
begins, starting at a specified position within the Blob.
Parameters:
pattern - a byte array containing the pattern of data to search for inthis Blob
Parameters:
start - the position within this Blob to start the search, where thefirst position in the Blob is 1 a long value with the position at which the pattern begins. | | public OutputStream | setBinaryStream(long pos)
Gets a stream that can be used to write binary data to this Blob. | | public int | setBytes(long pos, byte[] theBytes)
Writes a specified array of bytes to this Blob. | | public int | setBytes(long pos, byte[] theBytes, int offset, int len)
Writes a portion of a specified byte array to this Blob. | | public void | truncate(long len)
Truncate the value of this Blob object to a specified length in bytes. |
| getBinaryStream | | public InputStream getBinaryStream() throws SQLException(Code) | | Retrieves this Blob object as a binary stream.
a binary InputStream giving access to the Blob data
throws:
SQLException - if an error occurs accessing the Blob |
| getBytes | | public byte[] getBytes(long pos, int length) throws SQLException(Code) | | Gets a portion of the value of this Blob as an array of bytes.
Parameters:
pos - the position of the first byte in the Blob to get, where thefirst byte in the Blob has position = 1
Parameters:
length - the number of bytes to get a byte array containing the data from the Blob, starting at posand of length up to length bytes long
throws:
SQLException - if an error occurs accessing the Blob |
| length | | public long length() throws SQLException(Code) | | Gets the number of bytes in this Blob object.
an long value with the length of the Blob in bytes
throws:
SQLException - if an error occurs accessing the Blob |
| position | | public long position(Blob pattern, long start) throws SQLException(Code) | | Search for the position in this Blob at which a specified pattern begins,
starting at a specified position within the Blob.
Parameters:
pattern - a Blob containing the pattern of data to search for in thisBlob
Parameters:
start - the position within this Blob to start the search, where thefirst position in the Blob is 1 a long value with the position at which the pattern begins. -1 ifthe pattern is not found in this Blob.
throws:
SQLException - if an error occurs accessing the Blob |
| position | | public long position(byte[] pattern, long start) throws SQLException(Code) | | Search for the position in this Blob at which the specified pattern
begins, starting at a specified position within the Blob.
Parameters:
pattern - a byte array containing the pattern of data to search for inthis Blob
Parameters:
start - the position within this Blob to start the search, where thefirst position in the Blob is 1 a long value with the position at which the pattern begins. -1 ifthe pattern is not found in this Blob.
throws:
SQLException - if an error occurs accessing the Blob |
| setBinaryStream | | public OutputStream setBinaryStream(long pos) throws SQLException(Code) | | Gets a stream that can be used to write binary data to this Blob.
Parameters:
pos - the position within this Blob at which to start writing, wherethe first position in the Blob is 1 a binary InputStream which can be used to write data into theBlob starting at the specified position.
throws:
SQLException - if an error occurs accessing the Blob |
| setBytes | | public int setBytes(long pos, byte[] theBytes) throws SQLException(Code) | | Writes a specified array of bytes to this Blob. object, starting at a
specified position. Returns the number of bytes written.
Parameters:
pos - the position within this Blob at which to start writing, wherethe first position in the Blob is 1
Parameters:
theBytes - an array of bytes to write into the Blob an integer containing the number of bytes written to the Blob
throws:
SQLException - if an error occurs accessing the Blob |
| setBytes | | public int setBytes(long pos, byte[] theBytes, int offset, int len) throws SQLException(Code) | | Writes a portion of a specified byte array to this Blob. Returns the
number of bytes written.
Parameters:
pos - the position within this Blob at which to start writing, wherethe first position in the Blob is 1
Parameters:
theBytes - an array of bytes to write into the Blob
Parameters:
offset - the offset into the byte array from which to start writingdata - the first byte in the array has offset 0.
Parameters:
len - the length of data to write, as the number of bytes an integer containing the number of bytes written to the Blob
throws:
SQLException - if an error occurs accessing the Blob |
| truncate | | public void truncate(long len) throws SQLException(Code) | | Truncate the value of this Blob object to a specified length in bytes.
Parameters:
len - the length of data in bytes to truncate the value of this Blob
throws:
SQLException - if an error occurs accessing the Blob |
|
|