SQLException (Java SE 13 & JDK 13 )
- All Implemented Interfaces:
Serializable,Iterable<Throwable>
- Direct Known Subclasses:
BatchUpdateException,RowSetWarning,SerialException,SQLClientInfoException,SQLNonTransientException,SQLRecoverableException,SQLTransientException,SQLWarning,SyncFactoryException,SyncProviderException
public class SQLException extends Exception implements Iterable<Throwable>
An exception that provides information on a database access error or other errors.
Each SQLException provides several kinds of information:
- a string describing the error. This is used as the Java Exception
message, available via the method
getMessage. - a "SQLstate" string, which follows either the XOPEN SQLstate conventions
or the SQL:2003 conventions.
The values of the SQLState string are described in the appropriate spec.
The
DatabaseMetaDatamethodgetSQLStateTypecan be used to discover whether the driver returns the XOPEN type or the SQL:2003 type. - an integer error code that is specific to each vendor. Normally this will be the actual error code returned by the underlying database.
- a chain to a next Exception. This can be used to provide additional error information.
- the causal relationship, if any for this
SQLException.
- Since:
- 1.1
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description SQLException()Constructs a
SQLExceptionobject.SQLException(String reason)Constructs a
SQLExceptionobject with a givenreason.SQLException(String reason, String SQLState)Constructs a
SQLExceptionobject with a givenreasonandSQLState.SQLException(String reason, String SQLState, int vendorCode)Constructs a
SQLExceptionobject with a givenreason,SQLStateandvendorCode.SQLException(String reason, String sqlState, int vendorCode, Throwable cause)Constructs a
SQLExceptionobject with a givenreason,SQLState,vendorCodeandcause.SQLException(String reason, String sqlState, Throwable cause)Constructs a
SQLExceptionobject with a givenreason,SQLStateandcause.SQLException(String reason, Throwable cause)Constructs a
SQLExceptionobject with a givenreasonandcause.SQLException(Throwable cause)Constructs a
SQLExceptionobject with a givencause. -
Method Summary
Modifier and Type Method Description intgetErrorCode()Retrieves the vendor-specific exception code for this
SQLExceptionobject.SQLExceptiongetNextException()Retrieves the exception chained to this
SQLExceptionobject by setNextException(SQLException ex).StringgetSQLState()Retrieves the SQLState for this
SQLExceptionobject.Iterator<Throwable>iterator()Returns an iterator over the chained SQLExceptions.
voidsetNextException(SQLException ex)Adds an
SQLExceptionobject to the end of the chain.Methods declared in class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Constructor Details
-
SQLException
public SQLException(String reason, String SQLState, int vendorCode)
Constructs a
SQLExceptionobject with a givenreason,SQLStateandvendorCode. Thecauseis not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable)method.- Parameters:
reason- a description of the exceptionSQLState- an XOPEN or SQL:2003 code identifying the exceptionvendorCode- a database vendor-specific exception code
-
SQLException
public SQLException(String reason, String SQLState)
Constructs a
SQLExceptionobject with a givenreasonandSQLState. Thecauseis not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable)method. The vendor code is initialized to 0.- Parameters:
reason- a description of the exceptionSQLState- an XOPEN or SQL:2003 code identifying the exception
-
SQLException
public SQLException(String reason)
Constructs a
SQLExceptionobject with a givenreason. TheSQLStateis initialized tonulland the vendor code is initialized to 0. Thecauseis not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable)method.- Parameters:
reason- a description of the exception
-
SQLException
public SQLException()
Constructs a
SQLExceptionobject. Thereason,SQLStateare initialized tonulland the vendor code is initialized to 0. Thecauseis not initialized, and may subsequently be initialized by a call to theThrowable.initCause(java.lang.Throwable)method. -
SQLException
public SQLException(Throwable cause)
Constructs a
SQLExceptionobject with a givencause. TheSQLStateis initialized tonulland the vendor code is initialized to 0. Thereasonis initialized tonullifcause==nullor tocause.toString()ifcause!=null.- Parameters:
cause- the underlying reason for thisSQLException(which is saved for later retrieval by thegetCause()method); may be null indicating the cause is non-existent or unknown.- Since:
- 1.6
-
SQLException
Constructs a
SQLExceptionobject with a givenreasonandcause. TheSQLStateis initialized tonulland the vendor code is initialized to 0.- Parameters:
reason- a description of the exception.cause- the underlying reason for thisSQLException(which is saved for later retrieval by thegetCause()method); may be null indicating the cause is non-existent or unknown.- Since:
- 1.6
-
SQLException
Constructs a
SQLExceptionobject with a givenreason,SQLStateandcause. The vendor code is initialized to 0.- Parameters:
reason- a description of the exception.sqlState- an XOPEN or SQL:2003 code identifying the exceptioncause- the underlying reason for thisSQLException(which is saved for later retrieval by thegetCause()method); may be null indicating the cause is non-existent or unknown.- Since:
- 1.6
-
SQLException
public SQLException(String reason, String sqlState, int vendorCode, Throwable cause)
Constructs a
SQLExceptionobject with a givenreason,SQLState,vendorCodeandcause.- Parameters:
reason- a description of the exceptionsqlState- an XOPEN or SQL:2003 code identifying the exceptionvendorCode- a database vendor-specific exception codecause- the underlying reason for thisSQLException(which is saved for later retrieval by thegetCause()method); may be null indicating the cause is non-existent or unknown.- Since:
- 1.6
-
-
Method Details
-
getSQLState
public String getSQLState()
Retrieves the SQLState for this
SQLExceptionobject.- Returns:
- the SQLState value
-
getErrorCode
public int getErrorCode()
Retrieves the vendor-specific exception code for this
SQLExceptionobject.- Returns:
- the vendor's error code
-
getNextException
Retrieves the exception chained to this
SQLExceptionobject by setNextException(SQLException ex).- Returns:
- the next
SQLExceptionobject in the chain;nullif there are none - See Also:
setNextException(java.sql.SQLException)
-
setNextException
Adds an
SQLExceptionobject to the end of the chain.- Parameters:
ex- the new exception that will be added to the end of theSQLExceptionchain- See Also:
getNextException()
-
iterator
Returns an iterator over the chained SQLExceptions. The iterator will be used to iterate over each SQLException and its underlying cause (if any).
-
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2019, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.