Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.axis.message
Class TextImpl

java.lang.Object
  extended byorg.jboss.axis.message.NodeImpl (src) 
      extended byorg.jboss.axis.message.TextImpl
All Implemented Interfaces:
org.w3c.dom.CharacterData, Node (src) , org.w3c.dom.Node, Text (src) , org.w3c.dom.Text
Direct Known Subclasses:
CDATAImpl (src) , CommentImpl (src)
public class TextImpl
extends NodeImpl (src)
implements Text (src)

A representation of a node whose value is text. A Text object may represent text that is content or text that is a comment.

Field Summary
 
Fields inherited from class org.jboss.axis.message.NodeImpl (src)
domNode, soapParent
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Constructor Summary
TextImpl(org.w3c.dom.Node node)
           
 
Method Summary
 void appendData(java.lang.String arg)
          Append the string to the end of the character data of the node.
 void deleteData(int offset, int count)
          Remove a range of 16-bit units from the node.
 java.lang.String getData()
          The character data of the node that implements this interface.
 int getLength()
          The number of 16-bit units that are available through data and the substringData method below.
 java.lang.String getValue()
          Returns the value of this node if this is a Text node or the value of the immediate child of this node otherwise.
 java.lang.String getWholeText()
          TODO - complete the implementation Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.
 void insertData(int offset, java.lang.String arg)
          Insert a string at the specified 16-bit unit offset.
 boolean isComment()
          Retrieves whether this object represents a comment.
 boolean isElementContentWhitespace()
          TODO - complete the implementation Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace".
 void replaceData(int offset, int count, java.lang.String arg)
          Replace the characters starting at the specified 16-bit unit offset with the specified string.
 org.w3c.dom.Text replaceWholeText(java.lang.String content)
          TODO - complete the implementation Replaces the text of the current node and all logically-adjacent text nodes with the specified text.
 void setData(java.lang.String data)
          The character data of the node that implements this interface.
 void setValue(java.lang.String value)
          If this is a Text node then this method will set its value, otherwise it sets the value of the immediate (Text) child of this node.
 org.w3c.dom.Text splitText(int offset)
          Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings.
 java.lang.String substringData(int offset, int count)
          Extracts a range of data from the node.
 
Methods inherited from class org.jboss.axis.message.NodeImpl (src)
appendChild, cloneNode, compareDocumentPosition, detachNode, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, hashCode, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, recycleNode, removeChild, replaceChild, setNodeValue, setParentElement, setPrefix, setTextContent, setUserData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.xml.soap.Node (src)
detachNode, getParentElement, recycleNode, setParentElement
 
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix
 

Constructor Detail

TextImpl

public TextImpl(org.w3c.dom.Node node)
Method Detail

isComment

public boolean isComment()
Retrieves whether this object represents a comment.

Specified by:
isComment in interface Text (src)
Returns:
true if this Text object is a comment; false otherwise

getValue

public java.lang.String getValue()
Description copied from interface: Node (src)
Returns the value of this node if this is a Text node or the value of the immediate child of this node otherwise. If there is an immediate child of this Node that it is a Text node then it's value will be returned. If there is more than one Text node then the value of the first Text Node will be returned. Otherwise null is returned.

Specified by:
getValue in interface Node (src)
Overrides:
getValue in class NodeImpl (src)
Returns:
a String with the text of this node if this is a Text node or the text contained by the first immediate child of this Node object that is a Text object if such a child exists; null otherwise.

setValue

public void setValue(java.lang.String value)
Description copied from interface: Node (src)
If this is a Text node then this method will set its value, otherwise it sets the value of the immediate (Text) child of this node. The value of the immediate child of this node can be set only if, there is one child node and that node is a Text node, or if there are no children in which case a child Text node will be created.

Specified by:
setValue in interface Node (src)
Overrides:
setValue in class NodeImpl (src)
Parameters:
value - A value string

splitText

public org.w3c.dom.Text splitText(int offset)
                           throws org.w3c.dom.DOMException
Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings.

After being split, this node will contain all the content up to the offset point. A new node of the same type, which contains all the content at and after the offset point, is returned. If the original node had a parent node, the new node is inserted as the next sibling of the original node. When the offset is equal to the length of this node, the new node has no data.

Specified by:
splitText in interface org.w3c.dom.Text
Parameters:
offset - The 16-bit unit offset at which to split, starting from 0.
Returns:
The new node, of the same type as this node.
Throws:
org.w3c.dom.DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

getLength

public int getLength()
The number of 16-bit units that are available through data and the substringData method below. This may have the value zero, i.e., CharacterData nodes may be empty.

