org.jdom

Class CDATA

public class CDATA extends Text

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 {@link 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 Summary
protected CDATA()
This is the protected, no-args constructor standard in all JDOM classes.
CDATA(String str)
This constructor creates a new CDATA node, with the supplied string value as it's character content.
Method Summary
voidappend(String str)
This will append character content to whatever content already exists within this CDATA node.
TextsetText(String str)
This will set the value of this CDATA node.
StringtoString()
This returns a String representation of the CDATA node, suitable for debugging.

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(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.

Throws: IllegalDataException if str contains an illegal character such as a vertical tab (as determined by {@link org.jdom.Verifier#checkCharacterData}) or the CDATA end delimiter ]]>.

Method Detail

append

public void append(String str)
This will append character content to whatever content already exists within this CDATA node.

Parameters: str character content to append.

Throws: IllegalDataException if str contains an illegal character such as a vertical tab (as determined by {@link org.jdom.Verifier#checkCharacterData}) or the CDATA end delimiter ]]>.

setText

public Text setText(String str)
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

Throws: IllegalDataException if str contains an illegal character such as a vertical tab (as determined by {@link org.jdom.Verifier#checkCharacterData}) or the CDATA end delimiter ]]>.

toString

public 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 {@link #getText} or {@link org.jdom.output.XMLOutputter#output(CDATA, java.io.Writer)} should be used.

Returns: String - information about this node.

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