File	Doc	Category	Size	Date	Package
Blob.java	API Doc	Java SE 6 API	13044	Tue Jun 10 00:25:48 BST 2008	java.sql

Blob

Fields Summary

Constructors Summary

Methods Summary
public void	free() This method frees the Blob object and releases the resources that it holds. The object is invalid once the free method is called. After free has been called, any attempt to invoke a method other than free will result in a SQLException being thrown. If free is called multiple times, the subsequent calls to free are treated as a no-op. throws SQLException if an error occurs releasing the Blob's resources exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6
public java.io.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. param pos the offset to the first byte of the partial value to be retrieved. The first byte in the Blob is at position 1 param length the length in bytes of the partial value to be retrieved return InputStream through which the partial Blob value can be read. throws 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 exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6
public java.io.InputStream	getBinaryStream() Retrieves the BLOB value designated by this Blob instance as a stream. return a stream containing the BLOB data exception SQLException if there is an error accessing the BLOB value exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #setBinaryStream since 1.2
public byte[]	getBytes(long pos, int length) Retrieves all or part of the BLOB value that this Blob object represents, as an array of bytes. This byte array contains up to length consecutive bytes starting at position pos. param pos the ordinal position of the first byte in the BLOB value to be extracted; the first byte is at position 1 param length the number of consecutive bytes to be copied; the value for length must be 0 or greater return a byte array containing up to length consecutive bytes from the BLOB value designated by this Blob object, starting with the byte at position pos exception SQLException if there is an error accessing the BLOB value; if pos is less than 1 or length is less than 0 exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #setBytes since 1.2
public long	length() Returns the number of bytes in the BLOB value designated by this Blob object. return length of the BLOB in bytes exception SQLException if there is an error accessing the length of the BLOB exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.2
public long	position(byte[] pattern, long start) Retrieves the byte position at which the specified byte array pattern begins within the BLOB value that this Blob object represents. The search for pattern begins at position start. param pattern the byte array for which to search param start the position at which to begin searching; the first position is 1 return the position at which the pattern appears, else -1 exception SQLException if there is an error accessing the BLOB or if start is less than 1 exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.2
public long	position(java.sql.Blob pattern, long start) Retrieves the byte position in the BLOB value designated by this Blob object at which pattern begins. The search begins at position start. param pattern the Blob object designating the BLOB value for which to search param start the position in the BLOB value at which to begin searching; the first position is 1 return the position at which the pattern begins, else -1 exception SQLException if there is an error accessing the BLOB value or if start is less than 1 exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.2
public java.io.OutputStream	setBinaryStream(long pos) Retrieves a stream that can be used to write to the BLOB value that this Blob object represents. The stream begins at position pos. The bytes written to the stream will overwrite the existing bytes in the Blob object starting at the position pos. If the end of the Blob value is reached while writing to the stream, then the length of the Blob value will be increased to accomodate the extra bytes. Note: If the value specified for pos is greater then the length+1 of the BLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation. param pos the position in the BLOB value at which to start writing; the first position is 1 return a java.io.OutputStream object to which data can be written exception SQLException if there is an error accessing the BLOB value or if pos is less than 1 exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getBinaryStream since 1.4
public 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. The array of bytes will overwrite the existing bytes in the Blob object starting at the position pos. If the end of the Blob value is reached while writing the array of bytes, then the length of the Blob value will be increased to accomodate the extra bytes. Note: If the value specified for pos is greater then the length+1 of the BLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation. param pos the position in the BLOB object at which to start writing; the first position is 1 param bytes the array of bytes to be written to the BLOB value that this Blob object represents return the number of bytes written exception SQLException if there is an error accessing the BLOB value or if pos is less than 1 exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getBytes since 1.4
public int	setBytes(long pos, byte[] bytes, int offset, int len) 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. The array of bytes will overwrite the existing bytes in the Blob object starting at the position pos. If the end of the Blob value is reached while writing the array of bytes, then the length of the Blob value will be increased to accomodate the extra bytes. Note: If the value specified for pos is greater then the length+1 of the BLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation. param pos the position in the BLOB object at which to start writing; the first position is 1 param bytes the array of bytes to be written to this BLOB object param offset the offset into the array bytes at which to start reading the bytes to be set param len the number of bytes to be written to the BLOB value from the array of bytes bytes return the number of bytes written exception SQLException if there is an error accessing the BLOB value or if pos is less than 1 exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getBytes since 1.4
public void	truncate(long len) Truncates the BLOB value that this Blob object represents to be len bytes in length. Note: If the value specified for pos is greater then the length+1 of the BLOB value then the behavior is undefined. Some JDBC drivers may throw a SQLException while other drivers may support this operation. param len the length, in bytes, to which the BLOB value that this Blob object represents should be truncated exception SQLException if there is an error accessing the BLOB value or if len is less than 0 exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.4