org.jdom

Class Text

Implemented Interfaces:
Cloneable, Serializable

public class Text
extends java.lang.Object
implements Serializable, 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 $

Authors:
Brett McLaughlin
Bradley S. Huffman

Field Summary

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

Constructor Summary

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

Method Summary

void
append(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.
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(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.
String
getText()
This returns the value of this Text node as a Java String.
String
getTextNormalize()
This returns the textual content with all surrounding whitespace removed and internal whitespace normalized to a single space.
String
getTextTrim()
This returns the textual content with all surrounding whitespace removed.
int
hashCode()
This will generate a hash code for this node.
static String
normalizeString(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(String str)
This will set the value of this Text node.
String
toString()
This returns a String representation of the Text node, suitable for debugging.

Field Details

parent

protected Object parent
This Text node's parent.


value

protected String value
The actual character content

Constructor Details

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

append

public void append(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.


clone

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

Returns:
Text - cloned 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.


equals

public final boolean equals(Object ob)
This tests for equality of this Text to the supplied Object, explicitly using the == operator.

Parameters:
ob - Object to compare to

Returns:
whether the Text nodes are equal


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.


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.


getText

public String getText()
This returns the value of this Text node as a Java String.

Returns:
String - character content of this node.


getTextNormalize

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:
normalized text content or empty string


getTextTrim

public 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


hashCode

public final int hashCode()
This will generate a hash code for this node.

Returns:
int - hash code for this node.


normalizeString

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 to be normalized.

Returns:
normalized string or empty string


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.


setText

public Text setText(String str)
This will set the value of this Text node.

Parameters:
str - value for node's content.


toString

public String toString()

Returns:
String - information about this node.


Copyright B) 2002 Jason Hunter, Brett McLaughlin. All Rights Reserved.