libjava/java/sql/Blob.java

   1 /* Blob.java -- Access a SQL Binary Large OBject.
   2    Copyright (C) 1999, 2000, 2002 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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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
  45  * Large 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 the BLOB.
  54    *
  55    * @return The number of bytes in the BLOB.
  56    * @exception SQLException If an error occurs.
  57    */
  58   public long length() throws SQLException;
  59
  60   /**
  61    * This method returns up to the requested bytes of this BLOB as a
  62    * <code>byte</code> array.
  63    *
  64    * @param pos The index into the BLOB to start returning bytes from.
  65    * @param length The requested number of bytes to return.
  66    * @return The requested bytes from the BLOB.
  67    * @exception SQLException If an error occurs.
  68    */
  69   public byte[] getBytes(long pos, int length) throws SQLException;
  70
  71   /**
  72    * This method returns a stream that will read the bytes of the BLOB.
  73    *
  74    * @return A stream that will read the bytes of the BLOB.
  75    * @exception SQLException If an error occurs.
  76    */
  77   public InputStream getBinaryStream() throws SQLException;
  78
  79   /**
  80    * This method returns the index into the BLOB at which the first instance
  81    * of the specified bytes occur.  The searching starts at the specified
  82    * index into the BLOB.
  83    *
  84    * @param pattern The byte pattern to search for.
  85    * @param offset The index into the BLOB to starting searching for the pattern.
  86    * @return The offset at which the pattern is first found, or -1 if the
  87    *         pattern is not found.
  88    * @exception SQLException If an error occurs.
  89    */
  90   public long position(byte[] pattern, long start) throws SQLException;
  91
  92   /**
  93    * This method returns the index into the BLOB at which the first instance
  94    * of the specified pattern occurs.  The searching starts at the specified
  95    * index into this BLOB.  The bytes in the specified <code>Blob</code> are
  96    * used as the search pattern.
  97    *
  98    * @param pattern The <code>Blob</code> containing the byte pattern to
  99    *        search for.
 100    * @param offset The index into the BLOB to starting searching for the pattern.
 101    * @return The offset at which the pattern is first found, or -1 if the
 102    *         pattern is not found.
 103    * @exception SQLException If an error occurs.
 104    */
 105   public long position(Blob pattern, long start) throws SQLException;
 106
 107   /**
 108    * @exception SQLException If an error occurs.
 109    * @since 1.4
 110    */
 111   public int setBytes(long pos, byte[] bytes) throws SQLException;
 112
 113   /**
 114    * @exception SQLException If an error occurs.
 115    * @since 1.4
 116    */
 117   public int setBytes(long pos, byte[] bytes, int offset, int len)
 118     throws SQLException;
 119
 120   /**
 121    * @exception SQLException If an error occurs.
 122    * @since 1.4
 123    */
 124   public OutputStream setBinaryStream(long pos) throws SQLException;
 125
 126   /**
 127    * @exception SQLException If an error occurs.
 128    * @since 1.4
 129    */
 130   public void truncate(long len) throws SQLException;
 131 }