org.apache.axis2.saaj
Class TextImplEx

java.lang.Object
  org.apache.axiom.om.impl.dom.NodeImpl
      org.apache.axis2.saaj.NodeImplEx
          org.apache.axis2.saaj.TextImplEx

All Implemented Interfaces:

Cloneable, CharacterData, Node, NodeList, Text

Direct Known Subclasses:

CommentImpl

public class TextImplEx
extends NodeImplEx
implements Text

Field Summary

Fields inherited from class org.apache.axis2.saaj.NodeImplEx

parentElement

Fields inherited from class org.apache.axiom.om.impl.dom.NodeImpl

builder, done, factory, FIRSTCHILD, flags, HAS_PARENT, SPECIFIED

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

TextImplEx(String data, SOAPElement parent)

TextImplEx(String data, SOAPElement parent, Node prevSibling, Node nextSibling)

TextImplEx(org.apache.axiom.om.impl.dom.TextImpl textNode, SOAPElement parent)

Method Summary

void	appendData(String value) 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.
void	discard()
String	getData() The character data of the node that implements this interface.
Node	getNextSibling()
String	getNodeName() The name of this node, depending on its type; see the table above.
short	getNodeType() A code representing the type of the underlying object, as defined above.
String	getNodeValue()
Document	getOwnerDocument()
org.apache.axiom.om.OMContainer	getParent()
Node	getPreviousSibling()
String	getValue() Retrieve the text value (data) of this
String	getWholeText()
void	insertData(int offset, String data) Insert a string at the specified 16-bit unit offset.
void	internalSerialize(XMLStreamWriter writer, boolean cache)
boolean	isComment() Retrieves whether this Text object represents a comment.
boolean	isElementContentWhitespace()
void	replaceData(int offset, int count, String data) Replace the characters starting at the specified 16-bit unit offset with the specified string.
Text	replaceWholeText(String content)
void	setData(String data) The character data of the node that implements this interface.
void	setNextSibling(Node nextSibling)
void	setNodeValue(String value)
void	setParent(org.apache.axiom.om.OMContainer element)
void	setPreviousSibling(Node previousSibling)
void	setValue(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.
Text	splitText(int offset) Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings.
String	substringData(int offset, int count) Extracts a range of data from the node.
String	toString()

Methods inherited from class org.apache.axis2.saaj.NodeImplEx

detach, detachNode, getParentElement, getParentNode, getSchemaTypeInfo, getType, recycleNode, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setParentElement, setType

Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLength, getLocalName, getNamespaceURI, getOMFactory, getPrefix, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setPrefix, setTextContent, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.xml.soap.Node

detachNode, getParentElement, recycleNode, setParentElement

Methods inherited from interface org.w3c.dom.CharacterData

getLength

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getParentNode, getPrefix, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setPrefix, setTextContent, setUserData

Constructor Detail

TextImplEx

public TextImplEx(String data,
                  SOAPElement parent)

TextImplEx

public TextImplEx(org.apache.axiom.om.impl.dom.TextImpl textNode,
                  SOAPElement parent)

TextImplEx

public TextImplEx(String data,
                  SOAPElement parent,
                  Node prevSibling,
                  Node nextSibling)

Method Detail

setNextSibling

public void setNextSibling(Node nextSibling)

setPreviousSibling

public void setPreviousSibling(Node previousSibling)

isComment

public boolean isComment()

Retrieves whether this Text object represents a comment.

Returns:

true if this Text object is a comment; false otherwise

getNodeName

public String getNodeName()

The name of this node, depending on its type; see the table above.

Specified by:

getNodeName in interface Node

getNodeType

public short getNodeType()

A code representing the type of the underlying object, as defined above.

Specified by:

getNodeType in interface Node

splitText

public Text splitText(int offset)
               throws 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 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:

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.

isElementContentWhitespace

public boolean isElementContentWhitespace()

Specified by:

isElementContentWhitespace in interface Text

getWholeText

public String getWholeText()

Specified by:

getWholeText in interface Text

replaceWholeText

public Text replaceWholeText(String content)
                      throws DOMException

Specified by:

replaceWholeText in interface Text

Throws:

DOMException

getData

public String getData()
               throws 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 CharacterData

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

setData

public void setData(String data)
             throws 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 CharacterData

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

substringData

public String substringData(int offset,
                            int count)
                     throws DOMException

Extracts a range of data from the node.

Specified by:

substringData in interface 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:

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.

appendData

public void appendData(String value)
                throws 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 CharacterData

Parameters:

value - The DOMString to append.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

insertData

public void insertData(int offset,
                       String data)
                throws DOMException

Insert a string at the specified 16-bit unit offset.

Specified by:

insertData in interface CharacterData

Parameters:

offset - The character offset at which to insert.

data - The DOMString to insert.

Throws:

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.

deleteData

public void deleteData(int offset,
                       int count)
                throws DOMException

Remove a range of 16-bit units from the node. Upon success, data and length reflect the change.

Specified by:

deleteData in interface 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:

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.

replaceData

public void replaceData(int offset,
                        int count,
                        String data)
                 throws DOMException

Replace the characters starting at the specified 16-bit unit offset with the specified string.

Specified by:

replaceData in interface 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).

data - The DOMString with which the range must be replaced.

Throws:

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.

setParent

public void setParent(org.apache.axiom.om.OMContainer element)

getOwnerDocument

public Document getOwnerDocument()

Specified by:

getOwnerDocument in interface Node

getParent

public org.apache.axiom.om.OMContainer getParent()

Overrides:

getParent in class NodeImplEx

discard

public void discard()
             throws org.apache.axiom.om.OMException

Throws:

org.apache.axiom.om.OMException

internalSerialize

public void internalSerialize(XMLStreamWriter writer,
                              boolean cache)
                       throws XMLStreamException

Throws:

XMLStreamException

getValue

public String getValue()

Retrieve the text value (data) of this

Overrides:

getValue in class NodeImplEx

Returns:

The text value (data) of this

getNodeValue

public String getNodeValue()

Specified by:

getNodeValue in interface Node

Overrides:

getNodeValue in class org.apache.axiom.om.impl.dom.NodeImpl

setValue

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

Parameters:

value - the text to set

Throws:

IllegalStateException - if the node is not a Text node and either has more than one child node or has a child node that is not a Text node

setNodeValue

public void setNodeValue(String value)

Specified by:

setNodeValue in interface Node

Overrides:

setNodeValue in class org.apache.axiom.om.impl.dom.NodeImpl

toString

public String toString()

Overrides:

toString in class Object

getNextSibling

public Node getNextSibling()

Specified by:

getNextSibling in interface Node

Overrides:

getNextSibling in class org.apache.axiom.om.impl.dom.NodeImpl

getPreviousSibling

public Node getPreviousSibling()

Specified by:

getPreviousSibling in interface Node

Overrides:

getPreviousSibling in class org.apache.axiom.om.impl.dom.NodeImpl