public interface Blob
BLOB type.
An SQL BLOB type stores a large array of binary data (bytes) 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 Blob data length,
and for searching for data within the Blob.
| Modifier and Type | Method and Description |
|---|---|
void |
free()
Frees any resources held by this blob.
|
InputStream |
getBinaryStream()
Retrieves this
Blob object as a binary stream. |
InputStream |
getBinaryStream(long pos,
long length)
Retrieves
length bytes from this Blob, starting at 1-based
offset pos, and returns them as a binary stream. |
byte[] |
getBytes(long pos,
int length)
Gets a portion of the value of this
Blob as an array of bytes. |
long |
length()
Gets the number of bytes in this
Blob object. |
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. |
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. |
OutputStream |
setBinaryStream(long pos)
Gets a stream that can be used to write binary data to this
Blob. |
int |
setBytes(long pos,
byte[] theBytes)
Writes a specified array of bytes to this
Blob object, starting
at a specified position. |
int |
setBytes(long pos,
byte[] theBytes,
int offset,
int len)
Writes a portion of a specified byte array to this
Blob. |
void |
truncate(long len)
Truncate the value of this
Blob object to a specified length in
bytes. |
InputStream getBinaryStream() throws SQLException
Blob object as a binary stream.InputStream giving access to the Blob
data.SQLException - if an error occurs accessing the Blob.InputStream getBinaryStream(long pos, long length) throws SQLException
length bytes from this Blob, starting at 1-based
offset pos, and returns them as a binary stream.InputStream giving access to the Blob
data.SQLException - if an error occurs accessing the Blob.byte[] getBytes(long pos,
int length)
throws SQLException
Blob as an array of bytes.pos - the position of the first byte in the Blob to get,
where the first byte in the Blob has position 1.length - the number of bytes to get.Blob, starting
at pos and is up to length bytes long.SQLException - if an error occurs accessing the Blob.long length()
throws SQLException
Blob object.long value with the length of the Blob in
bytes.SQLException - if an error occurs accessing the Blob.long position(Blob pattern, long start) throws SQLException
Blob at which a specified pattern
begins, starting at a specified position within the Blob.pattern - a Blob containing the pattern of data to search for in
this Blob.start - the position within this Blob to start the search,
where the first position in the Blob is 1.long value with the position at which the pattern
begins. Returns -1 if the pattern is not found in this
Blob.SQLException - if an error occurs accessing the Blob.long position(byte[] pattern,
long start)
throws SQLException
Blob at which the specified
pattern begins, starting at a specified position within the Blob.pattern - a byte array containing the pattern of data to search for in
this Blob.start - the position within this Blob to start the search,
where the first position in the Blob is 1.long value with the position at which the pattern
begins. Returns -1 if the pattern is not found in this
Blob.SQLException - if an error occurs accessing the Blob.OutputStream setBinaryStream(long pos) throws SQLException
Blob.pos - the position within this Blob at which to start
writing, where the first position in the Blob is
1.InputStream which can be used to write data into
the Blob starting at the specified position.SQLException - if an error occurs accessing the Blob.int setBytes(long pos,
byte[] theBytes)
throws SQLException
Blob object, starting
at a specified position. Returns the number of bytes written.pos - the position within this Blob at which to start
writing, where the first position in the Blob is
1.theBytes - an array of bytes to write into the Blob.Blob.SQLException - if an error occurs accessing the Blob.int setBytes(long pos,
byte[] theBytes,
int offset,
int len)
throws SQLException
Blob. Returns
the number of bytes written.pos - the position within this Blob at which to start
writing, where the first position in the Blob is
1.theBytes - an array of bytes to write into the Blob.offset - the offset into the byte array from which to start writing
data - the first byte in the array has offset 0.len - the length of data to write in number of bytes.Blob.SQLException - if an error occurs accessing the Blob.void truncate(long len)
throws SQLException
Blob object to a specified length in
bytes.len - the length of data in bytes after which this Blob
is to be truncated.SQLException - if an error occurs accessing the Blob.void free()
throws SQLException
free is called, calling
method other than free will throw SQLException (calling free
repeatedly will do nothing).SQLException