View Javadoc

1   /*
2    * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
3    *
4    * This software is open source.
5    * See the bottom of this file for the licence.
6    */
7   
8   package org.dom4j;
9   
10  /***
11   * <p>
12   * <code>CharacterData</code> is a marker interface for character based nodes
13   * such as the <code>CDATA</code>,<code>Comment</code> and
14   * <code>Text</code> nodes.
15   * </p>
16   * 
17   * @author <a href="mailto:jstrachan@apache.org">James Strachan </a>
18   * @version $Revision: 1.9 $
19   */
20  public interface CharacterData extends Node {
21      /***
22       * Appends the given text to this nodes text value. Calling this method is
23       * equivalent of the code <code>node.setText(node.getText() + text)</code>
24       * but allows for possible implementation optimisations (such as a text
25       * based node storing a StringBuffer internally
26       * 
27       * @param text
28       *            the text to append
29       */
30      void appendText(String text);
31  }
32  
33  /*
34   * Redistribution and use of this software and associated documentation
35   * ("Software"), with or without modification, are permitted provided that the
36   * following conditions are met:
37   * 
38   * 1. Redistributions of source code must retain copyright statements and
39   * notices. Redistributions must also contain a copy of this document.
40   * 
41   * 2. Redistributions in binary form must reproduce the above copyright notice,
42   * this list of conditions and the following disclaimer in the documentation
43   * and/or other materials provided with the distribution.
44   * 
45   * 3. The name "DOM4J" must not be used to endorse or promote products derived
46   * from this Software without prior written permission of MetaStuff, Ltd. For
47   * written permission, please contact dom4j-info@metastuff.com.
48   * 
49   * 4. Products derived from this Software may not be called "DOM4J" nor may
50   * "DOM4J" appear in their names without prior written permission of MetaStuff,
51   * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
52   * 
53   * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
54   * 
55   * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
56   * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
57   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
58   * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
59   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
60   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
61   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
62   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
63   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
64   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
65   * POSSIBILITY OF SUCH DAMAGE.
66   * 
67   * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
68   */