compact2, compact3
org.w3c.dom
Interface CharacterData
-
- All Superinterfaces:
- Node
- All Known Subinterfaces:
- CDATASection, Comment, Text, Text
public interface CharacterData extends Node
TheCharacterDatainterface extends Node with a set of attributes and methods for accessing character data in the DOM. For clarity this set is defined here rather than on each object that uses these attributes and methods. No DOM objects correspond directly toCharacterData, thoughTextand others do inherit the interface from it. Alloffsetsin this interface start from0.As explained in the
DOMStringinterface, text strings in the DOM are represented in UTF-16, i.e. as a sequence of 16-bit units. In the following, the term 16-bit units is used whenever necessary to indicate that indexing on CharacterData is done in 16-bit units.See also the Document Object Model (DOM) Level 3 Core Specification.
-
-
Field Summary
-
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_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description voidappendData(String arg)Append the string to the end of the character data of the node.voiddeleteData(int offset, int count)Remove a range of 16-bit units from the node.StringgetData()The character data of the node that implements this interface.intgetLength()The number of 16-bit units that are available throughdataand thesubstringDatamethod below.voidinsertData(int offset, String arg)Insert a string at the specified 16-bit unit offset.voidreplaceData(int offset, int count, String arg)Replace the characters starting at the specified 16-bit unit offset with the specified string.voidsetData(String data)The character data of the node that implements this interface.StringsubstringData(int offset, int count)Extracts a range of data from the node.-
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
-
-
-
-
Method Detail
getData
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 aCharacterDatanode. However, implementation limits may mean that the entirety of a node's data may not fit into a singleDOMString. In such cases, the user may callsubstringDatato retrieve the data in appropriately sized pieces.- Throws:
-
DOMException- DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in aDOMStringvariable on the implementation platform.
setData
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 aCharacterDatanode. However, implementation limits may mean that the entirety of a node's data may not fit into a singleDOMString. In such cases, the user may callsubstringDatato retrieve the data in appropriately sized pieces.- Throws:
-
DOMException- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
getLength
int getLength()
The number of 16-bit units that are available throughdataand thesubstringDatamethod below. This may have the value zero, i.e.,CharacterDatanodes may be empty.
substringData
String substringData(int offset, int count) throws DOMException
Extracts a range of data from the node.- 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
offsetandcountexceeds thelength, then all 16-bit units to the end of the data are returned. - Throws:
-
DOMException- INDEX_SIZE_ERR: Raised if the specifiedoffsetis negative or greater than the number of 16-bit units indata, or if the specifiedcountis negative.
DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into aDOMString.
appendData
void appendData(String arg) throws DOMException
Append the string to the end of the character data of the node. Upon success,dataprovides access to the concatenation ofdataand theDOMStringspecified.- Parameters:
-
arg- TheDOMStringto append. - Throws:
-
DOMException- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
insertData
void insertData(int offset, String arg) throws DOMExceptionInsert a string at the specified 16-bit unit offset.- Parameters:
-
offset- The character offset at which to insert. -
arg- TheDOMStringto insert. - Throws:
-
DOMException- INDEX_SIZE_ERR: Raised if the specifiedoffsetis negative or greater than the number of 16-bit units indata.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
deleteData
void deleteData(int offset, int count) throws DOMExceptionRemove a range of 16-bit units from the node. Upon success,dataandlengthreflect the change.- Parameters:
-
offset- The offset from which to start removing. -
count- The number of 16-bit units to delete. If the sum ofoffsetandcountexceedslengththen all 16-bit units fromoffsetto the end of the data are deleted. - Throws:
-
DOMException- INDEX_SIZE_ERR: Raised if the specifiedoffsetis negative or greater than the number of 16-bit units indata, or if the specifiedcountis negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
replaceData
void replaceData(int offset, int count, String arg) throws DOMExceptionReplace the characters starting at the specified 16-bit unit offset with the specified string.- Parameters:
-
offset- The offset from which to start replacing. -
count- The number of 16-bit units to replace. If the sum ofoffsetandcountexceedslength, then all 16-bit units to the end of the data are replaced; (i.e., the effect is the same as aremovemethod call with the same range, followed by anappendmethod invocation). -
arg- TheDOMStringwith which the range must be replaced. - Throws:
-
DOMException- INDEX_SIZE_ERR: Raised if the specifiedoffsetis negative or greater than the number of 16-bit units indata, or if the specifiedcountis negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
