gnu.xml.dom
Class DomCharacterData

java.lang.Object
  |
  +--gnu.xml.dom.DomNode
        |
        +--gnu.xml.dom.DomCharacterData

All Implemented Interfaces:

CharacterData, java.lang.Cloneable, org.w3c.dom.events.DocumentEvent, org.w3c.dom.events.EventTarget, Node, NodeList

Direct Known Subclasses:

DomComment, DomText

public abstract class DomCharacterData

extends DomNode

implements CharacterData

Abstract "CharacterData" implementation. This facilitates reusing code in classes implementing subtypes of that DOM interface (Text, Comment, CDATASection).

Representational efficiency wasn't exactly a goal here. Strings are not really an efficient internal representation, and aren't how parsers generally deliver data, but they're the only API exposed by DOM. To use a more efficient representation would involve either conversion costs, or defining some extension to DOM to permit faster construction. (For example, it could be defined through a new "feature" module.)

Version:

$Date: 2001/06/24 04:12:23 $

Author:

David Brownell

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

Method Summary

void	appendData(java.lang.String arg) DOM L1 Appends the specified data to the value of this node.
void	deleteData(int offset, int count) DOM L1 Modifies the value of this node.
NodeList	getChildNodes() DOM L1 Returns an empty list of children.
java.lang.String	getData() DOM L1 Returns the value of this node; same as getNodeValue.
int	getLength() DOM L1 Returns the length of the data.
java.lang.String	getNodeValue() DOM L1 Returns the value of this node.
void	insertData(int offset, java.lang.String arg) DOM L1 Modifies the value of this node.
void	replaceData(int offset, int count, java.lang.String arg) DOM L1 Modifies the value of this node.
void	setData(java.lang.String data) DOM L1 Assigns the value of this node; same as setNodeValue.
void	setNodeValue(java.lang.String value) DOM L1 Assigns the value of this node.
java.lang.String	substringData(int offset, int count) DOM L1 Returns the specified substring.

Methods inherited from class gnu.xml.dom.DomNode

addEventListener, appendChild, clone, cloneNode, createEvent, dispatchEvent, getAttributes, getElementsByTagName, getElementsByTagNameNS, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeType, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isReadonly, isSupported, item, makeReadonly, nameAndTypeEquals, normalize, removeChild, removeEventListener, replaceChild, setPrefix, trimToSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, getAttributes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setPrefix

Method Detail

appendData

public void appendData(java.lang.String arg)

DOM L1 Appends the specified data to the value of this node. Causes a DOMCharacterDataModified mutation event to be reported.

Specified by:

appendData in interface CharacterData

Following copied from interface: org.w3c.dom.CharacterData

Parameters:

argThe - DOMString to append.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

deleteData

public void deleteData(int offset,
                       int count)

DOM L1 Modifies the value of this node. Causes a DOMCharacterDataModified mutation event to be reported.

Specified by:

deleteData in interface CharacterData

Following copied from interface: org.w3c.dom.CharacterData

Parameters:

offsetThe - offset from which to start removing.

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

getNodeValue

public java.lang.String getNodeValue()

DOM L1 Returns the value of this node.

Specified by:

getNodeValue in interface Node

Overrides:

getNodeValue in class DomNode

Following copied from interface: org.w3c.dom.Node

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.

getData

public final java.lang.String getData()

DOM L1 Returns the value of this node; same as getNodeValue.

Specified by:

getData in interface CharacterData

Following copied from interface: org.w3c.dom.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.

getLength

public int getLength()

DOM L1 Returns the length of the data.

Specified by:

getLength in interface CharacterData

Overrides:

getLength in class DomNode

getChildNodes

public final NodeList getChildNodes()

DOM L1 Returns an empty list of children.

Specified by:

getChildNodes in interface Node

Overrides:

getChildNodes in class DomNode

insertData

public void insertData(int offset,
                       java.lang.String arg)

DOM L1 Modifies the value of this node.

Specified by:

insertData in interface CharacterData

Following copied from interface: org.w3c.dom.CharacterData

Parameters:

offsetThe - character offset at which to insert.

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

replaceData

public void replaceData(int offset,
                        int count,
                        java.lang.String arg)

DOM L1 Modifies the value of this node. Causes DOMCharacterDataModified mutation events to be reported (at least one).

Specified by:

replaceData in interface CharacterData

Following copied from interface: org.w3c.dom.CharacterData

Parameters:

offsetThe - offset from which to start replacing.

countThe - 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).

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

setNodeValue

public void setNodeValue(java.lang.String value)

DOM L1 Assigns the value of this node. Causes a DOMCharacterDataModified mutation event to be reported.

Specified by:

setNodeValue in interface Node

Overrides:

setNodeValue in class DomNode

setData

public final void setData(java.lang.String data)

DOM L1 Assigns the value of this node; same as setNodeValue.

Specified by:

setData in interface CharacterData

substringData

public java.lang.String substringData(int offset,
                                      int count)

DOM L1 Returns the specified substring.

Specified by:

substringData in interface CharacterData

Following copied from interface: org.w3c.dom.CharacterData

Parameters:

offsetStart - offset of substring to extract.

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