|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
org.apache.derby.iapi.error.StandardException
public class StandardException
StandardException is the root of all exceptions that are handled in a standard fashion by the database code, mainly in the language code.
This class is abstract to ensure that an implementation only throws a specific exception (e.g. TransactionException) which is a sub-class
A method in an iterface in a protocol under com.ibm.db2j.protocol.Database must only throw a StandardException (if it needs to throw an exception). This indicates that the method can throw an exception and therefore its caller must ensure that any resources it allocates will be cleaned up in the event of an exception in the StandardException hierarchy.
Implementations of methods that throw StandardException can have throws clause that are more specific than StandardException.
Nested Class Summary | |
---|---|
static class |
StandardException.BadMessageArgumentException
Dummy exception to catch incorrect use of StandardException.newException(), at compile-time. |
Field Summary | |
---|---|
private java.lang.Object[] |
arguments
|
private int |
report
|
static int |
REPORT_ALWAYS
|
static int |
REPORT_DEFAULT
|
static int |
REPORT_NEVER
|
private int |
severity
|
private java.lang.String |
sqlState
|
private java.lang.String |
textMessage
|
Constructor Summary | |
---|---|
protected |
StandardException(java.lang.String messageID)
|
protected |
StandardException(java.lang.String messageID,
java.lang.Object[] args)
|
private |
StandardException(java.lang.String sqlState,
java.lang.String text)
This constructor is used when we already have the message text. |
protected |
StandardException(java.lang.String messageID,
java.lang.Throwable t,
java.lang.Object[] args)
|
Method Summary | |
---|---|
static StandardException |
closeException()
A special exception to close a session. |
static java.sql.SQLException |
getArgumentFerry(java.sql.SQLException se)
Unpack the exception, looking for an DerbySQLException, which carries the Derby messageID and arguments. |
java.lang.Object[] |
getArguments()
Returns the arguments for this exception, if there are any. |
int |
getErrorCode()
|
java.lang.String |
getErrorProperty(java.lang.String type)
Get the error code for an error given a type. |
private static java.lang.String |
getErrorProperty(java.lang.String messageId,
java.lang.String type)
|
java.lang.String |
getMessage()
The message stored in the super class Throwable must be set up object creation. |
java.lang.String |
getMessageId()
Return the message identifier that is used to look up the error message text in the messages.properties file. |
int |
getSeverity()
|
static int |
getSeverityFromIdentifier(java.lang.String messageID)
Get the severity given a message identifier from org.apache.derby.iapi.reference.SQLState. |
java.lang.String |
getSQLState()
Return the 5 character SQL State. |
static java.lang.String |
getSQLStateFromIdentifier(java.lang.String messageID)
Convert a message identifer from org.apache.derby.iapi.reference.SQLState to a SQLState five character string. |
static StandardException |
interrupt(java.lang.InterruptedException ie)
|
static StandardException |
newException(java.lang.String messageID)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Object a1)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Object[] a1)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Object a1,
java.lang.Object a2)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Object a1,
java.lang.Object a2,
java.lang.Object a3)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Object a1,
java.lang.Object a2,
java.lang.Object a3,
java.lang.Object a4)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Object a1,
java.lang.Object a2,
java.lang.Object a3,
java.lang.Object a4,
java.lang.Object a5)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Object a1,
java.lang.Object a2,
java.lang.Object a3,
java.lang.Object a4,
java.lang.Object a5,
java.lang.Object a6)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Object a1,
java.lang.Object a2,
java.lang.Object a3,
java.lang.Object a4,
java.lang.Object a5,
java.lang.Object a6,
java.lang.Object a7)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Object a1,
java.lang.Object a2,
java.lang.Object a3,
java.lang.Object a4,
java.lang.Object a5,
java.lang.Object a6,
java.lang.Object a7,
java.lang.Object a8)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Object a1,
java.lang.Object a2,
java.lang.Throwable t)
Dummy overload which should never be called. |
static StandardException |
newException(java.lang.String messageID,
java.lang.Object a1,
java.lang.Throwable t)
Dummy overload which should never be called. |
static StandardException |
newException(java.lang.String messageID,
java.lang.Throwable t)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Throwable t,
java.lang.Object a1)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Throwable t,
java.lang.Object a1,
java.lang.Object a2)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Throwable t,
java.lang.Object a1,
java.lang.Object a2,
java.lang.Object a3)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Throwable t,
java.lang.Object a1,
java.lang.Object a2,
java.lang.Object a3,
java.lang.Object a4)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Throwable t,
java.lang.Object a1,
java.lang.Object a2,
java.lang.Object a3,
java.lang.Object a4,
java.lang.Object a5)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Throwable t,
java.lang.Object a1,
java.lang.Object a2,
java.lang.Object a3,
java.lang.Object a4,
java.lang.Object a5,
java.lang.Object a6)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Throwable t,
java.lang.Object a1,
java.lang.Object a2,
java.lang.Object a3,
java.lang.Object a4,
java.lang.Object a5,
java.lang.Object a6,
java.lang.Object a7)
|
static StandardException |
newException(java.lang.String messageID,
java.lang.Throwable t,
java.lang.Object a1,
java.lang.Object a2,
java.lang.Object a3,
java.lang.Object a4,
java.lang.Object a5,
java.lang.Object a6,
java.lang.Object a7,
java.lang.Object a8)
|
static StandardException |
newPreLocalizedException(java.lang.String MessageID,
java.lang.Throwable t,
java.lang.String localizedMessage)
Creates a new StandardException using message text that has already been localized. |
static java.sql.SQLWarning |
newWarning(java.lang.String messageId)
|
static java.sql.SQLWarning |
newWarning(java.lang.String messageId,
java.lang.Object a1)
|
static java.sql.SQLWarning |
newWarning(java.lang.String messageId,
java.lang.Object a1,
java.lang.Object a2)
|
private static java.sql.SQLWarning |
newWarningCommon(java.lang.String messageId,
java.lang.Object[] oa)
|
static StandardException |
normalClose()
|
static StandardException |
plainWrapException(java.lang.Throwable t)
Similar to unexpectedUserException but makes no assumtion about when the execption is being called. |
int |
report()
Yes, report me. |
private void |
setArguments(java.lang.Object[] arguments)
Sets the arguments for this exception. |
void |
setReport(int report)
Set my report type. |
void |
setSeverity(int severity)
|
java.lang.String |
toString()
Don't print the class name in the toString() method. |
static StandardException |
unexpectedUserException(java.lang.Throwable t)
|
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int REPORT_DEFAULT
public static final int REPORT_NEVER
public static final int REPORT_ALWAYS
private transient java.lang.Object[] arguments
private int severity
private java.lang.String textMessage
private java.lang.String sqlState
private transient int report
Constructor Detail |
---|
protected StandardException(java.lang.String messageID)
protected StandardException(java.lang.String messageID, java.lang.Object[] args)
protected StandardException(java.lang.String messageID, java.lang.Throwable t, java.lang.Object[] args)
private StandardException(java.lang.String sqlState, java.lang.String text)
sqlState
- the sql state of the messagetext
- the text of the messageMethod Detail |
---|
private final void setArguments(java.lang.Object[] arguments)
public final java.lang.Object[] getArguments()
public final int report()
public final void setReport(int report)
public final void setSeverity(int severity)
public final int getSeverity()
public final int getErrorCode()
public final java.lang.String getSQLState()
public static java.lang.String getSQLStateFromIdentifier(java.lang.String messageID)
messageID
- - the sql state id of the message from Derby
public static int getSeverityFromIdentifier(java.lang.String messageID)
public static StandardException normalClose()
public static StandardException newException(java.lang.String messageID)
public static StandardException newException(java.lang.String messageID, java.lang.Throwable t)
public static StandardException newException(java.lang.String messageID, java.lang.Object a1)
public static StandardException newException(java.lang.String messageID, java.lang.Object[] a1)
public static StandardException newException(java.lang.String messageID, java.lang.Throwable t, java.lang.Object a1)
public static StandardException newException(java.lang.String messageID, java.lang.Object a1, java.lang.Object a2)
public static StandardException newException(java.lang.String messageID, java.lang.Object a1, java.lang.Throwable t) throws StandardException.BadMessageArgumentException
messageID
- - the sql state id of the messagea1
- - Message argt
- - Incorrectly placed exception to be nested
StandardException.BadMessageArgumentException
- - always (dummy)public static StandardException newException(java.lang.String messageID, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2)
public static StandardException newException(java.lang.String messageID, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3)
public static StandardException newException(java.lang.String messageID, java.lang.Object a1, java.lang.Object a2, java.lang.Throwable t) throws StandardException.BadMessageArgumentException
messageID
- - the sql state id of the messagea1
- - First message arga2
- - Second message argt
- - Incorrectly placed exception to be nested
StandardException.BadMessageArgumentException
- - always (dummy)public static StandardException newException(java.lang.String messageID, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3)
public static StandardException newException(java.lang.String messageID, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4)
public static StandardException newException(java.lang.String messageID, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4)
public static StandardException newException(java.lang.String messageID, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5)
public static StandardException newException(java.lang.String messageID, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5)
public static StandardException newException(java.lang.String messageID, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5, java.lang.Object a6)
public static StandardException newException(java.lang.String messageID, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5, java.lang.Object a6)
public static StandardException newException(java.lang.String messageID, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5, java.lang.Object a6, java.lang.Object a7)
public static StandardException newException(java.lang.String messageID, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5, java.lang.Object a6, java.lang.Object a7)
public static StandardException newException(java.lang.String messageID, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5, java.lang.Object a6, java.lang.Object a7, java.lang.Object a8)
public static StandardException newException(java.lang.String messageID, java.lang.Throwable t, java.lang.Object a1, java.lang.Object a2, java.lang.Object a3, java.lang.Object a4, java.lang.Object a5, java.lang.Object a6, java.lang.Object a7, java.lang.Object a8)
public static StandardException newPreLocalizedException(java.lang.String MessageID, java.lang.Throwable t, java.lang.String localizedMessage)
MessageID
- The SQLState and severity are derived from the ID. However the text message is not.t
- The Throwable that caused this exception, null if this exception was not caused by another Throwable.localizedMessage
- The message associated with this exception.
It is the caller's responsibility to ensure that this message is properly localized.
See org.apache.derby.iapi.tools.i18n.LocalizedResourcepublic static java.sql.SQLException getArgumentFerry(java.sql.SQLException se)
SQLExceptionFactory
,
SQLExceptionFactory40
,
Util
public static StandardException unexpectedUserException(java.lang.Throwable t)
public static StandardException plainWrapException(java.lang.Throwable t)
public static StandardException closeException()
public java.lang.String getMessage()
Thus the message stored by Throwable and obtained by the getMessage() of Throwable (ie. super.getMessage() in this class) is the message identifier. The actual text message is stored in this class at the first request.
getMessage
in class java.lang.Throwable
public final java.lang.String getMessageId()
public java.lang.String getErrorProperty(java.lang.String type)
public java.lang.String toString()
toString
in class java.lang.Throwable
private static java.lang.String getErrorProperty(java.lang.String messageId, java.lang.String type)
public static StandardException interrupt(java.lang.InterruptedException ie)
public static java.sql.SQLWarning newWarning(java.lang.String messageId)
public static java.sql.SQLWarning newWarning(java.lang.String messageId, java.lang.Object a1)
public static java.sql.SQLWarning newWarning(java.lang.String messageId, java.lang.Object a1, java.lang.Object a2)
private static java.sql.SQLWarning newWarningCommon(java.lang.String messageId, java.lang.Object[] oa)
|
Built on Thu 2010-12-23 20:49:13+0000, from revision ??? | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |