Package org.jdom2
Class CDATA
java.lang.Object
org.jdom2.Content
org.jdom2.Text
org.jdom2.CDATA
- All Implemented Interfaces:
Serializable
,Cloneable
,NamespaceAware
- Direct Known Subclasses:
LocatedCDATA
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.- Author:
- Dan Schaffer, Brett McLaughlin, Jason Hunter, Bradley S. Huffman, Victor Toni, Rolf Lear
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.jdom2.Content
Content.CType
-
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
This will append character content to whatever content already exists within thisCDATA
node.void
This will append the content of anotherText
node to this node.clone()
Return a deep clone of this instance.detach()
Detaches this child from its parent or does nothing if the child has no parent.protected CDATA
Sets the parent of this Content.This will set the value of thisCDATA
node.toString()
This returns aString
representation of theCDATA
node, suitable for debugging.Methods inherited from class org.jdom2.Text
getParent, getText, getTextNormalize, getTextTrim, getValue, normalizeString
Methods inherited from class org.jdom2.Content
equals, getCType, getDocument, getNamespacesInherited, getNamespacesInScope, getNamespacesIntroduced, getParentElement, hashCode
-
Constructor Details
-
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
This constructor creates a newCDATA
node, with the supplied string value as its character content.- Parameters:
string
- the node's character content.- Throws:
IllegalDataException
- ifstr
contains an illegal character such as a vertical tab (as determined byVerifier.checkCharacterData(java.lang.String)
) or the CDATA end delimiter]]>
.
-
-
Method Details
-
setText
This will set the value of thisCDATA
node.- Overrides:
setText
in classText
- Parameters:
str
- value for node's content.- Returns:
- the object on which the method was invoked
- Throws:
IllegalDataException
- ifstr
contains an illegal character such as a vertical tab (as determined byVerifier.checkCharacterData(java.lang.String)
) or the CDATA end delimiter]]>
.
-
append
This will append character content to whatever content already exists within thisCDATA
node.- Overrides:
append
in classText
- Parameters:
str
- character content to append.- Throws:
IllegalDataException
- ifstr
contains an illegal character such as a vertical tab (as determined byVerifier.checkCharacterData(java.lang.String)
) or the CDATA end delimiter]]>
.
-
append
This will append the content of anotherText
node to this node. -
toString
This returns aString
representation of theCDATA
node, suitable for debugging. If the XML representation of theCDATA
node is desired, either
orText.getText()
XMLOutputter.output(CDATA, java.io.Writer)
should be used. -
clone
Return a deep clone of this instance. Even if this instance has a parent, the returned clone will not.All JDOM core classes are Cloneable, and never throw CloneNotSupportedException. Additionally all Cloneable JDOM classes return the correct type of instance from this method and there is no need to cast the result (co-variant return value).
Subclasses of this should still call super.clone() in their clone method.
-
detach
Description copied from class:Content
Detaches this child from its parent or does nothing if the child has no parent.This method can be overridden by particular Content subclasses to return a specific type of Content (co-variant return type). All overriding subclasses must call
super.detach()
; -
setParent
Description copied from class:Content
Sets the parent of this Content. The caller is responsible for removing any pre-existing parentage.This method can be overridden by particular Content subclasses to return a specific type of Content (co-variant return type). All overriding subclasses must call
super.setParent(Parent)
;
-