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.api;
22  
23  /**
24   * This interface represents an attribute definition in the XML DTD model.
25   */
26  public interface AttDef {
27  
28      /**
29       * Returns the default declaration for this attribute definition.
30       *
31       * @return  a String representing the default declaration for this
32       * attribute definition, either <code>"#REQUIRED"</code>,
33       * <code>"#IMPLIED"</code> or <code>"#FIXED"</code>
34       * @todo    This should probably be handled by a visitor pattern or some
35       * other non string comparison way
36       */
37      String getDefaultDecl();
38  
39      /**
40       * Returns the default value for this attribute.
41       *
42       * @return  a String holding the default value for this attribute or
43       * <code>null</code> if there is no default
44       */
45      String getDefaultValue();
46  
47      /**
48       * Returns the name of the attribute this definition represents.
49       *
50       * @return  the <code>Name</code> of the attribute this definition
51       * represents
52       */
53      Name getName();
54  
55  }