001    /* Copyright 2000, 2001, Compaq Computer Corporation */
002    
003    package javafe.util;
004    
005    /**
006     * A <code>FatalError</code> is an unchecked exception thrown only by
007     * <code>ErrorSet.fatal</code> that indicates that a fatal error has
008     * been encountered, forcing all further processing to be
009     * abandoned.  Note that this is really an Exception, not an Error.
010     * 
011     * <p> The cause and existence of a fatal error will already have been
012     * reported to the user by the time the <code>FatalError</code> has
013     * been thrown.<p>
014     *
015     * <p> <code>FatalError</code> must be caught by the top level of the
016     * <code>Tool</code> so that any needed cleanup can be done before the
017     * <code>Tool</code> exits.  <code>FatalError</code>s should be caught
018     * anywhere else only for local cleanup purposes.
019     */
020    
021    public class FatalError extends java.lang.RuntimeException {
022      private static final long serialVersionUID = 4916981747846620833L;
023      
024      /**
025       * Create a <code>FatalError</code> exception.  This constructor is
026       * intended to be called only by <code>ErrorSet.fatal</code>.
027       */
028      //@ normal_behavior
029      //@ modifies this.*;
030      /* package*/ FatalError() {
031        super("A fatal Error has occurred");
032      }
033    }