java.sql
public
interface
java.sql.Blob
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.
Summary
Details
Public Methods
public
InputStream
getBinaryStream()
Retrieves this Blob object as a binary stream.
Returns
- a binary InputStream giving access to the Blob data
public
byte[]
getBytes(long pos, int length)
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 the
first byte in the Blob has position = 1 |
length
| the number of bytes to get |
Returns
- a byte array containing the data from the Blob, starting at pos
and of length up to
length
bytes long
public
long
length()
Gets the number of bytes in this Blob object.
Returns
- an long value with the length of the Blob in bytes
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 in
this Blob |
start
| the position within this Blob to start the search, where the
first position in the Blob is 1 |
Returns
- a long value with the position at which the pattern begins. -1 if
the pattern is not found in this Blob.
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 this
Blob |
start
| the position within this Blob to start the search, where the
first position in the Blob is 1 |
Returns
- a long value with the position at which the pattern begins. -1 if
the pattern is not found in this Blob.
public
OutputStream
setBinaryStream(long pos)
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, where
the first position in the Blob is 1 |
Returns
- a binary InputStream which can be used to write data into the
Blob starting at the specified position.
public
int
setBytes(long pos, byte[] theBytes, int offset, int len)
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, 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, as the number of bytes |
Returns
- an integer containing the number of bytes written to the Blob
public
int
setBytes(long pos, byte[] theBytes)
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, where
the first position in the Blob is 1 |
theBytes
| an array of bytes to write into the Blob |
Returns
- an integer containing the number of bytes written to the Blob
public
void
truncate(long len)
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 |