org.apache.axis2.saaj
Class TextImplEx

java.lang.Object
  extended byorg.apache.axis2.om.impl.dom.NodeImpl
      extended byorg.apache.axis2.saaj.NodeImplEx
          extended byorg.apache.axis2.saaj.TextImplEx
All Implemented Interfaces:
CharacterData, Cloneable, Node, Node, NodeList, OMNode, OMNodeEx, Text, Text

public class TextImplEx
extends NodeImplEx
implements Text


Field Summary
 
Fields inherited from class org.apache.axis2.om.impl.dom.NodeImpl
builder, done, FIRSTCHILD, flags, nodeType, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED
 
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
 
Fields inherited from interface org.apache.axis2.om.OMNode
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE
 
Constructor Summary
TextImplEx(String data)
           
 
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()
          Discards a node.
 String getData()
          The character data of the node that implements this interface.
 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.
 OMContainer getParent()
          Returns the parent containing node.
 String getValue()
          Retrieve the text value (data) of this
 void insertData(int offset, String data)
          Insert a string at the specified 16-bit unit offset.
 boolean isComment()
          Retrieves whether this Text object represents a comment.
 void replaceData(int offset, int count, String data)
          Replace the characters starting at the specified 16-bit unit offset with the specified string.
 void serialize(OMOutputImpl omOutput)
          Serializes the node with caching.
 void serializeAndConsume(OMOutputImpl omOutput)
          Serializes the node without caching.
 void setData(String data)
          The character data of the node that implements this interface.
 void setParent(OMContainer element)
           
 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
detachNode, getParentElement, getType, recycleNode, setParentElement, setType, setValue
 
Methods inherited from class org.apache.axis2.om.impl.dom.NodeImpl
appendChild, build, cloneNode, compareDocumentPosition, detach, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLength, getLocalName, getNamespaceURI, getNextOMSibling, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousOMSibling, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, insertSiblingAfter, insertSiblingBefore, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeWithCache, setComplete, setNextOMSibling, setNodeValue, setOwnerDocument, setPrefix, setPreviousOMSibling, 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, setValue
 
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix
 
Methods inherited from interface org.w3c.dom.CharacterData
getLength
 

Constructor Detail

TextImplEx

public TextImplEx(String data)
Method Detail

isComment

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

Specified by:
isComment in interface Text
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.

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(OMContainer element)
Specified by:
setParent in interface OMNodeEx

getParent

public OMContainer getParent()
Description copied from interface: OMNode
Returns the parent containing node.

Returns the parent container, which may be either an OMDocument or OMElement.

Specified by:
getParent in interface OMNode
Overrides:
getParent in class NodeImplEx

discard

public void discard()
             throws OMException
Description copied from interface: OMNode
Discards a node.

Discard goes to the parser level and if the element is not completely built, then it will be completely skipped at the parser level.

Specified by:
discard in interface OMNode
Throws:
OMException

serialize

public void serialize(OMOutputImpl omOutput)
               throws XMLStreamException
Description copied from interface: OMNodeEx
Serializes the node with caching.

Specified by:
serialize in interface OMNodeEx
Parameters:
omOutput -
Throws:
XMLStreamException
See Also:
OMNodeEx.serialize(org.apache.axis2.om.impl.OMOutputImpl)

serializeAndConsume

public void serializeAndConsume(OMOutputImpl omOutput)
                         throws XMLStreamException
Description copied from interface: OMNodeEx
Serializes the node without caching.

Specified by:
serializeAndConsume in interface OMNodeEx
Parameters:
omOutput -
Throws:
XMLStreamException

getValue

public String getValue()
Retrieve the text value (data) of this

Specified by:
getValue in interface Node
Overrides:
getValue in class NodeImplEx
Returns:
The text value (data) of this

toString

public String toString()