Package javax.jdo
Class JDOException
java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
javax.jdo.JDOException
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
JDOCanRetryException
,JDOFatalException
This is the root of all JDO Exceptions. It contains an optional detail
message, an optional nested
Throwable
array and an optional failed object.- Version:
- 1.0.2
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) Object
This exception may be the result of incorrect parameters supplied to an API.private boolean
Flag indicating whether printStackTrace is being executed.private static I18NHelper
The Internationalization message helper.(package private) Throwable[]
This exception was generated because of an exception in the runtime library. -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a newJDOException
without a detail message.JDOException
(String msg) Constructs a newJDOException
with the specified detail message.JDOException
(String msg, Object failed) Constructs a newJDOException
with the specified detail message and failed object.JDOException
(String msg, Throwable nested) Constructs a newJDOException
with the specified detail message and nestedThrowable
.JDOException
(String msg, Throwable[] nested) Constructs a newJDOException
with the specified detail message and nestedThrowable
s.JDOException
(String msg, Throwable[] nested, Object failed) Constructs a newJDOException
with the specified detail message, nestedThrowable
s, and failed object.JDOException
(String msg, Throwable nested, Object failed) Constructs a newJDOException
with the specified detail message, nestedThrowable
, and failed object. -
Method Summary
Modifier and TypeMethodDescriptionprivate static String
Helper method returning a short description of the exception passed as an argument.getCause()
Often there is only one nested exception, and this method returns it.The exception may include a failed object.The exception may have been caused by multiple exceptions in the runtime.JDK 1.4 includes a new chaining mechanism for Throwable, but since JDO has its own "legacy" chaining mechanism, the "standard" mechanism cannot be used.void
Prints thisJDOException
and its backtrace to the standard error output.void
Prints thisJDOException
and its backtrace to the specified print stream.void
Prints thisJDOException
and its backtrace to the specified print writer.toString()
TheString
representation includes the name of the class, the descriptive comment (if any), theString
representation of the failedObject
(if any), and theString
representation of the nestedThrowable
s (if any).Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, setStackTrace
-
Field Details
-
nested
Throwable[] nestedThis exception was generated because of an exception in the runtime library. -
failed
Object failedThis exception may be the result of incorrect parameters supplied to an API. This is the object from which the user can determine the cause of the problem. -
msg
The Internationalization message helper. -
inPrintStackTrace
private boolean inPrintStackTraceFlag indicating whether printStackTrace is being executed.
-
-
Constructor Details
-
JDOException
public JDOException()Constructs a newJDOException
without a detail message. -
JDOException
Constructs a newJDOException
with the specified detail message.- Parameters:
msg
- the detail message.
-
JDOException
Constructs a newJDOException
with the specified detail message and nestedThrowable
s.- Parameters:
msg
- the detail message.nested
- the nestedThrowable[]
.
-
JDOException
Constructs a newJDOException
with the specified detail message and nestedThrowable
.- Parameters:
msg
- the detail message.nested
- the nestedThrowable
.
-
JDOException
Constructs a newJDOException
with the specified detail message and failed object.- Parameters:
msg
- the detail message.failed
- the failed object.
-
JDOException
Constructs a newJDOException
with the specified detail message, nestedThrowable
s, and failed object.- Parameters:
msg
- the detail message.nested
- the nestedThrowable[]
.failed
- the failed object.
-
JDOException
Constructs a newJDOException
with the specified detail message, nestedThrowable
, and failed object.- Parameters:
msg
- the detail message.nested
- the nestedThrowable
.failed
- the failed object.
-
-
Method Details
-
getFailedObject
The exception may include a failed object.- Returns:
- the failed object.
-
getNestedExceptions
The exception may have been caused by multiple exceptions in the runtime. If multiple objects caused the problem, each failed object will have its ownException
.- Returns:
- the nested Throwable array.
-
getCause
Often there is only one nested exception, and this method returns it. If there are more than one, then this method returns the first nested exception. If there is no nested exception, then null is returned. -
initCause
JDK 1.4 includes a new chaining mechanism for Throwable, but since JDO has its own "legacy" chaining mechanism, the "standard" mechanism cannot be used. This method always throws a JDOFatalInternalException. -
toString
TheString
representation includes the name of the class, the descriptive comment (if any), theString
representation of the failedObject
(if any), and theString
representation of the nestedThrowable
s (if any). -
printStackTrace
public void printStackTrace()Prints thisJDOException
and its backtrace to the standard error output. Print nested Throwables' stack trace as well.- Overrides:
printStackTrace
in classThrowable
-
printStackTrace
Prints thisJDOException
and its backtrace to the specified print stream. Print nested Throwables' stack trace as well.- Overrides:
printStackTrace
in classThrowable
- Parameters:
s
-PrintStream
to use for output
-
printStackTrace
Prints thisJDOException
and its backtrace to the specified print writer. Print nested Throwables' stack trace as well.- Overrides:
printStackTrace
in classThrowable
- Parameters:
s
-PrintWriter
to use for output
-
exceptionToString
Helper method returning a short description of the exception passed as an argument. The returned string has the format defined by Throwable.toString. If the exception has a non-null detail message string, then it returns the name of exception class concatenated with ": " concatenated with the detailed message. Otherwise it returns the name of exception class.- Parameters:
ex
- the exception to be represented.- Returns:
- a string representation of the exception passed as an argument.
-