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  /**
24   * This token represents normal character data.
25   */
26  public interface CharDataToken extends Token {
27  
28      /**
29       * Indicates if this character data was enclosed within a
30       * <code>CDATA</code> section.
31       *
32       * @return  <code>true</code> if this character data was enclosed within a
33       * <code>CDATA</code> section, <code>false</code> otherwise
34       */
35      boolean isCDATA();
36  
37      /**
38       * Indicates if this character data is made up of ignorable whitespace.
39       *
40       * @return  <code>true</code> if this character data is made up of
41       * ignorable whitespace, <code>false</code> otherwise
42       */
43      boolean isIgnorableWhitespace();
44  
45      /**
46       * Returns the character data for this token.
47       *
48       * @return  a <code>String</code> holding the character data for this token
49       */
50      String getCharData();
51  
52  }