org.apache.commons.digester.plugins
Class PluginAssertionFailure

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.lang.RuntimeException
                    |
                    +--org.apache.commons.digester.plugins.PluginAssertionFailure
All Implemented Interfaces:
java.io.Serializable

public class PluginAssertionFailure
extends java.lang.RuntimeException

Thrown when a bug is detected in the plugins code.

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.

Since:
1.6
See Also:
Serialized Form

Field Summary
private  java.lang.Throwable cause
           
 
Fields inherited from class java.lang.RuntimeException
 
Fields inherited from class java.lang.Throwable
 
Constructor Summary
PluginAssertionFailure(java.lang.String msg)
           
PluginAssertionFailure(java.lang.String msg, java.lang.Throwable cause)
           
PluginAssertionFailure(java.lang.Throwable cause)
           
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

cause

private java.lang.Throwable cause
Constructor Detail

PluginAssertionFailure

public PluginAssertionFailure(java.lang.Throwable cause)
Parameters:
cause - underlying exception that caused this to be thrown

PluginAssertionFailure

public PluginAssertionFailure(java.lang.String msg)
Parameters:
msg - describes the reason this exception is being thrown.

PluginAssertionFailure

public PluginAssertionFailure(java.lang.String msg,
                              java.lang.Throwable cause)
Parameters:
msg - describes the reason this exception is being thrown.
cause - underlying exception that caused this to be thrown


Copyright (c) 2001-2004 - Apache Software Foundation