Specified by:
getLength in interface org.w3c.dom.CharacterData

deleteData

public void deleteData(int offset,
                       int count)
                throws org.w3c.dom.DOMException
Remove a range of 16-bit units from the node. Upon success, data and length reflect the change.

Specified by:
deleteData in interface org.w3c.dom.CharacterData
Parameters:
offset - The offset from which to start removing.
count - The number of 16-bit units to delete. If the sum of offset and count exceeds length then all 16-bit units from offset to the end of the data are deleted.
Throws:
org.w3c.dom.DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

getData

public java.lang.String getData()
                         throws org.w3c.dom.DOMException
The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a CharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single DOMString. In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.

Specified by:
getData in interface org.w3c.dom.CharacterData
Throws:
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
org.w3c.dom.DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

substringData

public java.lang.String substringData(int offset,
                                      int count)
                               throws org.w3c.dom.DOMException
Extracts a range of data from the node.

Specified by:
substringData in interface org.w3c.dom.CharacterData
Parameters:
offset - Start offset of substring to extract.
count - The number of 16-bit units to extract.
Returns:
The specified substring. If the sum of offset and count exceeds the length, then all 16-bit units to the end of the data are returned.
Throws:
org.w3c.dom.DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative.
DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a DOMString.

replaceData

public void replaceData(int offset,
                        int count,
                        java.lang.String arg)
                 throws org.w3c.dom.DOMException
Replace the characters starting at the specified 16-bit unit offset with the specified string.

Specified by:
replaceData in interface org.w3c.dom.CharacterData
Parameters:
offset - The offset from which to start replacing.
count - The number of 16-bit units to replace. If the sum of offset and count exceeds length, then all 16-bit units to the end of the data are replaced; (i.e., the effect is the same as a remove method call with the same range, followed by an append method invocation).
arg - The DOMString with which the range must be replaced.
Throws:
org.w3c.dom.DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

insertData

public void insertData(int offset,
                       java.lang.String arg)
                throws org.w3c.dom.DOMException
Insert a string at the specified 16-bit unit offset.

Specified by:
insertData in interface org.w3c.dom.CharacterData
Parameters:
offset - The character offset at which to insert.
arg - The DOMString to insert.
Throws:
org.w3c.dom.DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

appendData

public void appendData(java.lang.String arg)
                throws org.w3c.dom.DOMException
Append the string to the end of the character data of the node. Upon success, data provides access to the concatenation of data and the DOMString specified.

Specified by:
appendData in interface org.w3c.dom.CharacterData
Parameters:
arg - The DOMString to append.
Throws:
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

setData

public void setData(java.lang.String data)
             throws org.w3c.dom.DOMException
The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a CharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single DOMString. In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.

Specified by:
setData in interface org.w3c.dom.CharacterData
Throws:
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
org.w3c.dom.DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

isElementContentWhitespace

public boolean isElementContentWhitespace()
TODO - complete the implementation Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace". The text node is determined to contain whitespace in element content during the load of the document or if validation occurs while using Document.normalizeDocument().

Since:
DOM Level 3

getWholeText

public java.lang.String getWholeText()
TODO - complete the implementation Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.
For instance, in the example below wholeText on the Text node that contains "bar" returns "barfoo", while on the Text node that contains "foo" it returns "barfoo".

Since:
DOM Level 3

replaceWholeText

public org.w3c.dom.Text replaceWholeText(java.lang.String content)
                                  throws org.w3c.dom.DOMException
TODO - complete the implementation Replaces the text of the current node and all logically-adjacent text nodes with the specified text. All logically-adjacent text nodes are removed including the current node unless it was the recipient of the replacement text.
This method returns the node which received the replacement text. The returned node is:
For instance, in the above example calling replaceWholeText on the Text node that contains "bar" with "yo" in argument results in the following:
Where the nodes to be removed are read-only descendants of an EntityReference, the EntityReference must be removed instead of the read-only nodes. If any EntityReference to be removed has descendants that are not EntityReference, Text, or CDATASection nodes, the replaceWholeText method must fail before performing any modification of the document, raising a DOMException with the code NO_MODIFICATION_ALLOWED_ERR.
For instance, in the example below calling replaceWholeText on the Text node that contains "bar" fails, because the EntityReference node "ent" contains an Element node which cannot be removed.

Parameters:
content - The content of the replacing Text node.
Returns:
The Text node created with the specified content.
Throws:
org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if one of the Text nodes being replaced is readonly.
Since:
DOM Level 3
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD