Class CharacterDataImpl
- java.lang.Object
-
- org.htmlunit.cyberneko.xerces.dom.NodeImpl
-
- org.htmlunit.cyberneko.xerces.dom.ChildNode
-
- org.htmlunit.cyberneko.xerces.dom.CharacterDataImpl
-
- All Implemented Interfaces:
java.lang.Cloneable
,org.w3c.dom.events.EventTarget
,org.w3c.dom.Node
,org.w3c.dom.NodeList
- Direct Known Subclasses:
CommentImpl
,ProcessingInstructionImpl
,TextImpl
public abstract class CharacterDataImpl extends ChildNode
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.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
data_
private static org.w3c.dom.NodeList
singletonNodeList
Empty child nodes.-
Fields inherited from class org.htmlunit.cyberneko.xerces.dom.ChildNode
nextSibling_, previousSibling_
-
Fields inherited from class org.htmlunit.cyberneko.xerces.dom.NodeImpl
DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, FIRSTCHILD, HASSTRING, ID, NORMALIZED, OWNED, ownerNode_, READONLY, SPECIFIED, SYNCCHILDREN
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CharacterDataImpl(CoreDocumentImpl ownerDocument, java.lang.String data)
Factory constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
appendData(java.lang.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.org.w3c.dom.NodeList
getChildNodes()
Obtain a NodeList enumerating all children of this node.java.lang.String
getData()
int
getLength()
NodeList method: Count the immediate children of this nodejava.lang.String
getNodeValue()
Returns the node value.void
insertData(int offset, java.lang.String data)
Insert additional characters into the data stored in this node, at the offset specified.(package private) void
internalDeleteData(int offset, int count, boolean replace)
(package private) void
internalInsertData(int offset, java.lang.String data, boolean replace)
void
replaceData(int offset, int count, java.lang.String data)
Replace a series of characters at the specified (zero-based) offset with a new string, NOT necessarily of the same length.void
setData(java.lang.String value)
Store character data into this node.void
setNodeValue(java.lang.String value)
Sets the node value.protected void
setNodeValueInternal(java.lang.String value)
Convenience wrapper for calling setNodeValueInternal when we are not performing a replacement operationprotected void
setNodeValueInternal(java.lang.String value, boolean replace)
This function added so that we can distinguish whether setNodeValue has been called from some other DOM functions.java.lang.String
substringData(int offset, int count)
Substring is more than a convenience function.-
Methods inherited from class org.htmlunit.cyberneko.xerces.dom.ChildNode
cloneNode, getNextSibling, getParentNode, getPreviousSibling, parentNode, previousSibling
-
Methods inherited from class org.htmlunit.cyberneko.xerces.dom.NodeImpl
addEventListener, appendChild, changed, changes, compareDocumentPosition, dispatchEvent, getAttributes, getBaseURI, getElementAncestor, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNodeName, getNodeNumber, getNodeType, getOwnerDocument, getPrefix, getTextContent, getTextContent, getUserData, hasAttributes, hasChildNodes, hasStringValue, hasStringValue, insertBefore, isDefaultNamespace, isEqualNode, isFirstChild, isFirstChild, isIdAttribute, isIdAttribute, isNormalized, isNormalized, isOwned, isOwned, isSameNode, isSpecified, isSpecified, isSupported, item, lookupNamespacePrefix, lookupNamespaceURI, lookupPrefix, needsSyncChildren, needsSyncChildren, normalize, ownerDocument, removeChild, removeEventListener, replaceChild, setOwnerDocument, setPrefix, setTextContent, setUserData, toString
-
-
-
-
Constructor Detail
-
CharacterDataImpl
protected CharacterDataImpl(CoreDocumentImpl ownerDocument, java.lang.String data)
Factory constructor.- Parameters:
ownerDocument
- the owner documentdata
- the data
-
-
Method Detail
-
getChildNodes
public org.w3c.dom.NodeList getChildNodes()
Obtain a NodeList enumerating all children of this node. If there are none, an (initially) empty NodeList is returned.NodeLists are "live"; as children are added/removed the NodeList will immediately reflect those changes. Also, the NodeList refers to the actual nodes, so changes to those nodes made via the DOM tree will be reflected in the NodeList and vice versa.
In this implementation, Nodes implement the NodeList interface and provide their own getChildNodes() support. Other DOMs may solve this differently.
- Specified by:
getChildNodes
in interfaceorg.w3c.dom.Node
- Overrides:
getChildNodes
in classNodeImpl
-
getNodeValue
public java.lang.String getNodeValue()
Description copied from class:NodeImpl
Returns the node value.- Specified by:
getNodeValue
in interfaceorg.w3c.dom.Node
- Overrides:
getNodeValue
in classNodeImpl
-
setNodeValueInternal
protected void setNodeValueInternal(java.lang.String value)
Convenience wrapper for calling setNodeValueInternal when we are not performing a replacement operation- Parameters:
value
- the value
-
setNodeValueInternal
protected void setNodeValueInternal(java.lang.String value, boolean replace)
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).
- Parameters:
value
- the valuereplace
- flag to signal replace
-
setNodeValue
public void setNodeValue(java.lang.String value)
Sets the node value. Sets the content, possibly firing related events, and updating ranges (via notification to the document)- Specified by:
setNodeValue
in interfaceorg.w3c.dom.Node
- Overrides:
setNodeValue
in classNodeImpl
-
getData
public java.lang.String getData()
- Returns:
- character data currently stored in this node.
-
getLength
public int getLength()
NodeList method: Count the immediate children of this nodeBy default we do not have any children, ParentNode overrides this. Report number of characters currently stored in this node's data. It may be 0, meaning that the value is an empty string.
-
appendData
public void appendData(java.lang.String data)
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.)- Parameters:
data
- the data
-
deleteData
public void deleteData(int offset, int count) throws org.w3c.dom.DOMException
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.- Parameters:
offset
- the offsercount
- the count- Throws:
org.w3c.dom.DOMException
- INDEX_SIZE_ERR if offset is negative or greater than length, or if count is negative.
-
internalDeleteData
void internalDeleteData(int offset, int count, boolean replace) throws org.w3c.dom.DOMException
- Throws:
org.w3c.dom.DOMException
-
insertData
public void insertData(int offset, java.lang.String data) throws org.w3c.dom.DOMException
Insert additional characters into the data stored in this node, at the offset specified.- Parameters:
offset
- the offsetdata
- the data- Throws:
org.w3c.dom.DOMException
- INDEX_SIZE_ERR if offset is negative or greater than length.
-
internalInsertData
void internalInsertData(int offset, java.lang.String data, boolean replace) throws org.w3c.dom.DOMException
- Throws:
org.w3c.dom.DOMException
-
replaceData
public void replaceData(int offset, int count, java.lang.String data) throws org.w3c.dom.DOMException
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:
org.w3c.dom.DOMException
- INDEX_SIZE_ERR if offset is negative or greater than length, or if count is negative.
-
setData
public void setData(java.lang.String value) throws org.w3c.dom.DOMException
Store character data into this node.- Parameters:
value
- the value- Throws:
org.w3c.dom.DOMException
-
substringData
public java.lang.String substringData(int offset, int count) throws org.w3c.dom.DOMException
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.
- Returns:
- the substring
- Throws:
org.w3c.dom.DOMException
- INDEX_SIZE_ERR if offset is negative or greater than length, or if count is negative.org.w3c.dom.DOMException
- WSTRING_SIZE_ERR In some implementations, count may exceed the permitted length of strings. If so, substring() will throw this DOMException advising the user to instead retrieve the data in smaller chunks.
-
-