Интерфейс CharacterData

Все суперинтерфейсы:: Node

Все известные подинтерфейсы:: CDATASection, Comment, Text

public interface CharacterData extends Node

Интерфейс CharacterData расширяет Node набором атрибутов и методов для доступа к символьным данным в DOM. Для ясности этот набор определен здесь, а не в каждом объекте, использующем эти атрибуты и методы. Ни один объект DOM не соответствует непосредственно CharacterData, однако Text и другие наследуют от него этот интерфейс. Все offsets в этом интерфейсе начинаются с 0.

Как объясняется в интерфейсе DOMString, текстовые строки в DOM представлены в UTF-16, то есть как последовательность 16-битных единиц. Далее термин «16-битные единицы» используется при необходимости указать, что индексация CharacterData выполняется в 16-битных единицах.

См. также Спецификацию Document Object Model (DOM) Level 3 Core.

Начиная с версии:: 1.4, DOM Level 2

Краткое описание полей

Поля, объявленные в интерфейсе 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

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`appendData(String arg)`	Добавляет строку в конец символьных данных узла.
`void`	`deleteData(int offset, int count)`	Удаляет из узла диапазон 16-битных единиц.
`String`	`getData()`	Символьные данные узла, реализующего этот интерфейс.
`int`	`getLength()`	Количество 16-битных единиц, доступных через `data` и метод `substringData` ниже.
`void`	`insertData(int offset, String arg)`	Вставляет строку по указанному смещению в 16-битных единицах.
`void`	`replaceData(int offset, int count, String arg)`	Заменяет символы, начиная с указанного смещения в 16-битных единицах, заданной строкой.
`void`	`setData(String data)`	Символьные данные узла, реализующего этот интерфейс.
`String`	`substringData(int offset, int count)`	Извлекает диапазон данных из узла.

Методы, объявленные в интерфейсе 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

Подробное описание методов

getData

String getData() throws DOMException

Символьные данные узла, реализующего этот интерфейс. Реализация DOM не должна произвольно ограничивать объем данных, которые могут храниться в узле CharacterData. Однако ограничения реализации могут не позволить поместить все данные узла в один DOMString. В таких случаях пользователь может вызвать substringData, чтобы получить данные частями подходящего размера.

Вызывает исключение:: DOMException - DOMSTRING_SIZE_ERR: возникает, если возвращаемое значение содержит больше символов, чем может поместиться в переменной DOMString на платформе реализации.

setData

void setData(String data) throws DOMException

Вызывает исключение:: DOMException - NO_MODIFICATION_ALLOWED_ERR: возникает, если узел доступен только для чтения.

getLength

int getLength()

Количество 16-битных единиц, доступных через data и метод substringData ниже. Это значение может быть равно нулю, то есть узлы CharacterData могут быть пустыми.

substringData

String substringData(int offset, int count) throws DOMException

Извлекает диапазон данных из узла.

Параметры:: offset - Начальное смещение извлекаемой подстроки.; count - Количество извлекаемых 16-битных единиц.
Возвращает:: Указанную подстроку. Если сумма offset и count превышает length, возвращаются все 16-битные единицы до конца данных.
Вызывает исключение:: DOMException - INDEX_SIZE_ERR: возникает, если указанное значение offset отрицательно или превышает количество 16-битных единиц в data либо если указанное значение count отрицательно.
DOMSTRING_SIZE_ERR: возникает, если указанный диапазон текста не помещается в DOMString.

appendData

void appendData(String arg) throws DOMException

Добавляет строку в конец символьных данных узла. В случае успеха data предоставляет доступ к результату конкатенации data и указанного значения DOMString.

Параметры:: arg - Значение DOMString, которое нужно добавить.
Вызывает исключение:: DOMException - NO_MODIFICATION_ALLOWED_ERR: возникает, если этот узел доступен только для чтения.

insertData

void insertData(int offset, String arg) throws DOMException

Вставляет строку по указанному смещению в 16-битных единицах.

Параметры:: offset - Смещение символа, по которому нужно выполнить вставку.; arg - Значение DOMString, которое нужно вставить.
Вызывает исключение:: DOMException - INDEX_SIZE_ERR: возникает, если указанное значение offset отрицательно или превышает количество 16-битных единиц в data.
NO_MODIFICATION_ALLOWED_ERR: возникает, если этот узел доступен только для чтения.

deleteData

void deleteData(int offset, int count) throws DOMException

Удаляет из узла диапазон 16-битных единиц. В случае успеха data и length отражают это изменение.

Параметры:: offset - Смещение, с которого начинается удаление.; count - Количество 16-битных единиц для удаления. Если сумма offset и count превышает length, удаляются все 16-битные единицы от offset до конца данных.
Вызывает исключение:: DOMException - INDEX_SIZE_ERR: возникает, если указанное значение offset отрицательно или превышает количество 16-битных единиц в data либо если указанное значение count отрицательно.
NO_MODIFICATION_ALLOWED_ERR: возникает, если этот узел доступен только для чтения.

replaceData

void replaceData(int offset, int count, String arg) throws DOMException

Заменяет символы, начиная с указанного смещения в 16-битных единицах, заданной строкой.

Параметры:: offset - Смещение, с которого начинается замена.; count - Количество 16-битных единиц для замены. Если сумма offset и count превышает length, заменяются все 16-битные единицы до конца данных (то есть результат такой же, как при вызове метода remove с тем же диапазоном, за которым следует вызов метода append).; arg - Значение DOMString, которым нужно заменить диапазон.
Вызывает исключение:: DOMException - INDEX_SIZE_ERR: возникает, если указанное значение offset отрицательно или превышает количество 16-битных единиц в data либо если указанное значение count отрицательно.
NO_MODIFICATION_ALLOWED_ERR: возникает, если этот узел доступен только для чтения.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.xml/org/w3c/dom/CharacterData.html