java.io.Serializable
, Diagnosable
ColumnTypeConversionException
, DisconnectException
, OutsideRangeForDataTypeException
, SqlWarning
public class SqlException extends java.lang.Exception implements Diagnosable
Modifier and Type | Field | Description |
---|---|---|
private java.lang.String |
batchPositionLabel_ |
|
private java.lang.String |
cachedMessage_ |
|
private java.lang.String |
causeString_ |
|
static java.lang.String |
CLIENT_MESSAGE_RESOURCE_NAME |
|
private static int |
DEFAULT_ERRCODE |
|
private int |
errorcode_ |
|
private static SQLExceptionFactory |
exceptionFactory |
SQLException factory is initialized with default factory.
|
private java.lang.String |
message_ |
|
private int |
messageNumber_ |
Tells which of the messages in the SQLCA this exception refers to
(counting from 0).
|
private static MessageUtil |
msgutil_ |
The message utility instance we use to find messages
It's primed with the name of the client message bundle so that
it knows to look there if the message isn't found in the
shared message bundle.
|
protected SqlException |
nextException_ |
|
private Sqlca |
sqlca_ |
|
private java.lang.String |
sqlstate_ |
|
protected java.sql.SQLException |
wrappedException_ |
The wrapped SQLException, if one exists
|
Modifier | Constructor | Description |
---|---|---|
|
SqlException(java.sql.SQLException wrapme) |
Wrap a SQLException in a SqlException.
|
private |
SqlException(LogWriter logWriter,
java.lang.String reason,
java.lang.String sqlState,
int errorCode) |
|
private |
SqlException(LogWriter logWriter,
java.lang.Throwable throwable,
java.lang.String reason,
java.lang.String sqlState,
int errorCode) |
|
|
SqlException(LogWriter logwriter,
ClientMessageId msgid,
java.lang.Object... args) |
|
(package private) |
SqlException(LogWriter logwriter,
ClientMessageId msgid,
java.lang.Object[] args,
java.lang.Throwable cause) |
Create a SqlException.
|
(package private) |
SqlException(LogWriter logWriter,
ClientMessageId msgid,
java.lang.Object[] args,
SqlCode sqlcode,
java.lang.Throwable t) |
|
|
SqlException(LogWriter logWriter,
ClientMessageId msgid,
java.lang.Throwable cause,
java.lang.Object... args) |
|
|
SqlException(LogWriter logWriter,
ClientMessageId msgid,
SqlCode sqlcode,
java.lang.Object... args) |
|
|
SqlException(LogWriter logWriter,
Sqlca sqlca) |
Create an exception for an engine generated error.
|
private |
SqlException(Sqlca sqlca,
int number,
boolean chain) |
Create one of the exceptions in an exception chain generated by the
engine.
|
Modifier and Type | Method | Description |
---|---|---|
(package private) SqlException |
copyAsUnchainedSQLException(LogWriter logWriter) |
|
private java.lang.Object[] |
getArgs() |
|
int |
getErrorCode() |
|
java.lang.String |
getMessage() |
|
static MessageUtil |
getMessageUtil() |
This routine provides singleton access to an instance of MessageUtil
that is constructed for client messages.
|
SqlException |
getNextException() |
|
Sqlca |
getSqlca() |
|
java.sql.SQLException |
getSQLException() |
Convert this SqlException into a java.sql.SQLException
|
java.lang.String |
getSQLState() |
|
(package private) static SqlException |
javaException(LogWriter logWriter,
java.lang.Throwable e) |
Helper method to construct an exception which basically says that
we encountered an underlying Java exception
|
(package private) void |
setBatchPositionLabel(int index) |
|
void |
setNextException(java.sql.SQLException nextException) |
|
void |
setNextException(SqlException nextException) |
|
private void |
setThrowable(java.lang.Throwable throwable) |
Set the cause of this exception based on its type.
|
java.lang.String |
toString() |
private static final int DEFAULT_ERRCODE
private transient Sqlca sqlca_
private transient int messageNumber_
private java.lang.String message_
private java.lang.String cachedMessage_
private java.lang.String batchPositionLabel_
private java.lang.String sqlstate_
private int errorcode_
private java.lang.String causeString_
protected SqlException nextException_
public static final java.lang.String CLIENT_MESSAGE_RESOURCE_NAME
private static SQLExceptionFactory exceptionFactory
private static MessageUtil msgutil_
protected java.sql.SQLException wrappedException_
SqlException(LogWriter logwriter, ClientMessageId msgid, java.lang.Object[] args, java.lang.Throwable cause)
logwriter
- Can be null, but if provided, it is used to log this exceptionmsgid
- The message id for this message. ClientMessageId is a simple type-safe
wrapper for org.apache.derby.shared.common.reference.SQLState message id
strings.args
- The set of substitution arguments for the message. The Java message
formatter will substitute these arguments into the internationalized
strings using the substitution ({0}, {1}, etc.) markers in the string.
Any object can be passed, but if you want it to be readable, make sure
toString() for the object returns something useful.cause
- Can be null. Indicates the cause of this exception. If this is
an instance of SqlException or java.sql.SQLException then the exception
is chained into the nextException chain. Otherwise it is chained
using initCause().SqlException(LogWriter logWriter, ClientMessageId msgid, java.lang.Object[] args, SqlCode sqlcode, java.lang.Throwable t)
public SqlException(LogWriter logWriter, ClientMessageId msgid, SqlCode sqlcode, java.lang.Object... args)
public SqlException(LogWriter logWriter, ClientMessageId msgid, java.lang.Throwable cause, java.lang.Object... args)
public SqlException(LogWriter logwriter, ClientMessageId msgid, java.lang.Object... args)
public SqlException(LogWriter logWriter, Sqlca sqlca)
logWriter
- object used for tracingsqlca
- the SQLCA sent from the serverprivate SqlException(Sqlca sqlca, int number, boolean chain)
chain
is
true
.sqlca
- the SQLCA sent from the servernumber
- the message number for this exception (counting from 0)chain
- if true
, generate the rest of the exception
chain recursively and link it to this exceptionprivate SqlException(LogWriter logWriter, java.lang.String reason, java.lang.String sqlState, int errorCode)
private SqlException(LogWriter logWriter, java.lang.Throwable throwable, java.lang.String reason, java.lang.String sqlState, int errorCode)
public SqlException(java.sql.SQLException wrapme)
public static MessageUtil getMessageUtil()
private void setThrowable(java.lang.Throwable throwable)
SQLException
s and
SqlException
s are
linked with setNextException()
and
initCause()
.
All other exception types are linked with initCause()
.public java.sql.SQLException getSQLException()
void setBatchPositionLabel(int index)
public Sqlca getSqlca()
getSqlca
in interface Diagnosable
public java.lang.String toString()
toString
in class java.lang.Throwable
private java.lang.Object[] getArgs()
public java.lang.String getMessage()
getMessage
in class java.lang.Throwable
public java.lang.String getSQLState()
public int getErrorCode()
public SqlException getNextException()
public void setNextException(SqlException nextException)
public void setNextException(java.sql.SQLException nextException)
static SqlException javaException(LogWriter logWriter, java.lang.Throwable e)
SqlException copyAsUnchainedSQLException(LogWriter logWriter)
Apache Derby V10.14 Internals - Copyright © 2004,2018 The Apache Software Foundation. All Rights Reserved.