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(byte[] pattern, long start)
This method returns the index into this Blob at which the first instance of the specified bytes occur.
long
position(Blob pattern, long start)
This method returns the index into this Blob at which the first instance of the specified pattern occurs.
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 Details

getBinaryStream

public 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.

getBytes

public 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.

length

public 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.

position

public 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

public 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.

setBinaryStream

public 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

setBytes

public 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

public 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

truncate

public 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

Blob.java -- Access a SQL Binary Large OBject. Copyright (C) 1999, 2000, 2002, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.