org.jdom

Class Text

public class Text extends Content

Character-based XML content. Provides a modular, parentable method of representing text. Text makes no guarantees about the underlying textual representation of character data, but does expose that data as a Java String.

Version: $Revision: 1.24 $, $Date: 2004/02/27 11:32:57 $

Author: Brett McLaughlin Jason Hunter Bradley S. Huffman

Field Summary
protected Stringvalue
The actual character content
Constructor Summary
protected 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
voidappend(String str)
This will append character content to whatever content already exists within this Text node.
voidappend(Text text)
This will append the content of another Text node to this node.
Objectclone()
This will return a clone of this Text node, with the same character content, but no parent.
StringgetText()
This returns the value of this Text node as a Java String.
StringgetTextNormalize()
This returns the textual content with all surrounding whitespace removed and internal whitespace normalized to a single space.
StringgetTextTrim()
This returns the textual content with all surrounding whitespace removed.
StringgetValue()
Returns the XPath 1.0 string value of this element, which is the text itself.
static StringnormalizeString(String str)
This returns a new string with all surrounding whitespace removed and internal whitespace normalized to a single space.
TextsetText(String str)
This will set the value of this Text node.
StringtoString()
This returns a String representation of the Text node, suitable for debugging.

Field Detail

value

protected String value
The actual character content

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

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

Method Detail

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.

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

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.

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

getValue

public String getValue()
Returns the XPath 1.0 string value of this element, which is the text itself.

Returns: the text

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

setText

public Text setText(String str)
This will set the value of this Text 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})

toString

public 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 {@link #getText} or {@link org.jdom.output.XMLOutputter#outputString(Text)} should be used.

Returns: String - information about this node.

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