Main Page | Class Hierarchy | Class List | Class Members | Related Pages

org::jdom::Text Class Reference

Inheritance diagram for org::jdom::Text:

org::jdom::CDATA List of all members.

Public Member Functions

 Text (String str)
String getText ()
String getTextTrim ()
String getTextNormalize ()
Text setText (String str)
void append (String str)
void append (Text text)
Element getParent ()
Document getDocument ()
Text detach ()
String toString ()
final int hashCode ()
Object clone ()
final boolean equals (Object ob)

Static Public Member Functions

String normalizeString (String str)

Protected Member Functions

 Text ()
Text setParent (Element parent)

Protected Attributes

String value
Object parent

Detailed Description

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.

Author:
Brett McLaughlin

Bradley S. Huffman

Version:
Revision
1.15
,
Date
2002/05/17 15:46:07


Constructor & Destructor Documentation

org::jdom::Text::Text  )  [inline, protected]
 

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

org::jdom::Text::Text String  str  )  [inline]
 

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

Parameters:
str the node's character content.
Exceptions:
IllegalDataException if str contains an illegal character such as a vertical tab (as determined by org.jdom.Verifier#checkCharacterData)


Member Function Documentation

void org::jdom::Text::append Text  text  )  [inline]
 

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

Parameters:
text Text node to append.

void org::jdom::Text::append String  str  )  [inline]
 

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

Parameters:
str character content to append.
Exceptions:
IllegalDataException if str contains an illegal character such as a vertical tab (as determined by org.jdom.Verifier#checkCharacterData)

Reimplemented in org::jdom::CDATA.

Object org::jdom::Text::clone  )  [inline]
 

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

Returns:
Text - cloned node.

Text org::jdom::Text::detach  )  [inline]
 

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

Returns:
Text - this Text modified.

final boolean org::jdom::Text::equals Object  ob  )  [inline]
 

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

Document org::jdom::Text::getDocument  )  [inline]
 

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.

Element org::jdom::Text::getParent  )  [inline]
 

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

Returns:
Element - this node's parent.

String org::jdom::Text::getText  )  [inline]
 

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

Returns:
String - character content of this node.

String org::jdom::Text::getTextNormalize  )  [inline]
 

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

String org::jdom::Text::getTextTrim  )  [inline]
 

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

final int org::jdom::Text::hashCode  )  [inline]
 

This will generate a hash code for this node.

Returns:
int - hash code for this node.

String org::jdom::Text::normalizeString String  str  )  [inline, static]
 

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

Text org::jdom::Text::setParent Element  parent  )  [inline, protected]
 

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.

Text org::jdom::Text::setText String  str  )  [inline]
 

This will set the value of this Text node.

Parameters:
str value for node's content.
Exceptions:
IllegalDataException if str contains an illegal character such as a vertical tab (as determined by org.jdom.Verifier#checkCharacterData)

Reimplemented in org::jdom::CDATA.

String org::jdom::Text::toString  )  [inline]
 

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.jdom.output.XMLOutputter#outputString(Text) should be used.

Returns:
String - information about this node.

Reimplemented in org::jdom::CDATA.


Member Data Documentation

Object org::jdom::Text::parent [protected]
 

This Text node's parent.

String org::jdom::Text::value [protected]
 

The actual character content


The documentation for this class was generated from the following file:
Generated on Tue Oct 26 18:17:01 2004 for JDOM by  doxygen 1.3.9.1