001/* SQLData.java -- Custom mapping for a user defined datatype
002   Copyright (C) 1999, 2000, 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010 
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.sql;
040
041/**
042 * This interface is used for mapping SQL data to user defined datatypes.
043 *
044 * @author Aaron M. Renn (arenn@urbanophile.com)
045 */
046public interface SQLData 
047{
048  /**
049   * This method returns the user defined datatype name for this object.
050   *
051   * @return The user defined data type name for this object.
052   * @exception SQLException If an error occurs.
053   */
054  String getSQLTypeName() throws SQLException;
055
056  /**
057   * This method populates the data in the object from the specified stream.
058   *
059   * @param stream The stream to read the data from.
060   * @param typeName The data type name of the data on the stream.
061   * @exception SQLException If an error occurs.
062   */
063  void readSQL(SQLInput stream, String typeName) throws SQLException;
064
065  /**
066   * This method writes the data in this object to the specified stream.
067   *
068   * @param stream The stream to write the data to.
069   * @exception SQLException If an error occurs.
070   */
071  void writeSQL(SQLOutput stream) throws SQLException;
072}