org.jdom
Class CDATA

java.lang.Object
  |
  +--org.jdom.Text
        |
        +--org.jdom.CDATA
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class CDATA
extends Text

CDATA represents character-based content within an XML document represented by JDOM. It is intended to provide a modular, printable method of representing CDATA. Additionally, CDATA makes no guarantees about the underlying textual representation of character data, but does expose that data as a Java String.

Version:
$Revision: 1.21 $, $Date: 2002/04/06 08:47:57 $
Author:
Dan Schaffer, Brett McLaughlin, Jason Hunter, Bradley S. Huffman
See Also:
Serialized Form

Fields inherited from class org.jdom.Text
parent, value
 
Constructor Summary
protected CDATA()
          This is the protected, no-args constructor standard in all JDOM classes.
  CDATA(java.lang.String str)
          This constructor creates a new CDATA node, with the supplied string value as it's character content.
 
Method Summary
 void append(java.lang.String str)
          This will append character content to whatever content already exists within this CDATA node.
 Text setText(java.lang.String str)
          This will set the value of this CDATA node.
 java.lang.String toString()
          This returns a String representation of the CDATA node, suitable for debugging.
 
Methods inherited from class org.jdom.Text
append, clone, detach, equals, getDocument, getParent, getText, getTextNormalize, getTextTrim, hashCode, normalizeString, setParent
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CDATA

protected CDATA()

This is the protected, no-args constructor standard in all JDOM classes. It allows subclassers to get a raw instance with no initialization.


CDATA

public CDATA(java.lang.String str)

This constructor creates a new CDATA node, with the supplied string value as it's character content.

Parameters:
str - the node's character content.
Method Detail

setText

public Text setText(java.lang.String str)

This will set the value of this CDATA node.

Overrides:
setText in class Text
Parameters:
str - value for node's content.

append

public void append(java.lang.String str)

This will append character content to whatever content already exists within this CDATA node.

Overrides:
append in class Text
Parameters:
str - character content to append.

toString

public java.lang.String toString()

This returns a String representation of the CDATA node, suitable for debugging. If the XML representation of the CDATA node is desired, either Text.getText() or XMLOutputter.output(CDATA, Writer) should be used.

Overrides:
toString in class Text
Returns:
String - information about this node.


Copyright © 2002 Jason Hunter, Brett McLaughlin. All Rights Reserved.