Package org.datanucleus.exceptions
Class NucleusException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.lang.RuntimeException
-
- org.datanucleus.exceptions.NucleusException
-
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
ClassNotResolvedException
,CommitStateTransitionException
,IllegalStateTransitionException
,NoQueryResultsException
,NotYetFlushedException
,NucleusCanRetryException
,NucleusDataStoreException
,NucleusEnhanceException
,NucleusObjectNotFoundException
,NucleusOptimisticException
,NucleusTransactionException
,NucleusUserException
,PrimaryExpressionIsClassLiteralException
,PrimaryExpressionIsClassStaticFieldException
,PrimaryExpressionIsInvokeException
,PrimaryExpressionIsVariableException
,QueryInterruptedException
,QueryTimeoutException
,RollbackStateTransitionException
,ValueGenerationException
public class NucleusException extends RuntimeException
Base exception thrown by DataNucleus.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description NucleusException()
Constructs a new exception without a detail message.NucleusException(String msg)
Constructs a new exception with the specified detail message.NucleusException(String msg, Object failed)
Constructs a new exception with the specified detail message and failed object.NucleusException(String msg, Throwable nested)
Constructs a new exception with the specified detail message and nestedThrowable
.NucleusException(String msg, Throwable[] nested)
Constructs a new exception with the specified detail message and nestedThrowable
s.NucleusException(String msg, Throwable[] nested, Object failed)
Constructs a new exception with the specified detail message, nestedThrowable
s, and failed object.NucleusException(String msg, Throwable nested, Object failed)
Constructs a new exception with the specified detail message, nestedThrowable
, and failed object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Throwable
getCause()
Return the first nested exception (if any), otherwise null.Object
getFailedObject()
The exception may include a failed object.Throwable[]
getNestedExceptions()
The exception may have been caused by multiple exceptions in the runtime.boolean
isFatal()
Accessor for whether the exception is fatal, or retriable.void
printStackTrace()
Prints thisException
and its backtrace to the standard error output.void
printStackTrace(PrintStream s)
Prints thisException
and its backtrace to the specified print stream.void
printStackTrace(PrintWriter s)
Prints thisException
and its backtrace to the specified print writer.NucleusException
setFatal()
Method to set the exception as being fatal.void
setNestedException(Throwable nested)
-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString
-
-
-
-
Constructor Detail
-
NucleusException
public NucleusException()
Constructs a new exception without a detail message.
-
NucleusException
public NucleusException(String msg)
Constructs a new exception with the specified detail message.- Parameters:
msg
- the detail message.
-
NucleusException
public NucleusException(String msg, Throwable[] nested)
Constructs a new exception with the specified detail message and nestedThrowable
s.- Parameters:
msg
- the detail message.nested
- the nestedThrowable[]
.
-
NucleusException
public NucleusException(String msg, Throwable nested)
Constructs a new exception with the specified detail message and nestedThrowable
.- Parameters:
msg
- the detail message.nested
- the nestedThrowable
.
-
NucleusException
public NucleusException(String msg, Object failed)
Constructs a new exception with the specified detail message and failed object.- Parameters:
msg
- the detail message.failed
- the failed object.
-
NucleusException
public NucleusException(String msg, Throwable[] nested, Object failed)
Constructs a new exception with the specified detail message, nestedThrowable
s, and failed object.- Parameters:
msg
- the detail message.nested
- the nestedThrowable[]
.failed
- the failed object.
-
-
Method Detail
-
setFatal
public NucleusException setFatal()
Method to set the exception as being fatal. Returns the exception so that user code can call "throw new NucleusException(...).setFatal();"- Returns:
- This exception (for convenience)
-
isFatal
public boolean isFatal()
Accessor for whether the exception is fatal, or retriable.- Returns:
- Whether it is fatal
-
getFailedObject
public Object getFailedObject()
The exception may include a failed object.- Returns:
- the failed object.
-
setNestedException
public void setNestedException(Throwable nested)
-
getNestedExceptions
public Throwable[] 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
public Throwable getCause()
Return the first nested exception (if any), otherwise null.
-
printStackTrace
public void printStackTrace()
Prints thisException
and its backtrace to the standard error output. Print nested Throwables' stack trace as well.- Overrides:
printStackTrace
in classThrowable
-
printStackTrace
public void printStackTrace(PrintStream s)
Prints thisException
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
public void printStackTrace(PrintWriter s)
Prints thisException
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
-
-