org.inxar.affirm
Class AffirmationException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--org.inxar.affirm.AffirmationException
All Implemented Interfaces:
java.io.Serializable

public class AffirmationException
extends java.lang.Exception

AffirmationException are thrown by Affirmation implementations if and when the input they are affirming is discovered to be invalid. An error message and a flag are carried through on the AffirmationException back to the caller in the catch exception handling clause. The isFatal flag may be used to indicate that the error is severe enough such that further affirmations, if planned, should not be executed.

See Also:
Serialized Form

Field Summary
 boolean isFatal
          Flag to indicate if further affirmations for this key should be aborted (if true).
 
Constructor Summary
AffirmationException(java.lang.String msg, boolean isFatal)
          Contructs a new exception with an error message (eventually headed to a Detail in typical usage), the key, the value of (the bad data) itself, and the aforementioned flag.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

isFatal

public final boolean isFatal
Flag to indicate if further affirmations for this key should be aborted (if true).
Constructor Detail

AffirmationException

public AffirmationException(java.lang.String msg,
                            boolean isFatal)
Contructs a new exception with an error message (eventually headed to a Detail in typical usage), the key, the value of (the bad data) itself, and the aforementioned flag.