org.jdom
Class Text

java.lang.Object
  |
  +--org.jdom.Text

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

Direct Known Subclasses:

CDATA

public class Text

extends java.lang.Object

implements java.io.Serializable, java.lang.Cloneable

Text represents character-based content within an XML document represented by JDOM. It is intended to provide a modular, parentable method of representing that text. Additionally, Text makes no guarantees about the underlying textual representation of character data, but does expose that data as a Java String.

Version:

$Revision: 1.11 $, $Date: 2002/03/12 07:11:39 $

Author:

Brett McLaughlin, Bradley S. Huffman

See Also:

Serialized Form

Field Summary

protected java.lang.Object	parent This Text node's parent.
protected java.lang.String	value The actual character content

Constructor Summary

protected	Text() This is the protected, no-args constructor standard in all JDOM classes.
	Text(java.lang.String str) This constructor creates a new Text node, with the supplied string value as it's character content.

Method Summary

void	append(java.lang.String str) This will append character content to whatever content already exists within this Text node.
void	append(Text text) This will append the content of another Text node to this node.
java.lang.Object	clone() This will return a clone of this Text node, with the same character content, but no parent.
Text	detach() Detaches the Text from its parent, or does nothing if the Text has no parent.
boolean	equals(java.lang.Object ob) This tests for equality of this Text to the supplied Object, explicitly using the == operator.
Document	getDocument() This retrieves the owning Document for this Text, or null if not a currently a member of a Document.
Element	getParent() This will return the parent of this Text node, which is always a JDOM Element.
java.lang.String	getText() This returns the value of this Text node as a Java String.
java.lang.String	getTextNormalize() This returns the textual content with all surrounding whitespace removed and internal whitespace normalized to a single space.
java.lang.String	getTextTrim() This returns the textual content with all surrounding whitespace removed.
int	hashCode() This will generate a hash code for this node.
static java.lang.String	normalizeString(java.lang.String str) This returns a new string with all surrounding whitespace removed and internal whitespace normalized to a single space.
protected Text	setParent(Element parent) This will set the parent of the Text node to the supplied Element.
Text	setText(java.lang.String str) This will set the value of this Text node.
java.lang.String	toString() This returns a String representation of the Text node, suitable for debugging.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

protected java.lang.String value

The actual character content

parent

protected java.lang.Object parent

This Text node's parent.

Constructor Detail

Text

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

public Text(java.lang.String str)

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

Parameters:

str - the node's character content.

Method Detail

getText

public java.lang.String getText()

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

Returns:

String - character content of this node.

getTextTrim

public java.lang.String getTextTrim()

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

Returns:

trimmed text content or empty string

getTextNormalize

public java.lang.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:

normalized text content or empty string

normalizeString

public static java.lang.String normalizeString(java.lang.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 to be normalized.

Returns:

normalized string or empty string

setText

public Text setText(java.lang.String str)

This will set the value of this Text node.

Parameters:

str - value for node's content.

append

public void append(java.lang.String str)

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

Parameters:

str - character content to append.

append

public void append(Text text)

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

Parameters:

text - Text node to append.

getParent

public Element getParent()

This will return the parent of this Text node, which is always a JDOM Element.

Returns:

Element - this node's parent.

getDocument

public Document getDocument()

This retrieves the owning Document for this Text, or null if not a currently a member of a Document.

Returns:

Document owning this Text, or null.

setParent

protected Text setParent(Element parent)

This will set the parent of the Text node to the supplied Element. This method is intentionally left as protected so that only JDOM internals use it.

If you need an instance of this Text node with a new parent, you should get a copy of this node with clone() and set it on the desired (new) parent Element.

Parameters:

parent - parent for this node.

detach

public Text detach()

Detaches the Text from its parent, or does nothing if the Text has no parent.

Returns:

Text - this Text modified.

toString

public java.lang.String 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 XMLOutputter.outputString(Text) should be used.

Overrides:

toString in class java.lang.Object

Returns:

String - information about this node.

hashCode

public final int hashCode()

This will generate a hash code for this node.

Overrides:

hashCode in class java.lang.Object

Returns:

int - hash code for this node.

clone

public java.lang.Object clone()

This will return a clone of this Text node, with the same character content, but no parent.

Overrides:

clone in class java.lang.Object

Returns:

Text - cloned node.

equals

public final boolean equals(java.lang.Object ob)

This tests for equality of this Text to the supplied Object, explicitly using the == operator.

Overrides:

equals in class java.lang.Object

Parameters:

ob - Object to compare to

Returns:

whether the Text nodes are equal