Save This Page
Home » openjdk-7 » javax » sql » rowset » serial » [javadoc | source]
javax.sql.rowset.serial
public class: SerialBlob [javadoc | source]
java.lang.Object
   javax.sql.rowset.serial.SerialBlob

All Implemented Interfaces:
    Cloneable, Blob, Serializable

A serialized mapping in the Java programming language of an SQL 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.

Field Summary
static final  long serialVersionUID    The identifier that assists in the serialization of this SerialBlob object. 
Constructor:
 public SerialBlob(byte[] b) throws SQLException, SerialException 
    Constructs a 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.

    Parameters:
    b - the byte array containing the data for the Blob object to be serialized
    Throws:
    SerialException - if an error occurs during serialization
    SQLException - if a SQL errors occurs
 public SerialBlob(Blob blob) throws SQLException, SerialException 
    Constructs a 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.

    Parameters:
    blob - the Blob object from which this SerialBlob object is to be constructed; cannot be null.
    Throws:
    SerialException - if an error occurs during serialization
    SQLException - if the Blob passed to this to this constructor is a null.
    Also see:
    java.sql.Blob
Method from javax.sql.rowset.serial.SerialBlob Summary:
free,   getBinaryStream,   getBinaryStream,   getBytes,   length,   position,   position,   setBinaryStream,   setBytes,   setBytes,   truncate
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.sql.rowset.serial.SerialBlob Detail:
 public  void free() throws SQLException 
    This method frees the 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.
 public InputStream getBinaryStream() throws SerialException 
    Returns this 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.
 public InputStream getBinaryStream(long pos,
    long length) throws SQLException 
    Returns an InputStream object that contains a partial Blob value, starting with the byte specified by pos, which is length bytes in length.
 public byte[] getBytes(long pos,
    int length) throws SerialException 
    Copies the specified number of bytes, starting at the given position, from this 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.

 public long length() throws SerialException 
    Retrieves the number of bytes in this SerialBlob object's array of bytes.
 public long position(byte[] pattern,
    long start) throws SQLException, SerialException 
    Returns the position in this SerialBlob object where the given pattern of bytes begins, starting the search at the specified position.
 public long position(Blob pattern,
    long start) throws SQLException, SerialException 
    Returns the position in this SerialBlob object where the given Blob object begins, starting the search at the specified position.
 public OutputStream setBinaryStream(long pos) throws SQLException, SerialException 
    Retrieves a stream that can be used to write to the 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.
 public int setBytes(long pos,
    byte[] bytes) throws SQLException, SerialException 
    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.
 public int setBytes(long pos,
    byte[] bytes,
    int offset,
    int length) throws SQLException, SerialException 
    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. Writing starts at position pos in the BLOB value; len bytes from the given byte array are written.
 public  void truncate(long length) throws SerialException 
    Truncates the BLOB value that this Blob object represents to be len bytes in length.