JDOM 2.0.6.1 · org.jdom2.Text

Modifier and Type	Field and Description
pack-priv static final String	EMPTY_STRING
private static final long	serialVersionUID Hides org.jdom2.Content.serialVersionUID. JDOM2 Serialization.
protected String	value The actual character content

Access	Constructor and Description
protected	Text(Content.CType The CType to set for this Text-based Content. ctype) CData type extends Text, and it needs to be able to change the Content type of this Content.
protected	Text() This is the protected, no-args constructor standard in all JDOM classes.
public	Text(String the node's character content. str) This constructor creates a new `Text` node, with the supplied string value as its character content.

Method Summary

Modifier and Type	Method and Description
public void	append(String character content to append. str) This will append character content to whatever content already exists within this `Text` node.
public void	append(Text Text node to append. text) This will append the content of another `Text` node to this node.
public Text	clone() Overrides org.jdom2.Content.clone. Return a deep clone of this instance.
public Text	detach() Overrides org.jdom2.Content.detach. Detaches this child from its parent or does nothing if the child has no parent.
public Element	getParent() Overrides org.jdom2.Content.getParent. Return this child's parent, or null if this child is currently not attached.
public String	Returns: `String` - character content of this node. getText() This returns the value of this `Text` node as a Java `String`.
public String	Returns: normalized text content or empty string getTextNormalize() This returns the textual content with all surrounding whitespace removed and internal whitespace normalized to a single space.
public String	Returns: trimmed text content or empty string getTextTrim() This returns the textual content with all surrounding whitespace removed.
public String	Returns: the text getValue() Implements abstract org.jdom2.Content.getValue. Returns the XPath 1.0 string value of this element, which is the text itself.
public static String	Returns: normalized string or empty string normalizeString(String string to be normalized. str) This returns a new string with all surrounding whitespace removed and internal whitespace normalized to a single space.
protected Text	setParent(Parent new parent element parent) Overrides org.jdom2.Content.setParent. Sets the parent of this Content.
public Text	Returns: the object on which the method was invoked setText(String value for node's content. str) This will set the value of this `Text` node.
public String	Returns: `String` - information about this node. toString() Overrides java.lang.Object.toString. This returns a `String` representation of the `Text` node, suitable for debugging.

Inherited from org.jdom2.Content:: equals getCType getDocument getNamespacesInherited getNamespacesInScope getNamespacesIntroduced getParentElement hashCode

EMPTY_STRING	back to summary
pack-priv static final String EMPTY_STRING

serialVersionUID	back to summary
private static final long serialVersionUID Hides org.jdom2.Content.serialVersionUID. JDOM2 Serialization. In this case, Text is simple.

value	back to summary
protected String value The actual character content

Text	back to summary
protected Text(Content.CType ctype) CData type extends Text, and it needs to be able to change the Content type of this Content. Parameters ctype:Content.CType The CType to set for this Text-based Content.

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

Text	back to summary
public Text(String str) This constructor creates a new `Text` node, with the supplied string value as its character content. Parameters str:String the node's character content. Exceptions IllegalDataException: if `str` contains an illegal character such as a vertical tab (as determined by `org.jdom2.Verifier#checkCharacterData`)

Method Detail

append back to summary

append	back to summary
public void append(String str) This will append character content to whatever content already exists within this `Text` node. Parameters str:String character content to append. Exceptions IllegalDataException: if `str` contains an illegal character such as a vertical tab (as determined by `org.jdom2.Verifier#checkCharacterData`)

public void append(String str)

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

Parameters

str:String: character content to append.

Exceptions

IllegalDataException:: if str contains an illegal character such as a vertical tab (as determined by org.jdom2.Verifier#checkCharacterData)

append back to summary

append	back to summary
public void append(Text text) This will append the content of another `Text` node to this node. Parameters text:Text Text node to append.

public void append(Text text)

This will append the content of another Text node to this node.

Parameters

text:Text: Text node to append.

clone	back to summary
public Text clone() Overrides org.jdom2.Content.clone. Doc from org.jdom2.CloneBase.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. Returns:Text Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

clone

back to summary

public Text clone()

Overrides org.jdom2.Content.clone.

Doc from org.jdom2.CloneBase.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.

Returns:Text

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

detach back to summary

detach	back to summary
public Text detach() Overrides org.jdom2.Content.detach. Doc from org.jdom2.Content.detach. 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()`; Returns:Text this child detached Annotations @Override

public Text detach()

Overrides org.jdom2.Content.detach.

Doc from org.jdom2.Content.detach.

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();

Returns:Text

this child detached

Annotations

@Override

getParent back to summary

getParent	back to summary
public Element getParent() Overrides org.jdom2.Content.getParent. Doc from org.jdom2.Content.getParent. Return this child's parent, or null if this child is currently not attached. The parent can be either an `Element` or a `Document`. This method can be overridden by particular Content subclasses to return a specific type of Parent (co-variant return type). All overriding subclasses must call `super.getParent()`; Returns:Element this child's parent or null if none Annotations @Override

public Element getParent()

Overrides org.jdom2.Content.getParent.

Doc from org.jdom2.Content.getParent.

Return this child's parent, or null if this child is currently not attached. The parent can be either an Element or a Document.

This method can be overridden by particular Content subclasses to return a specific type of Parent (co-variant return type). All overriding subclasses must call super.getParent();

Returns:Element

this child's parent or null if none

Annotations

@Override

getText back to summary

getText	back to summary
public String getText() This returns the value of this `Text` node as a Java `String`. Returns:String `String` - character content of this node.

public String getText()

This returns the value of this Text node as a Java String.

Returns:String: String - character content of this node.

getTextNormalize	back to summary
public String getTextNormalize() This returns the textual content with all surrounding whitespace removed and internal whitespace normalized to a single space. If only whitespace exists, the empty string is returned. Returns:String normalized text content or empty string

getTextNormalize

back to summary

public String getTextNormalize()

This returns the textual content with all surrounding whitespace removed and internal whitespace normalized to a single space. If only whitespace exists, the empty string is returned.

Returns:String: normalized text content or empty string

getTextTrim	back to summary
public String getTextTrim() This returns the textual content with all surrounding whitespace removed. If only whitespace exists, the empty string is returned. Returns:String trimmed text content or empty string

getTextTrim

back to summary

public String getTextTrim()

This returns the textual content with all surrounding whitespace removed. If only whitespace exists, the empty string is returned.

Returns:String: trimmed text content or empty string

getValue	back to summary
public String getValue() Implements abstract org.jdom2.Content.getValue. Returns the XPath 1.0 string value of this element, which is the text itself. Returns:String the text Annotations @Override

getValue

back to summary

public String getValue()

Implements abstract org.jdom2.Content.getValue.

Returns the XPath 1.0 string value of this element, which is the text itself.

Returns:String

the text

Annotations

@Override

normalizeString	back to summary
public static String normalizeString(String str) This returns a new string with all surrounding whitespace removed and internal whitespace normalized to a single space. If only whitespace exists, the empty string is returned. Per XML 1.0 Production 3 whitespace includes: #x20, #x9, #xD, #xA Parameters str:String string to be normalized. Returns:String normalized string or empty string

normalizeString

back to summary

public static String normalizeString(String str)

This returns a new string with all surrounding whitespace removed and internal whitespace normalized to a single space. If only whitespace exists, the empty string is returned.

Per XML 1.0 Production 3 whitespace includes: #x20, #x9, #xD, #xA

Parameters

str:String: string to be normalized.

Returns:String

normalized string or empty string

setParent back to summary

setParent	back to summary
protected Text setParent(Parent parent) Overrides org.jdom2.Content.setParent. Doc from org.jdom2.Content.setParent. 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)`; Parameters parent:Parent new parent element Returns:Text the target element Annotations @Override

protected Text setParent(Parent parent)

Overrides org.jdom2.Content.setParent.

Doc from org.jdom2.Content.setParent.

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);

Parameters

parent:Parent: new parent element

Returns:Text

the target element

Annotations

@Override

setText back to summary

setText	back to summary
public Text setText(String str) This will set the value of this `Text` node. Parameters str:String value for node's content. Returns:Text 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.jdom2.Verifier#checkCharacterData`)

public Text setText(String str)

This will set the value of this Text node.

Parameters

str:String: value for node's content.

Returns:Text

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.jdom2.Verifier#checkCharacterData)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. This returns a `String` representation of the `Text` node, suitable for debugging. If the XML representation of the `Text` node is desired, either `getText` or `org.jdom2.output.XMLOutputter#outputString(Text)` should be used. Returns:String `String` - information about this node. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

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

Returns:String

String - information about this node.

Annotations

@Override

public Class Text

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail