org::jdom::CDATA Class Reference

Inheritance diagram for org::jdom::CDATA:

org::jdom::Text 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

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.

Author:
Dan Schaffer

Brett McLaughlin

Jason Hunter

Bradley S. Huffman

Version:
Revision
1.26
,
Date
2003/04/08 04:14:49


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

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

This will set the value of this CDATA node.

Parameters:
str value for node's 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 ]]>.

Reimplemented from org::jdom::Text.

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.

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 Sat Nov 11 01:47:11 2006 for JDOM by  doxygen 1.5.1