001    /* SQLException.java -- General SQL exception
002       Copyright (C) 1999, 2000 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010     
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package java.sql;
040    
041    /**
042     * This exception is thrown when a database error occurs.
043     *
044     * @author Aaron M. Renn (arenn@urbanophile.com)
045     */
046    public class SQLException extends Exception 
047    {
048      static final long serialVersionUID = 2135244094396331484L;
049    
050      /**
051       * This is the next exception in the chain
052       */
053      private SQLException next;
054    
055      /**
056       * This is the state of the SQL statement at the time of the error.
057       */
058      private String SQLState;
059    
060      /**
061       * The vendor error code for this error
062       */
063      private int vendorCode;
064    
065      /**
066       * This method initializes a nwe instance of <code>SQLException</code>
067       * with the specified descriptive error message, SQL state string, and
068       * vendor code.
069       *
070       * @param message A string describing the nature of the error.
071       * @param SQLState A string containing the SQL state of the error.
072       * @param vendorCode The vendor error code associated with this error.
073       */
074      public SQLException(String message, String SQLState, int vendorCode)
075      {
076        super(message);
077        this.SQLState = SQLState;
078        this.vendorCode = vendorCode;  
079      }
080    
081      /**
082       * This method initializes a new instance of <code>SQLException</code>
083       * with the specified descriptive error message and SQL state string.
084       * The vendor error code of this instance will be 0.
085       *
086       * @param message A string describing the nature of the error.
087       * @param SQLState A string containing the SQL state of the error.
088       */
089      public SQLException(String message, String SQLState)
090      {
091        this(message, SQLState, 0);
092      }
093    
094      /**
095       * This method initializes a new instance of <code>SQLException</code>
096       * with the specified descriptive error message.  The SQL state of this
097       * instance will be <code>null</code> and the vendor error code will be 0.
098       *
099       * @param message A string describing the nature of the error.
100       */
101      public SQLException(String message)
102      {
103        this(message, null, 0);  
104      }
105    
106      /**
107       * This method initializes a new instance of <code>SQLException</code>
108       * that does not have a descriptive messages and SQL state, and which
109       * has a vendor error code of 0.
110       */
111      public SQLException()
112      {
113        this(null, null, 0);  
114      }
115    
116      /**
117       * This method returns the SQLState information associated with this
118       * error.  The value returned is a <code>String</code> which is formatted
119       * using the XOPEN SQL state conventions.
120       *
121       * @return The SQL state, which may be <code>null</code>.
122       */
123      public String getSQLState()
124      {
125        return SQLState;
126      }
127    
128      /**
129       * This method returns the vendor specific error code associated with 
130       * this error.
131       *
132       * @return The vendor specific error code associated with this error.
133       */
134      public int getErrorCode()
135      {
136        return vendorCode;
137      }
138    
139      /**
140       * This method returns the exception that is chained to this object.
141       *
142       * @return The exception chained to this object, which may be 
143       *         <code>null</code>.
144       */
145      public SQLException getNextException()
146      {
147        return next;
148      }
149    
150      /**
151       * This method adds a new exception to the end of the chain of exceptions
152       * that are chained to this object.
153       *
154       * @param e The exception to add to the end of the chain.
155       */
156      public void setNextException(SQLException e)
157      {
158        if (e == null)
159          return;
160    
161        SQLException list_entry = this;
162        while (list_entry.getNextException() != null)
163          list_entry = list_entry.getNextException();
164    
165        list_entry.next = e;
166      }
167    }