View Javadoc

1   ////////////////////////////////////////////////////////////////////////////////
2   // MillScript-XML: an Open Spice interpreter and batch website creation tool
3   // Copyright (C) 2005 Kevin Rogers
4   //
5   // This file is part of MillScript-XML.
6   //
7   // MillScript-XML 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-XML 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-XML; 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.xml.alerts;
22  
23  /**
24   * This class implements an Alert for use in situations like where an XML
25   * well-formedness constraint is violated.
26   */
27  public class XmlWellFormednessAlert extends XmlFatalErrorAlert {
28  
29      /**
30       * This is the ID from the first release for future compatibility.
31       */
32      private static final long serialVersionUID = -2418935338482215397L;
33  
34      /**
35       * Constructs a new XML well formedness constraint alert with no
36       * explanation.
37       */
38      public XmlWellFormednessAlert() {
39          this( null );
40      }
41  
42      /**
43       * Constructs a new XML well formedness constraint alert with the specified
44       * explanation.
45       *
46       * @param exp   the explanation for the alert
47       */
48      public XmlWellFormednessAlert( final String exp ) {
49          this( "XML document violates a well-formedness constraint", exp );
50      }
51  
52      /**
53       * Constructs a new alert with the specified complaint and explanation.
54       * This constructor is for private use, to allow us to provide an exception
55       * hierarchy.
56       *
57       * @param comp  the complaint
58       * @param exp   the complaints explanation
59       */
60      protected XmlWellFormednessAlert( final String comp, final String exp ) {
61          super( comp, exp );
62      }
63  
64  }