Top Description Fields Constructors Methods
java.sql

public Class SQLException

extends Exception
implements Iterable<Throwable>
Class Inheritance
All Implemented Interfaces
java.lang.Iterable
Known Direct Subclasses
java.sql.SQLNonTransientException, java.sql.SQLRecoverableException, java.sql.SQLTransientException, java.sql.SQLWarning, java.sql.BatchUpdateException, java.sql.SQLClientInfoException
Imports
java.util.Iterator, .NoSuchElementException, java.util.concurrent.atomic.AtomicReferenceFieldUpdater

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

Each SQLException provides several kinds of information:

Since
1.1

Field Summary

Modifier and TypeField and Description
private volatile SQLException
private static final AtomicReferenceFieldUpdater<SQLException, SQLException>
private static final long
private String
private int

Constructor Summary

AccessConstructor and Description
public
SQLException(String
a description of the exception
reason
,
String
an XOPEN or SQL:2003 code identifying the exception
SQLState
,
int
a database vendor-specific exception code
vendorCode
)

Constructs a SQLException object with a given reason, SQLState and vendorCode.

public
SQLException(String
a description of the exception
reason
,
String
an XOPEN or SQL:2003 code identifying the exception
SQLState
)

Constructs a SQLException object with a given reason and SQLState.

public
SQLException(String
a description of the exception
reason
)

Constructs a SQLException object with a given reason.

public
SQLException()

Constructs a SQLException object.

public
SQLException(Throwable
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.
cause
)

Constructs a SQLException object with a given cause.

public
SQLException(String
a description of the exception.
reason
,
Throwable
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.
cause
)

Constructs a SQLException object with a given reason and cause.

public
SQLException(String
a description of the exception.
reason
,
String
an XOPEN or SQL:2003 code identifying the exception
sqlState
,
Throwable
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.
cause
)

Constructs a SQLException object with a given reason, SQLState and cause.

public
SQLException(String
a description of the exception
reason
,
String
an XOPEN or SQL:2003 code identifying the exception
sqlState
,
int
a database vendor-specific exception code
vendorCode
,
Throwable
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.
cause
)

Constructs a SQLException object with a given reason, SQLState, vendorCode and cause.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the vendor's error code
getErrorCode
()

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

public SQLException

Returns:

the next SQLException object in the chain; null if there are none
getNextException
()

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

public String

Returns:

the SQLState value
getSQLState
()

Retrieves the SQLState for this SQLException object.

public Iterator<Throwable>

Returns:

an iterator over the chained SQLExceptions and causes in the proper order
iterator
()

Implements java.lang.Iterable.iterator.

Returns an iterator over the chained SQLExceptions.

public void
setNextException(SQLException
the new exception that will be added to the end of the SQLException chain
ex
)

Adds an SQLException object to the end of the chain.

Field Detail

nextback to summary
private volatile SQLException next
nextUpdaterback to summary
private static final AtomicReferenceFieldUpdater<SQLException, SQLException> nextUpdater
serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.lang.Exception.serialVersionUID.

SQLStateback to summary
private String SQLState
vendorCodeback to summary
private int vendorCode

Constructor Detail

SQLExceptionback to summary
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 Throwable#initCause(java.lang.Throwable) method.

Parameters
reason:String

a description of the exception

SQLState:String

an XOPEN or SQL:2003 code identifying the exception

vendorCode:int

a database vendor-specific exception code

SQLExceptionback to summary
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 Throwable#initCause(java.lang.Throwable) method. The vendor code is initialized to 0.

Parameters
reason:String

a description of the exception

SQLState:String

an XOPEN or SQL:2003 code identifying the exception

SQLExceptionback to summary
public SQLException(String reason)

Constructs a SQLException object with a given reason. The SQLState is 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 Throwable#initCause(java.lang.Throwable) method.

Parameters
reason:String

a description of the exception

SQLExceptionback to summary
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 Throwable#initCause(java.lang.Throwable) method.

SQLExceptionback to summary
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:Throwable

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.

Since
1.6
SQLExceptionback to summary
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:String

a description of the exception.

cause:Throwable

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.

Since
1.6
SQLExceptionback to summary
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:String

a description of the exception.

sqlState:String

an XOPEN or SQL:2003 code identifying the exception

cause:Throwable

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.

Since
1.6
SQLExceptionback to summary
public SQLException(String reason, String sqlState, int vendorCode, Throwable cause)

Constructs a SQLException object with a given reason, SQLState, vendorCode and cause.

Parameters
reason:String

a description of the exception

sqlState:String

an XOPEN or SQL:2003 code identifying the exception

vendorCode:int

a database vendor-specific exception code

cause:Throwable

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.

Since
1.6

Method Detail

getErrorCodeback to summary
public int getErrorCode()

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

Returns:int

the vendor's error code

getNextExceptionback to summary
public SQLException getNextException()

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

Returns:SQLException

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

See Also
setNextException
getSQLStateback to summary
public String getSQLState()

Retrieves the SQLState for this SQLException object.

Returns:String

the SQLState value

iteratorback to summary
public Iterator<Throwable> iterator()

Implements java.lang.Iterable.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:Iterator<Throwable>

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

Since
1.6
setNextExceptionback to summary
public void setNextException(SQLException ex)

Adds an SQLException object to the end of the chain.

Parameters
ex:SQLException

the new exception that will be added to the end of the SQLException chain

See Also
getNextException