java.sql
Interface Blob


public interface Blob

This interface specified methods for accessing a SQL BLOB (Binary Large OBject) type.

Since:
1.2

Method Summary
 InputStream getBinaryStream()
          This method returns a stream that will read the bytes of this Blob.
 byte[] getBytes(long start, int count)
          This method returns up to the requested bytes of this Blob as a byte array.
 long length()
          This method returns the number of bytes in this Blob.
 long position(Blob pattern, long start)
          This method returns the index into this Blob at which the first instance of the specified pattern occurs.
 long position(byte[] pattern, long start)
          This method returns the index into this Blob at which the first instance of the specified bytes occur.
 OutputStream setBinaryStream(long start)
          Returns a binary stream that writes into this Blob, starting at the specified index.
 int setBytes(long start, byte[] bytes)
          Writes the specified data into this Blob, starting at the specified index.
 int setBytes(long startWrite, byte[] bytes, int startRead, int count)
          Writes a portion of the specified data into this Blob, starting at the specified index.
 void truncate(long count)
          Truncates this Blob to be at most the specified number of bytes long.
 

Method Detail

length

long length()
            throws SQLException
This method returns the number of bytes in this Blob.

Returns:
The number of bytes in this Blob.
Throws:
SQLException - If an error occurs.

getBytes

byte[] getBytes(long start,
                int count)
                throws SQLException
This method returns up to the requested bytes of this Blob as a byte array.

Parameters:
start - The index into this Blob to start returning bytes from.
count - The requested number of bytes to return.
Returns:
The requested bytes from this Blob.
Throws:
SQLException - If an error occurs.

getBinaryStream

InputStream getBinaryStream()
                            throws SQLException
This method returns a stream that will read the bytes of this Blob.

Returns:
A stream that will read the bytes of this Blob.
Throws:
SQLException - If an error occurs.

position

long position(byte[] pattern,
              long start)
              throws SQLException
This method returns the index into this Blob at which the first instance of the specified bytes occur. The searching starts at the specified index into this Blob.

Parameters:
pattern - The byte pattern to search for.
start - The index into this Blob to start searching for the pattern.
Returns:
The offset at which the pattern is first found, or -1 if the pattern is not found.
Throws:
SQLException - If an error occurs.

position

long position(Blob pattern,
              long start)
              throws SQLException
This method returns the index into this Blob at which the first instance of the specified pattern occurs. The searching starts at the specified index into this Blob. The bytes in the specified Blob are used as the search pattern.

Parameters:
pattern - The Blob containing the byte pattern to search for.
start - The index into this Blob to start searching for the pattern.
Returns:
The offset at which the pattern is first found, or -1 if the pattern is not found.
Throws:
SQLException - If an error occurs.

setBytes

int setBytes(long start,
             byte[] bytes)
             throws SQLException
Writes the specified data into this Blob, starting at the specified index.

Parameters:
start - The index at which the writing starts.
bytes - The data to write.
Throws:
SQLException - If an error occurs.
Since:
1.4

setBytes

int setBytes(long startWrite,
             byte[] bytes,
             int startRead,
             int count)
             throws SQLException
Writes a portion of the specified data into this Blob, starting at the specified index.

Parameters:
startWrite - The index into this Blob at which writing starts.
bytes - The data to write a portion of.
startRead - The offset into the data where the portion to copy starts.
count - The number of bytes to write.
Throws:
SQLException - If an error occurs.
Since:
1.4

setBinaryStream

OutputStream setBinaryStream(long start)
                             throws SQLException
Returns a binary stream that writes into this Blob, starting at the specified index.

Parameters:
start - The index at which the writing starts.
Returns:
A binary stream to write into this Blob.
Throws:
SQLException - If an error occurs.
Since:
1.4

truncate

void truncate(long count)
              throws SQLException
Truncates this Blob to be at most the specified number of bytes long.

Parameters:
count - The length this Blob is truncated to.
Throws:
SQLException - If an error occurs.
Since:
1.4