Package org.apache.xerces.dom
Class CharacterDataImpl
java.lang.Object
org.apache.xerces.dom.NodeImpl
org.apache.xerces.dom.ChildNode
org.apache.xerces.dom.CharacterDataImpl
- All Implemented Interfaces:
Serializable
,Cloneable
,EventTarget
,Node
,NodeList
- Direct Known Subclasses:
CommentImpl
,ProcessingInstructionImpl
,TextImpl
CharacterData is an abstract Node that can carry character data as its
Value. It provides shared behavior for Text, CData, and
possibly other node types. All offsets are 0-based.
Since ProcessingInstructionImpl inherits from this class to reuse the setNodeValue method, this class isn't declared as implementing the interface CharacterData. This is done by relevant subclasses (TexImpl, CommentImpl).
This class doesn't directly support mutation events, however, it notifies the document when mutations are performed so that the document class do so.
INTERNAL:
- Usage of this class is not supported. It may be altered or removed at any time.
- Since:
- PR-DOM-Level-1-19980818.
- Version:
- $Id: CharacterDataImpl.java 1057476 2011-01-11 03:31:36Z mrglavas $
- See Also:
-
Field Summary
FieldsFields inherited from class org.apache.xerces.dom.ChildNode
nextSibling, previousSibling
Fields inherited from class org.apache.xerces.dom.NodeImpl
DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE
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_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CharacterDataImpl
(CoreDocumentImpl ownerDocument, String data) Factory constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
appendData
(String data) Concatenate additional characters onto the end of the data stored in this node.void
deleteData
(int offset, int count) Remove a range of characters from the node's value.Returns an empty node list.getData()
Retrieve character data currently stored in this node.int
Report number of characters currently stored in this node's data.Returns the node value.void
insertData
(int offset, String data) Insert additional characters into the data stored in this node, at the offset specified.void
replaceData
(int offset, int count, String data) Replace a series of characters at the specified (zero-based) offset with a new string, NOT necessarily of the same length.void
Store character data into this node.void
setNodeValue
(String value) Sets the content, possibly firing related events, and updating ranges (via notification to the document)protected void
setNodeValueInternal
(String value) Convenience wrapper for calling setNodeValueInternal when we are not performing a replacement operationprotected void
setNodeValueInternal
(String value, boolean replace) This function added so that we can distinguish whether setNodeValue has been called from some other DOM functions.substringData
(int offset, int count) Substring is more than a convenience function.Methods inherited from class org.apache.xerces.dom.ChildNode
cloneNode, getNextSibling, getParentNode, getPreviousSibling
Methods inherited from class org.apache.xerces.dom.NodeImpl
addEventListener, appendChild, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getAttributes, getBaseURI, getContainer, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNodeName, getNodeNumber, getNodeType, getOwnerDocument, getPrefix, getReadOnly, getTextContent, getUserData, getUserData, getUserDataRecord, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, needsSyncChildren, normalize, removeChild, removeEventListener, replaceChild, setOwnerDocument, setPrefix, setReadOnly, setTextContent, setUserData, setUserData, synchronizeData, toString
-
Field Details
-
data
-
-
Constructor Details
-
CharacterDataImpl
public CharacterDataImpl() -
CharacterDataImpl
Factory constructor.
-
-
Method Details
-
getChildNodes
Returns an empty node list.- Specified by:
getChildNodes
in interfaceNode
- Overrides:
getChildNodes
in classNodeImpl
-
getNodeValue
Description copied from class:NodeImpl
Returns the node value.- Specified by:
getNodeValue
in interfaceNode
- Overrides:
getNodeValue
in classNodeImpl
-
setNodeValueInternal
Convenience wrapper for calling setNodeValueInternal when we are not performing a replacement operation -
setNodeValueInternal
This function added so that we can distinguish whether setNodeValue has been called from some other DOM functions. or by the client.This is important, because we do one type of Range fix-up, from the high-level functions in CharacterData, and another type if the client simply calls setNodeValue(value).
-
setNodeValue
Sets the content, possibly firing related events, and updating ranges (via notification to the document)- Specified by:
setNodeValue
in interfaceNode
- Overrides:
setNodeValue
in classNodeImpl
-
getData
Retrieve character data currently stored in this node. -
getLength
public int getLength()Report number of characters currently stored in this node's data. It may be 0, meaning that the value is an empty string. -
appendData
Concatenate additional characters onto the end of the data stored in this node. Note that this, and insert(), are the paths by which a DOM could wind up accumulating more data than the language's strings can easily handle. (See above discussion.) -
deleteData
Remove a range of characters from the node's value. Throws a DOMException if the offset is beyond the end of the string. However, a deletion _count_ that exceeds the available data is accepted as a delete-to-end request.- Throws:
DOMException
-
insertData
Insert additional characters into the data stored in this node, at the offset specified.- Throws:
DOMException
-
replaceData
Replace a series of characters at the specified (zero-based) offset with a new string, NOT necessarily of the same length. Convenience method, equivalent to a delete followed by an insert. Throws a DOMException if the specified offset is beyond the end of the existing data.- Parameters:
offset
- The offset at which to begin replacing.count
- The number of characters to remove, interpreted as in the delete() method.data
- The new string to be inserted at offset in place of the removed data. Note that the entire string will be inserted -- the count parameter does not affect insertion, and the new data may be longer or shorter than the substring it replaces.- Throws:
DOMException
-
setData
Store character data into this node.- Throws:
DOMException
-
substringData
Substring is more than a convenience function. In some implementations of the DOM, where the stored data may exceed the length that can be returned in a single string, the only way to read it all is to extract it in chunks via this method.- Parameters:
offset
- Zero-based offset of first character to retrieve.count
- Number of characters to retrieve. If the sum of offset and count exceeds the length, all characters to end of data are returned.- Throws:
DOMException
-