Inheritance diagram for org::jdom::Text:
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 | |
static String | normalizeString (String str) |
Protected Member Functions | |
Text () | |
Text | setParent (Element parent) |
Protected Attributes | |
String | value |
Object | parent |
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
.
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.
str | the node's character content. |
IllegalDataException | if str contains an illegal character such as a vertical tab (as determined by org.jdom.Verifier#checkCharacterData) |
String org::jdom::Text::getText | ( | ) | [inline] |
This returns the value of this Text
node as a Java String
.
String
- character content of this node. 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.
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.
static 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
str | string to be normalized. |
Text org::jdom::Text::setText | ( | String | str | ) | [inline] |
This will set the value of this Text
node.
str | value for node's content. |
IllegalDataException | if str contains an illegal character such as a vertical tab (as determined by org.jdom.Verifier#checkCharacterData) |
Reimplemented in org::jdom::CDATA.
void org::jdom::Text::append | ( | String | str | ) | [inline] |
This will append character content to whatever content already exists within this Text
node.
str | character content to append. |
IllegalDataException | if str contains an illegal character such as a vertical tab (as determined by org.jdom.Verifier#checkCharacterData) |
Reimplemented in org::jdom::CDATA.
void org::jdom::Text::append | ( | Text | text | ) | [inline] |
Element org::jdom::Text::getParent | ( | ) | [inline] |
Document org::jdom::Text::getDocument | ( | ) | [inline] |
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
.
parent | parent for this node. |
Text org::jdom::Text::detach | ( | ) | [inline] |
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.
String
- information about this node. Reimplemented in org::jdom::CDATA.
final int org::jdom::Text::hashCode | ( | ) | [inline] |
This will generate a hash code for this node.
int
- hash code for this node. Object org::jdom::Text::clone | ( | ) | [inline] |
final boolean org::jdom::Text::equals | ( | Object | ob | ) | [inline] |
String org::jdom::Text::value [protected] |
The actual character content
Object org::jdom::Text::parent [protected] |
This Text
node's parent.