This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.sql
exception SQLException

java.lang.Object extended by java.lang.Throwable extended by java.lang.Exception extended by java.sql.SQLException
All Implemented Interfaces:
Serializable, Iterable

public exception SQLException
extends Exception
implements Iterable

An exception that provides information on a database access error or other errors.

Each SQLException provides several kinds of information:


Constructor Summary

          Constructs a SQLException object.

          Constructs a SQLException object with a given reason.
SQLException(String reason, String SQLState)

          Constructs a SQLException object with a given reason and SQLState.
SQLException(String reason, String SQLState, int vendorCode)

          Constructs a SQLException object with a given reason, SQLState and vendorCode.
SQLException(String reason, String sqlState, int vendorCode, Throwable cause)

          Constructs a SQLException object with a given reason, SQLState, vendorCode and cause.
SQLException(String reason, String sqlState, Throwable cause)

          Constructs a SQLException object with a given reason, SQLState and cause.
SQLException(String reason, Throwable cause)

          Constructs a SQLException object with a given reason and cause.

          Constructs a SQLException object with a given cause.
 
Method Summary
 int

          Retrieves the vendor-specific exception code for this SQLException object.
 SQLException

          Retrieves the exception chained to this SQLException object by setNextException(SQLException ex).
 String

          Retrieves the SQLState for this SQLException object.
 Iterator

          Returns an iterator over the chained SQLExceptions.
 void

          Adds an SQLException object to the end of the chain.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SQLException

public SQLException()
Constructs a SQLException object. The reason, SQLState are initialized to null and the vendor code is initialized to 0. The cause is not initialized, and may subsequently be initialized by a call to the {@link Throwable#initCause(java.lang.Throwable)} method.


SQLException

public SQLException(String reason)
Constructs a SQLException object with a given reason. The SQLState is initialized to null and the vender code is initialized to 0. The cause is not initialized, and may subsequently be initialized by a call to the {@link Throwable#initCause(java.lang.Throwable)} method.

Parameters:
reason - a description of the exception

SQLException

public SQLException(String reason,
                    String SQLState)
Constructs a SQLException object with a given reason and SQLState. The cause is not initialized, and may subsequently be initialized by a call to the {@link Throwable#initCause(java.lang.Throwable)} method. The vendor code is initialized to 0.

Parameters:
reason - a description of the exception
SQLState - an XOPEN or SQL:2003 code identifying the exception

SQLException

public SQLException(String reason,
                    String SQLState,
                    int vendorCode)
Constructs a SQLException object with a given reason, SQLState and vendorCode. The cause is not initialized, and may subsequently be initialized by a call to the {@link Throwable#initCause(java.lang.Throwable)} method.

Parameters:
reason - a description of the exception
SQLState - an XOPEN or SQL:2003 code identifying the exception
vendorCode - a database vendor-specific exception code

SQLException

public SQLException(String reason,
                    String sqlState,
                    int vendorCode,
                    Throwable cause)
Constructs a SQLException object with a given reason, SQLState, vendorCode and cause.

Parameters:
reason - a description of the exception
sqlState - an XOPEN or SQL:2003 code identifying the exception
vendorCode - a database vendor-specific exception code
cause - the underlying reason for this SQLException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.

SQLException

public SQLException(String reason,
                    String sqlState,
                    Throwable cause)
Constructs a SQLException object with a given reason, SQLState and cause. The vendor code is initialized to 0.

Parameters:
reason - a description of the exception.
sqlState - an XOPEN or SQL:2003 code identifying the exception
cause - the underlying reason for this SQLException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.

SQLException

public SQLException(String reason,
                    Throwable cause)
Constructs a SQLException object with a given reason and cause. The SQLState is initialized to null and the vendor code is initialized to 0.

Parameters:
reason - a description of the exception.
cause - the underlying reason for this SQLException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.

SQLException

public SQLException(Throwable cause)
Constructs a SQLException object with a given cause. The SQLState is initialized to null and the vendor code is initialized to 0. The reason is initialized to null if cause==null or to cause.toString() if cause!=null.

Parameters:
cause - the underlying reason for this SQLException (which is saved for later retrieval by the getCause() method); may be null indicating the cause is non-existent or unknown.
Method Detail

getErrorCode

public int getErrorCode()
Retrieves the vendor-specific exception code for this SQLException object.

Returns:
the vendor's error code

getNextException

public SQLException getNextException()
Retrieves the exception chained to this SQLException object by setNextException(SQLException ex).

Returns:
the next SQLException object in the chain; null if there are none

getSQLState

public String getSQLState()
Retrieves the SQLState for this SQLException object.

Returns:
the SQLState value

iterator

public Iterator iterator()
Returns an iterator over the chained SQLExceptions. The iterator will be used to iterate over each SQLException and its underlying cause (if any).

Returns:
an iterator over the chained SQLExceptions and causes in the proper order

setNextException

public void setNextException(SQLException ex)
Adds an SQLException object to the end of the chain.

Parameters:
ex - the new exception that will be added to the end of the SQLException chain


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.