libjava/java/sql/SQLData.java

   1 /* SQLData.java -- Custom mapping for a user defined datatype
   2    Copyright (C) 1999, 2000 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
  39 package java.sql;
  40
  41 /**
  42  * This interface is used for mapping SQL data to user defined datatypes.
  43  *
  44  * @author Aaron M. Renn (arenn@urbanophile.com)
  45  */
  46 public interface SQLData
  47 {
  48   /**
  49    * This method returns the user defined datatype name for this object.
  50    *
  51    * @return The user defined data type name for this object.
  52    * @exception SQLException If an error occurs.
  53    */
  54   String getSQLTypeName() throws SQLException;
  55
  56   /**
  57    * This method populates the data in the object from the specified stream.
  58    *
  59    * @param stream The stream to read the data from.
  60    * @param name The data type name of the data on the stream.
  61    * @exception SQLException If an error occurs.
  62    */
  63   void readSQL(SQLInput stream, String typeName) throws SQLException;
  64
  65   /**
  66    * This method writes the data in this object to the specified stream.
  67    *
  68    * @param stream The stream to write the data to.
  69    * @exception SQLException If an error occurs.
  70    */
  71   void writeSQL(SQLOutput stream) throws SQLException;
  72 }