public class PluginAssertionFailure extends RuntimeException
This class is intended to be used in assertion statements, similar to the way that java 1.4's native assertion mechanism is used. However there is a difference: when a java 1.4 assertion fails, an AssertionError is thrown, which is a subclass of Error; here, the PluginAssertionFailure class extends RuntimeException rather than Error.
This difference in design is because throwing Error objects is not good in a container-based architecture.
Example:
if ( impossibleCondition ) { throw new PluginAssertionFailure( "internal error: impossible condition is true" ); }
Note that PluginAssertionFailure should not be thrown when user input is bad, or when code external to the Digester module passes invalid parameters to a plugins method. It should be used only in checks for problems which indicate internal bugs within the plugins module.
Constructor and Description |
---|
PluginAssertionFailure(String msg)
Constructs a new exception with the specified detail message.
|
PluginAssertionFailure(String msg,
Throwable cause)
Constructs a new exception with the specified detail message and cause.
|
PluginAssertionFailure(Throwable cause)
Constructs a new exception with the specified cause.
|
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
public PluginAssertionFailure(Throwable cause)
cause
- underlying exception that caused this to be thrownpublic PluginAssertionFailure(String msg)
msg
- describes the reason this exception is being thrown.public PluginAssertionFailure(String msg, Throwable cause)
msg
- describes the reason this exception is being thrown.cause
- underlying exception that caused this to be thrownCopyright © 2001-2013 The Apache Software Foundation. All Rights Reserved.