Main Page | Class Hierarchy | Class List | Class Members

org::jdom::CDATA Class Reference

Inheritance diagram for org::jdom::CDATA:

org::jdom::Text org::jdom::Content List of all members.

Public Member Functions

 CDATA (String str)
Text setText (String str)
void append (String str)
String toString ()

Protected Member Functions

 CDATA ()

Detailed Description

An XML CDATA section. Represents character-based content within an XML document that should be output within special CDATA tags. Semantically it's identical to a simple Text object, but output behavior is different. CDATA makes no guarantees about the underlying textual representation of character data, but does expose that data as a Java String.

Version:
Revision
1.30
,
Date
2004/02/27 11:32:57
Author:
Dan Schaffer

Brett McLaughlin

Jason Hunter

Bradley S. Huffman


Constructor & Destructor Documentation

org::jdom::CDATA::CDATA  )  [inline, protected]
 

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

org::jdom::CDATA::CDATA String  str  )  [inline]
 

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

Parameters:
str the node's character content.
Exceptions:
IllegalDataException if str contains an illegal character such as a vertical tab (as determined by org.jdom.Verifier#checkCharacterData) or the CDATA end delimiter ]]>.


Member Function Documentation

void org::jdom::CDATA::append String  str  )  [inline]
 

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

Parameters:
str character content to append.
Exceptions:
IllegalDataException if str contains an illegal character such as a vertical tab (as determined by org.jdom.Verifier#checkCharacterData) or the CDATA end delimiter ]]>.

Reimplemented from org::jdom::Text.

Text org::jdom::CDATA::setText String  str  )  [inline]
 

This will set the value of this CDATA node.

Parameters:
str value for node's content.
Returns:
the object on which the method was invoked
Exceptions:
IllegalDataException if str contains an illegal character such as a vertical tab (as determined by org.jdom.Verifier#checkCharacterData) or the CDATA end delimiter ]]>.

Reimplemented from org::jdom::Text.

String org::jdom::CDATA::toString  )  [inline]
 

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

Returns:
String - information about this node.

Reimplemented from org::jdom::Text.


The documentation for this class was generated from the following file:
Generated on Thu Dec 9 10:42:04 2004 for JDOM by  doxygen 1.3.9.1