View Javadoc

1   ////////////////////////////////////////////////////////////////////////////////
2   // MillScript: an Open Spice interpreter and batch website creation tool
3   // Copyright (C) 2005 Kevin Rogers
4   //
5   // This file is part of MillScript.
6   //
7   // MillScript is free software; you can redistribute it and/or modify it under
8   // the terms of the GNU General Public License as published by the Free
9   // Software Foundation; either version 2 of the License, or (at your option)
10  // any later version.
11  //
12  // MillScript is distributed in the hope that it will be useful, but WITHOUT
13  // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
15  // more details.
16  //
17  // You should have received a copy of the GNU General Public License along with
18  // MillScript; if not, write to the Free Software Foundation, Inc., 59 Temple
19  // Place, Suite 330, Boston, MA  02111-1307  USA
20  ////////////////////////////////////////////////////////////////////////////////
21  package org.millscript.commons.alert.alerts;
22  
23  import org.millscript.commons.alert.Alert;
24  import org.millscript.commons.alert.Phase;
25  
26  /**
27   * This class represents an internal fault alert and is used in combination
28   * with a normal exception to indicate a abnormal internal condition in the
29   * system.
30   */
31  public class Fault extends Alert {
32  
33      /**
34       * This is the ID from the first release for future compatibility.
35       */
36      private static final long serialVersionUID = 3257282526501679664L;
37  
38      /**
39       * Constructs a new fault alert with no explanation.
40       */
41      public Fault() {
42          this( null );
43      }
44  
45      /**
46       * Constructs a new fault alert with the specified explanation.
47       *
48       * @param exp   the explanation for the alert
49       */
50      public Fault( final String exp ) {
51          this( "An unexpected internal fault has occured", exp );
52      }
53  
54      /**
55       * Constructs a new alert with the specified complaint and explanation.
56       * This constructor is for private use, to allow us to provide an exception
57       * hierarchy.
58       *
59       * @param comp  the complaint
60       * @param exp   the complaints explanation
61       */
62      protected Fault( final String comp, final String exp ) {
63          super( comp, exp );
64          this.setPhase( Phase.INTERNAL );
65      }
66  
67  }