SQLException
open class SQLException : Exception, MutableIterable<Throwable!>
kotlin.Any | |||
↳ | kotlin.Throwable | ||
↳ | java.lang.Exception | ||
↳ | java.sql.SQLException |
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
getMesasge
. - 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
DatabaseMetaData
methodgetSQLStateType
can 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
.
Summary
Public constructors | |
---|---|
SQLException(reason: String!, SQLState: String!, vendorCode: Int) Constructs a |
|
SQLException(reason: String!, SQLState: String!) Constructs a |
|
SQLException(reason: String!) Constructs a |
|
Constructs a |
|
SQLException(cause: Throwable!) Constructs a |
|
SQLException(reason: String!, cause: Throwable!) Constructs a |
|
SQLException(reason: String!, sqlState: String!, cause: Throwable!) Constructs a |
|
SQLException(reason: String!, sqlState: String!, vendorCode: Int, cause: Throwable!) Constructs a |
Public methods | |
---|---|
open Int |
Retrieves the vendor-specific exception code for this |
open SQLException! |
Retrieves the exception chained to this |
open String! |
Retrieves the SQLState for this |
open MutableIterator<Throwable!> |
iterator() Returns an iterator over the chained SQLExceptions. |
open Unit |
setNextException(ex: SQLException!) Adds an |
Public constructors
SQLException
SQLException(
reason: String!,
SQLState: String!,
vendorCode: Int)
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 |
SQLException
SQLException(
reason: String!,
SQLState: String!)
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 |
SQLException
SQLException(reason: String!)
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 Throwable#initCause(java.lang.Throwable)
method.
Parameters | |
---|---|
reason |
String!: a description of the exception |
SQLException
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.
SQLException
SQLException(cause: Throwable!)
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. |
SQLException
SQLException(
reason: String!,
cause: Throwable!)
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. |
SQLException
SQLException(
reason: String!,
sqlState: String!,
cause: Throwable!)
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. |
SQLException
SQLException(
reason: String!,
sqlState: String!,
vendorCode: Int,
cause: Throwable!)
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. |
Public methods
getErrorCode
open fun getErrorCode(): Int
Retrieves the vendor-specific exception code for this SQLException
object.
Return | |
---|---|
Int |
the vendor's error code |
getNextException
open fun getNextException(): SQLException!
Retrieves the exception chained to this SQLException
object by setNextException(SQLException ex).
Return | |
---|---|
SQLException! |
the next SQLException object in the chain; null if there are none |
See Also
getSQLState
open fun getSQLState(): String!
Retrieves the SQLState for this SQLException
object.
Return | |
---|---|
String! |
the SQLState value |
iterator
open fun iterator(): MutableIterator<Throwable!>
Returns an iterator over the chained SQLExceptions. The iterator will be used to iterate over each SQLException and its underlying cause (if any).
Return | |
---|---|
MutableIterator<Throwable!> |
an iterator over the chained SQLExceptions and causes in the proper order |
setNextException
open fun setNextException(ex: SQLException!): Unit
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