Source for java.sql.Blob

   1: /* Blob.java -- Access a SQL Binary Large OBject.
   2:    Copyright (C) 1999, 2000, 2002, 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10:  
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package java.sql;
  39: 
  40: import java.io.InputStream;
  41: import java.io.OutputStream;
  42: 
  43: /**
  44:  * This interface specified methods for accessing a SQL BLOB (Binary Large
  45:  * OBject) type.
  46:  * 
  47:  * @author Aaron M. Renn (arenn@urbanophile.com)
  48:  * @since 1.2
  49:  */
  50: public interface Blob
  51: {
  52:   /**
  53:    * This method returns the number of bytes in this <code>Blob</code>.
  54:    * 
  55:    * @return The number of bytes in this <code>Blob</code>.
  56:    * @exception SQLException If an error occurs.
  57:    */
  58:   long length() throws SQLException;
  59: 
  60:   /**
  61:    * This method returns up to the requested bytes of this <code>Blob</code>
  62:    * as a <code>byte</code> array.
  63:    * 
  64:    * @param start The index into this <code>Blob</code> to start returning
  65:    *              bytes from.
  66:    * @param count The requested number of bytes to return.
  67:    * @return The requested bytes from this <code>Blob</code>.
  68:    * @exception SQLException If an error occurs.
  69:    */
  70:   byte[] getBytes(long start, int count) throws SQLException;
  71: 
  72:   /**
  73:    * This method returns a stream that will read the bytes of this
  74:    * <code>Blob</code>.
  75:    * 
  76:    * @return A stream that will read the bytes of this <code>Blob</code>.
  77:    * @exception SQLException If an error occurs.
  78:    */
  79:   InputStream getBinaryStream() throws SQLException;
  80: 
  81:   /**
  82:    * This method returns the index into this <code>Blob</code> at which the
  83:    * first instance of the specified bytes occur. The searching starts at the
  84:    * specified index into this <code>Blob</code>.
  85:    * 
  86:    * @param pattern The byte pattern to search for.
  87:    * @param start The index into this <code>Blob</code> to start searching for
  88:    *              the pattern.
  89:    * @return The offset at which the pattern is first found, or -1 if the
  90:    *         pattern is not found.
  91:    * @exception SQLException If an error occurs.
  92:    */
  93:   long position(byte[] pattern, long start) throws SQLException;
  94: 
  95:   /**
  96:    * This method returns the index into this <code>Blob</code> at which the
  97:    * first instance of the specified pattern occurs. The searching starts at the
  98:    * specified index into this <code>Blob</code>. The bytes in the specified
  99:    * <code>Blob</code> are used as the search pattern.
 100:    * 
 101:    * @param pattern The <code>Blob</code> containing the byte pattern to
 102:    *                search for.
 103:    * @param start The index into this <code>Blob</code> to start searching for
 104:    *              the pattern.
 105:    * @return The offset at which the pattern is first found, or -1 if the
 106:    *         pattern is not found.
 107:    * @exception SQLException If an error occurs.
 108:    */
 109:   long position(Blob pattern, long start) throws SQLException;
 110: 
 111:   /**
 112:    * Writes the specified data into this <code>Blob</code>, starting at the
 113:    * specified index.
 114:    * 
 115:    * @param start The index at which the writing starts.
 116:    * @param bytes The data to write.
 117:    * @exception SQLException If an error occurs.
 118:    * @since 1.4
 119:    */
 120:   int setBytes(long start, byte[] bytes) throws SQLException;
 121: 
 122:   /**
 123:    * Writes a portion of the specified data into this <code>Blob</code>,
 124:    * starting at the specified index.
 125:    * 
 126:    * @param startWrite The index into this <code>Blob</code> at which writing
 127:    *                   starts.
 128:    * @param bytes The data to write a portion of.
 129:    * @param startRead The offset into the data where the portion to copy starts.
 130:    * @param count The number of bytes to write.
 131:    * @exception SQLException If an error occurs.
 132:    * @since 1.4
 133:    */
 134:   int setBytes(long startWrite, byte[] bytes, int startRead, int count)
 135:       throws SQLException;
 136: 
 137:   /**
 138:    * Returns a binary stream that writes into this <code>Blob</code>,
 139:    * starting at the specified index.
 140:    * 
 141:    * @param start The index at which the writing starts.
 142:    * @return A binary stream to write into this <code>Blob</code>.
 143:    * @exception SQLException If an error occurs.
 144:    * @since 1.4
 145:    */
 146:   OutputStream setBinaryStream(long start) throws SQLException;
 147: 
 148:   /**
 149:    * Truncates this <code>Blob</code> to be at most the specified number of
 150:    * bytes long.
 151:    * 
 152:    * @param count The length this <code>Blob</code> is truncated to.
 153:    * @exception SQLException If an error occurs.
 154:    * @since 1.4
 155:    */
 156:   void truncate(long count) throws SQLException;
 157: }