public class SerialBlob extends Object implements Blob, Serializable, Cloneable
BLOB value.
The SerialBlob class provides a constructor for creating
an instance from a Blob object. Note that the
Blob
object should have brought the SQL BLOB value's data over
to the client before a SerialBlob object
is constructed from it. The data of an SQL BLOB value can
be materialized on the client as an array of bytes (using the method
Blob.getBytes) or as a stream of uninterpreted bytes
(using the method Blob.getBinaryStream).
SerialBlob methods make it possible to make a copy of a
SerialBlob object as an array of bytes or as a stream.
They also make it possible to locate a given pattern of bytes or a
Blob object within a SerialBlob object
and to update or truncate a Blob object.
A SerialBlob is not safe for use by multiple concurrent threads. If a SerialBlob is to be used by more than one thread then access to the SerialBlob should be controlled by appropriate synchronization.
| Constructor and Description |
|---|
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. |
| Modifier and Type | Method and Description |
|---|---|
Object |
clone()
Returns a clone of this
SerialBlob. |
boolean |
equals(Object obj)
Compares this SerialBlob to the specified object.
|
void |
free()
This method frees the
SeriableBlob 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. |
int |
hashCode()
Returns a hash code for this
SerialBlob. |
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. |
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 serializedSerialException - if an error occurs during serializationSQLException - 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 serializationSQLException - if the Blob passed to this
to this constructor is a null.Blobpublic 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.
getBytes in interface Blobpos - 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 copiedSerialBlob object, starting at the given
position and containing the given number of consecutive bytesSerialException - if the given starting position is out of bounds;
if free had previously been called on this objectBlob.setBytes(long, byte[])public long length()
throws SerialException
SerialBlob
object's array of bytes.length in interface Bloblong indicating the length in bytes of this
SerialBlob object's array of bytesSerialException - if an error occurs;
if free had previously been called on this objectpublic 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 Blobjava.io.InputStream object that contains
this SerialBlob object's array of bytesSerialException - if an error occurs;
if free had previously been called on this objectsetBinaryStream(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.position in interface Blobpattern - 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 objectSerialBlob 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 1SerialException - if an error occurs when serializing the blob;
if free had previously been called on this objectSQLException - 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.position in interface Blobpattern - 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 objectSerialBlob 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 1SerialException - if an error occurs when serializing the blob;
if free had previously been called on this objectSQLException - 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.setBytes in interface Blobpos - 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 representsSerialException - if there is an error accessing the
BLOB value; or if an invalid position is set; if an
invalid offset value is set;
if free had previously been called on this objectSQLException - 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.setBytes in interface Blobpos - 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;
if free had previously been called on this objectSQLException - 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 Blobpos - the position in the BLOB value at which
to start writingjava.io.OutputStream object to which data can
be writtenSQLException - if there is an error accessing the
BLOB valueSerialException - if the SerialBlob in not instantiated with a
Blob object that supports setBinaryStream();
if free had previously been called on this objectgetBinaryStream()public void truncate(long length)
throws SerialException
BLOB value that this Blob
object represents to be len bytes in length.truncate in interface Bloblength - the length, in bytes, to which the BLOB
value that this Blob object represents should be
truncatedSerialException - if there is an error accessing the Blob value;
or the length to truncate is greater that the SerialBlob length;
if free had previously been called on this objectpublic 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 Blobpos - 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 retrievedInputStream 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 BlobSerialException - if the free method had been previously
called on this objectpublic void free()
throws SQLException
SeriableBlob object and releases the
resources that it holds. 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.
free in interface BlobSQLException - if an error occurs releasing the Blob's resourcespublic boolean equals(Object obj)
true if and only if the argument is not null and is a SerialBlob object that represents the same sequence of bytes as this
object.equals in class Objectobj - The object to compare this SerialBlob againsttrue if the given object represents a SerialBlob
equivalent to this SerialBlob, false otherwiseObject.hashCode(),
HashMappublic int hashCode()
SerialBlob.hashCode in class ObjectObject.equals(java.lang.Object),
System.identityHashCode(java.lang.Object)public Object clone()
SerialBlob. The copy will contain a
reference to a clone of the internal byte array, not a reference
to the original internal byte array of this SerialBlob object.
The underlying Blob object will be set to null. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.