|
Préférences
Moteurs de recherche
|
|||||||||||||||||||||||||||||||
JavaTM 2 Platform Std. Ed. v1.6.0
javax.sql.rowset.serial
|
Constructor Summary | |
---|---|
SerialBlob(Blob blob)
Constructs a SerialBlob object that is a serialized
version of the given Blob object. |
|
SerialBlob(byte[] b)
Constructs a SerialBlob object that is a serialized version of
the given byte array. |
Method Summary | |
---|---|
void |
free()
This method frees the Blob object and releases the resources that it holds. |
InputStream |
getBinaryStream()
Returns this SerialBlob object as an input stream. |
InputStream |
getBinaryStream(long pos,
long length)
Returns an InputStream object that contains a partial Blob value,
starting with the byte specified by pos, which is length bytes in length. |
byte[] |
getBytes(long pos,
int length)
Copies the specified number of bytes, starting at the given position, from this SerialBlob object to
another array of bytes. |
long |
length()
Retrieves the number of bytes in this SerialBlob
object's array of bytes. |
long |
position(Blob pattern,
long start)
Returns the position in this SerialBlob object where
the given Blob object begins, starting the search at the
specified position. |
long |
position(byte[] pattern,
long start)
Returns the position in this SerialBlob object where
the given pattern of bytes begins, starting the search at the
specified position. |
OutputStream |
setBinaryStream(long pos)
Retrieves a stream that can be used to write to the BLOB
value that this Blob object represents. |
int |
setBytes(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(long pos,
byte[] bytes,
int offset,
int length)
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(long length)
Truncates the BLOB value that this Blob
object represents to be len bytes in length. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SerialBlob(byte[] b) throws SerialException, SQLException
SerialBlob
object that is a serialized version of
the given byte
array.
The new SerialBlob
object is initialized with the data from the
byte
array, thus allowing disconnected RowSet
objects to establish serialized Blob
objects without
touching the data source.
b
- the byte
array containing the data for the
Blob
object to be serialized
SerialException
- if an error occurs during serialization
SQLException
- if a SQL errors occurspublic SerialBlob(Blob blob) throws SerialException, SQLException
SerialBlob
object that is a serialized
version of the given Blob
object.
The new SerialBlob
object is initialized with the
data from the Blob
object; therefore, the
Blob
object should have previously brought the
SQL BLOB
value's data over to the client from
the database. Otherwise, the new SerialBlob
object
will contain no data.
blob
- the Blob
object from which this
SerialBlob
object is to be constructed;
cannot be null.
SerialException
- if an error occurs during serialization
SQLException
- if the Blob
passed to this
to this constructor is a null
.Blob
Method Detail |
---|
public byte[] getBytes(long pos, int length) throws SerialException
SerialBlob
object to
another array of bytes.
Note that if the given number of bytes to be copied is larger than
the length of this SerialBlob
object's array of
bytes, the given number will be shortened to the array's length.
pos
- the ordinal position of the first byte in this
SerialBlob
object to be copied;
numbering starts at 1
; must not be less
than 1
and must be less than or equal
to the length of this SerialBlob
objectlength
- the number of bytes to be copied
SerialBlob
object, starting at the given
position and containing the given number of consecutive bytes
SerialException
- if the given starting position is out of boundsBlob.setBytes(long, byte[])
public long length() throws SerialException
SerialBlob
object's array of bytes.
long
indicating the length in bytes of this
SerialBlob
object's array of bytes
SerialException
- if an error occurspublic InputStream getBinaryStream() throws SerialException
SerialBlob
object as an input stream.
Unlike the related method, setBinaryStream
,
a stream is produced regardless of whether the SerialBlob
was created with a Blob
object or a byte
array.
getBinaryStream
in interface Blob
java.io.InputStream
object that contains
this SerialBlob
object's array of bytes
SerialException
- if an error occurssetBinaryStream(long)
public long position(byte[] pattern, long start) throws SerialException, SQLException
SerialBlob
object where
the given pattern of bytes begins, starting the search at the
specified position.
pattern
- the pattern of bytes for which to searchstart
- the position of the byte in this
SerialBlob
object from which to begin
the search; the first position is 1
;
must not be less than 1
nor greater than
the length of this SerialBlob
object
SerialBlob
object
where the given pattern begins, starting at the specified
position; -1
if the pattern is not found
or the given starting position is out of bounds; position
numbering for the return value starts at 1
SerialException
- if an error occurs when serializing the blob
SQLException
- if there is an error accessing the BLOB
value from the databasepublic long position(Blob pattern, long start) throws SerialException, SQLException
SerialBlob
object where
the given Blob
object begins, starting the search at the
specified position.
pattern
- the Blob
object for which to search;start
- the position of the byte in this
SerialBlob
object from which to begin
the search; the first position is 1
;
must not be less than 1
nor greater than
the length of this SerialBlob
object
SerialBlob
object
where the given Blob
object begins, starting
at the specified position; -1
if the pattern is
not found or the given starting position is out of bounds;
position numbering for the return value starts at 1
SerialException
- if an error occurs when serializing the blob
SQLException
- if there is an error accessing the BLOB
value from the databasepublic int setBytes(long pos, byte[] bytes) throws SerialException, SQLException
BLOB
value that
this Blob
object represents, starting at position
pos
, and returns the number of bytes written.
pos
- the position in the SQL BLOB
value at which
to start writing. The first position is 1
;
must not be less than 1
nor greater than
the length of this SerialBlob
object.bytes
- the array of bytes to be written to the BLOB
value that this Blob
object represents
SerialException
- if there is an error accessing the
BLOB
value; or if an invalid position is set; if an
invalid offset value is set
SQLException
- if there is an error accessing the BLOB
value from the databasegetBytes(long, int)
public int setBytes(long pos, byte[] bytes, int offset, int length) throws SerialException, SQLException
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.
pos
- the position in the BLOB
object at which
to start writing. The first position is 1
;
must not be less than 1
nor greater than
the length of this SerialBlob
object.bytes
- the array of bytes to be written to the BLOB
valueoffset
- the offset in the byte
array at which
to start reading the bytes. The first offset position is
0
; must not be less than 0
nor greater
than the length of the byte
arraylength
- the number of bytes to be written to the
BLOB
value from the array of bytes bytes.
SerialException
- if there is an error accessing the
BLOB
value; if an invalid position is set; if an
invalid offset value is set; if number of bytes to be written
is greater than the SerialBlob
length; or the combined
values of the length and offset is greater than the Blob buffer
SQLException
- if there is an error accessing the BLOB
value from the database.getBytes(long, int)
public OutputStream setBinaryStream(long pos) throws SerialException, SQLException
BLOB
value that this Blob
object represents. The stream begins
at position pos
. This method forwards the
setBinaryStream()
call to the underlying Blob
in
the event that this SerialBlob
object is instantiated with a
Blob
. If this SerialBlob
is instantiated with
a byte
array, a SerialException
is thrown.
setBinaryStream
in interface Blob
pos
- the position in the BLOB
value at which
to start writing
java.io.OutputStream
object to which data can
be written
SQLException
- if there is an error accessing the
BLOB
value
SerialException
- if the SerialBlob in not instantiated with a
Blob
object that supports setBinaryStream()
getBinaryStream()
public void truncate(long length) throws SerialException
BLOB
value that this Blob
object represents to be len
bytes in length.
length
- the length, in bytes, to which the BLOB
value that this Blob
object represents should be
truncated
SerialException
- if there is an error accessing the Blob value;
or the length to truncate is greater that the SerialBlob lengthpublic InputStream getBinaryStream(long pos, long length) throws SQLException
InputStream
object that contains a partial Blob
value,
starting with the byte specified by pos, which is length bytes in length.
getBinaryStream
in interface Blob
pos
- the offset to the first byte of the partial value to be retrieved.
The first byte in the Blob
is at position 1length
- the length in bytes of the partial value to be retrieved
InputStream
through which the partial Blob
value can be read.
SQLException
- if pos is less than 1 or if pos is greater than the number of bytes
in the Blob
or if pos + length is greater than the number of bytes
in the Blob
public void free() throws SQLException
Blob
object and releases the resources that it holds.
Blob
object. The object is invalid once the free
method is called. If free
is called multiple times, the subsequent
calls to free
are treated as a no-op.
SQLException
- if an error occurs releasing
the Blob's resources