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.token;
22  
23  import org.millscript.commons.util.IMap;
24  import org.millscript.commons.xml.api.Attributes;
25  import org.millscript.commons.xml.api.Name;
26  
27  /**
28   * This token represents a start tag.
29   */
30  public interface StartTagToken extends Token {
31  
32      /**
33       * Returns the attributes associated with this start tag.
34       *
35       * @return  an <code>Attributes</code> instance for this elements
36       * attributes
37       */
38      Attributes getAttributes();
39  
40      /**
41       * Returns the <code>Name</code> of the start tag.
42       *
43       * @return  the <code>Name</code> of the start tag
44       */
45      Name getName();
46  
47      /**
48       * Returns the mapping of namespace prefix to namespace IRI that are in
49       * scope for this start tag.
50       *
51       * @return  an <code>IMap</code> containing the in scope namespace prefix
52       * to IRI mapping for this start tag
53       */
54      IMap< String, String > getNamespaceScope();
55  
56      /**
57       * Returns the mapping of namespace prefix to namespace IRI that were in
58       * scope just before this start tag.
59       *
60       * @return  an <code>IMap</code> containing the in scope namespace prefix
61       * to IRI mapping that were in scope just before this start tag
62       */
63      IMap< String, String > getPreviousNamespaceScope();
64  
65  }