diff options
Diffstat (limited to 'libjava/classpath/java/sql/Blob.java')
| -rw-r--r-- | libjava/classpath/java/sql/Blob.java | 96 |
1 files changed, 61 insertions, 35 deletions
diff --git a/libjava/classpath/java/sql/Blob.java b/libjava/classpath/java/sql/Blob.java index 616839d..c662aad 100644 --- a/libjava/classpath/java/sql/Blob.java +++ b/libjava/classpath/java/sql/Blob.java @@ -1,5 +1,5 @@ /* Blob.java -- Access a SQL Binary Large OBject. - Copyright (C) 1999, 2000, 2002 Free Software Foundation, Inc. + Copyright (C) 1999, 2000, 2002, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -41,48 +41,51 @@ import java.io.InputStream; import java.io.OutputStream; /** - * This interface specified methods for accessing a SQL BLOB (Binary - * Large OBject) type. - * + * This interface specified methods for accessing a SQL BLOB (Binary Large + * OBject) type. + * * @author Aaron M. Renn (arenn@urbanophile.com) * @since 1.2 */ -public interface Blob +public interface Blob { /** - * This method returns the number of bytes in the BLOB. - * - * @return The number of bytes in the BLOB. + * This method returns the number of bytes in this <code>Blob</code>. + * + * @return The number of bytes in this <code>Blob</code>. * @exception SQLException If an error occurs. */ long length() throws SQLException; /** - * This method returns up to the requested bytes of this BLOB as a - * <code>byte</code> array. - * - * @param pos The index into the BLOB to start returning bytes from. - * @param length The requested number of bytes to return. - * @return The requested bytes from the BLOB. + * This method returns up to the requested bytes of this <code>Blob</code> + * as a <code>byte</code> array. + * + * @param start The index into this <code>Blob</code> to start returning + * bytes from. + * @param count The requested number of bytes to return. + * @return The requested bytes from this <code>Blob</code>. * @exception SQLException If an error occurs. */ - byte[] getBytes(long pos, int length) throws SQLException; + byte[] getBytes(long start, int count) throws SQLException; /** - * This method returns a stream that will read the bytes of the BLOB. - * - * @return A stream that will read the bytes of the BLOB. + * This method returns a stream that will read the bytes of this + * <code>Blob</code>. + * + * @return A stream that will read the bytes of this <code>Blob</code>. * @exception SQLException If an error occurs. */ InputStream getBinaryStream() throws SQLException; /** - * This method returns the index into the BLOB at which the first instance - * of the specified bytes occur. The searching starts at the specified - * index into the BLOB. - * + * This method returns the index into this <code>Blob</code> at which the + * first instance of the specified bytes occur. The searching starts at the + * specified index into this <code>Blob</code>. + * * @param pattern The byte pattern to search for. - * @param offset The index into the BLOB to starting searching for the pattern. + * @param start The index into this <code>Blob</code> to start searching for + * the pattern. * @return The offset at which the pattern is first found, or -1 if the * pattern is not found. * @exception SQLException If an error occurs. @@ -90,14 +93,15 @@ public interface Blob long position(byte[] pattern, long start) throws SQLException; /** - * This method returns the index into the 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 <code>Blob</code> are - * used as the search pattern. - * + * This method returns the index into this <code>Blob</code> at which the + * first instance of the specified pattern occurs. The searching starts at the + * specified index into this <code>Blob</code>. The bytes in the specified + * <code>Blob</code> are used as the search pattern. + * * @param pattern The <code>Blob</code> containing the byte pattern to - * search for. - * @param offset The index into the BLOB to starting searching for the pattern. + * search for. + * @param start The index into this <code>Blob</code> to start searching for + * the pattern. * @return The offset at which the pattern is first found, or -1 if the * pattern is not found. * @exception SQLException If an error occurs. @@ -105,27 +109,49 @@ public interface Blob long position(Blob pattern, long start) throws SQLException; /** + * Writes the specified data into this <code>Blob</code>, starting at the + * specified index. + * + * @param start The index at which the writing starts. + * @param bytes The data to write. * @exception SQLException If an error occurs. * @since 1.4 */ - int setBytes(long pos, byte[] bytes) throws SQLException; + int setBytes(long start, byte[] bytes) throws SQLException; /** + * Writes a portion of the specified data into this <code>Blob</code>, + * starting at the specified index. + * + * @param startWrite The index into this <code>Blob</code> at which writing + * starts. + * @param bytes The data to write a portion of. + * @param startRead The offset into the data where the portion to copy starts. + * @param count The number of bytes to write. * @exception SQLException If an error occurs. * @since 1.4 */ - int setBytes(long pos, byte[] bytes, int offset, int len) - throws SQLException; + int setBytes(long startWrite, byte[] bytes, int startRead, int count) + throws SQLException; /** + * Returns a binary stream that writes into this <code>Blob</code>, + * starting at the specified index. + * + * @param start The index at which the writing starts. + * @return A binary stream to write into this <code>Blob</code>. * @exception SQLException If an error occurs. * @since 1.4 */ - OutputStream setBinaryStream(long pos) throws SQLException; + OutputStream setBinaryStream(long start) throws SQLException; /** + * Truncates this <code>Blob</code> to be at most the specified number of + * bytes long. + * + * @param count The length this <code>Blob</code> is truncated to. * @exception SQLException If an error occurs. * @since 1.4 */ - void truncate(long len) throws SQLException; + void truncate(long count) throws SQLException; } |