net.sourceforge.htmlunit.xerces.dom

Class CharacterDataImpl

java.lang.Object

net.sourceforge.htmlunit.xerces.dom.NodeImpl

net.sourceforge.htmlunit.xerces.dom.ChildNode

net.sourceforge.htmlunit.xerces.dom.CharacterDataImpl

All Implemented Interfaces:

Cloneable, EventTarget, Node, 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 and Description
protected String	data

Fields inherited from class net.sourceforge.htmlunit.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class net.sourceforge.htmlunit.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

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

Constructors

Modifier	Constructor and Description
protected	CharacterDataImpl(CoreDocumentImpl ownerDocument, String data) Factory constructor.

Method Summary

Modifier and Type	Method and Description
void	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.
NodeList	getChildNodes() Obtain a NodeList enumerating all children of this node.
String	getData()
int	getLength() NodeList method: Count the immediate children of this node
String	getNodeValue() 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	setData(String value) Store character data into this node.
void	setNodeValue(String value) Sets the node value.
protected void	setNodeValueInternal(String value) Convenience wrapper for calling setNodeValueInternal when we are not performing a replacement operation
protected void	setNodeValueInternal(String value, boolean replace) This function added so that we can distinguish whether setNodeValue has been called from some other DOM functions.
String	substringData(int offset, int count) Substring is more than a convenience function.

Methods inherited from class net.sourceforge.htmlunit.xerces.dom.ChildNode

cloneNode, getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class net.sourceforge.htmlunit.xerces.dom.NodeImpl

addEventListener, appendChild, changed, changes, compareDocumentPosition, dispatchEvent, getAttributes, getBaseURI, 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

Methods inherited from class java.lang.Object

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

Field Detail

data

protected String data

Constructor Detail

CharacterDataImpl

protected CharacterDataImpl(CoreDocumentImpl ownerDocument,
                            String data)

Factory constructor.

Parameters:

ownerDocument - the owner document

data - the data

Method Detail

getChildNodes

public 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 interface Node

Overrides:

getChildNodes in class NodeImpl

getNodeValue

public String getNodeValue()

Description copied from class: NodeImpl

Returns the node value.

Specified by:

getNodeValue in interface Node

Overrides:

getNodeValue in class NodeImpl

setNodeValueInternal

protected void setNodeValueInternal(String value)

Convenience wrapper for calling setNodeValueInternal when we are not performing a replacement operation

Parameters:

value - the value

setNodeValueInternal

protected void setNodeValueInternal(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 value

replace - flag to signal replace

setNodeValue

public void setNodeValue(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 interface Node

Overrides:

setNodeValue in class NodeImpl

getData

public String getData()

Returns:

character data currently stored in this node.

getLength

public int getLength()

NodeList method: Count the immediate children of this node

By 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.

Specified by:

getLength in interface NodeList

Overrides:

getLength in class NodeImpl

appendData

public void appendData(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 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 offser

count - the count

Throws:

DOMException - INDEX_SIZE_ERR if offset is negative or greater than length, or if count is negative.

DOMException - NO_MODIFICATION_ALLOWED_ERR if node is readonly.

insertData

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

Insert additional characters into the data stored in this node, at the offset specified.

Parameters:

offset - the offset

data - the data

Throws:

DOMException - INDEX_SIZE_ERR if offset is negative or greater than length.

DOMException - NO_MODIFICATION_ALLOWED_ERR if node is readonly.

replaceData

public void replaceData(int offset,
                        int count,
                        String data)
                 throws 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:

DOMException - INDEX_SIZE_ERR if offset is negative or greater than length, or if count is negative.

DOMException - NO_MODIFICATION_ALLOWED_ERR if node is readonly.

setData

public void setData(String value)
             throws DOMException

Store character data into this node.

Parameters:

value - the value

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR if node is readonly.

substringData

public String substringData(int offset,
                            int count)
                     throws 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:

DOMException - INDEX_SIZE_ERR if offset is negative or greater than length, or if count is negative.

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.