Class Document

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Документ

Представление XML-документа.

Методы

Метод Тип возврата Краткое описание
addContent(content) Document Добавляет указанный узел в конец документа.
addContent(index, content) Document Вставляет данный узел с заданным индексом среди всех узлов, которые являются непосредственными дочерними элементами документа.
cloneContent() Content[] Создает неприкрепленные копии всех узлов, которые являются непосредственными дочерними элементами документа.
detachRootElement() Element Отсоединяет и возвращает корневой узел Element документа.
getAllContent() Content[] Получает все узлы, которые являются непосредственными дочерними элементами документа.
getContent(index) Content Получает узел по заданному индексу среди всех узлов, которые являются непосредственными дочерними элементами документа.
getContentSize() Integer Получает количество узлов, которые являются непосредственными дочерними элементами документа.
getDescendants() Content[] Получает все узлы, которые являются прямыми или косвенными дочерними элементами документа, в том порядке, в котором они появляются в документе.
getDocType() DocType Получает объявление DocType документа.
getRootElement() Element Получает корневой узел Element документа.
hasRootElement() Boolean Определяет, имеет ли документ корневой узел Element .
removeContent() Content[] Удаляет все узлы, которые являются непосредственными дочерними элементами документа.
removeContent(content) Boolean Удаляет данный узел, если узел является непосредственным дочерним элементом документа.
removeContent(index) Content Удаляет узел с заданным индексом среди всех узлов, которые являются непосредственными дочерними элементами документа.
setDocType(docType) Document Задает объявление DocType документа.
setRootElement(element) Document Задает корневой узел Element документа.

Подробная документация

addContent(content)

Добавляет указанный узел в конец документа. Аргумент content может быть объектом Content или любым объектом узла, который соответствует типу, указанному в ContentType . Обратите внимание, однако, что документ может иметь только один дочерний узел Element , который неявно является корневым узлом Element .

Параметры

Имя Тип Описание
content Content узел для добавления

Возвращаться

Document — документ, для цепочки


addContent(index, content)

Вставляет данный узел с заданным индексом среди всех узлов, которые являются непосредственными дочерними элементами документа. Аргумент content может быть объектом Content или любым объектом узла, который соответствует типу, указанному в ContentType . Обратите внимание, однако, что документ может иметь только один дочерний узел Element , который неявно является корневым узлом Element .

Параметры

Имя Тип Описание
index Integer индекс, по которому вставляется узел среди всех узлов, которые являются непосредственными дочерними элементами документа
content Content узел для вставки

Возвращаться

Document — документ, для цепочки


cloneContent()

Создает неприкрепленные копии всех узлов, которые являются непосредственными дочерними элементами документа.

Возвращаться

Content[] — массив неприкрепленных копий всех узлов, которые являются непосредственными дочерними элементами документа.


detachRootElement()

Отсоединяет и возвращает корневой узел Element документа. Если документ не имеет корневого узла Element , этот метод возвращает значение null .

Возвращаться

Element — отсоединенный узел Element или null , если документ не имеет корневого узла Element .


getAllContent()

Получает все узлы, которые являются непосредственными дочерними элементами документа.

Возвращаться

Content[] — массив всех узлов, которые являются непосредственными дочерними элементами документа.


getContent(index)

Получает узел по заданному индексу среди всех узлов, которые являются непосредственными дочерними элементами документа. Если по данному индексу нет узла, этот метод возвращает null .

Параметры

Имя Тип Описание
index Integer индекс для узла среди всех узлов, которые являются непосредственными дочерними элементами документа

Возвращаться

Content — узел или null , если по данному индексу узла нет.


getContentSize()

Получает количество узлов, которые являются непосредственными дочерними элементами документа.

Возвращаться

Integer число — количество узлов, которые являются непосредственными дочерними элементами документа.


getDescendants()

Получает все узлы, которые являются прямыми или косвенными дочерними элементами документа, в том порядке, в котором они появляются в документе.

Возвращаться

Content[] — массив всех узлов, которые являются прямыми или косвенными дочерними элементами документа.


getDocType()

Получает объявление DocType документа. Если в документе нет узла DocumentType , этот метод возвращает значение null .

Возвращаться

DocType — узел DocumentType или null , если документ не имеет узла DocumentType .


getRootElement()

Получает корневой узел Element документа. Если документ не имеет корневого узла Element , этот метод возвращает значение null .

Возвращаться

Element — корневой узел Element или null , если документ не имеет корневого узла Element .


hasRootElement()

Определяет, имеет ли документ корневой узел Element .

Возвращаться

Booleantrue , если документ имеет корневой узел Element ; false , если нет


removeContent()

Удаляет все узлы, которые являются непосредственными дочерними элементами документа.

Возвращаться

Content[] — массив всех узлов, которые были непосредственными дочерними элементами документа до их удаления.


removeContent(content)

Удаляет данный узел, если узел является непосредственным дочерним элементом документа. Аргумент content может быть объектом Content или любым объектом узла, который соответствует типу, указанному в ContentType .

Параметры

Имя Тип Описание
content Content узел для удаления

Возвращаться

Booleantrue , если узел был непосредственным потомком и был удален; false , если нет


removeContent(index)

Удаляет узел с заданным индексом среди всех узлов, которые являются непосредственными дочерними элементами документа. Если по данному индексу нет узла, этот метод возвращает null .

Параметры

Имя Тип Описание
index Integer индекс для узла среди всех узлов, которые являются непосредственными дочерними элементами документа

Возвращаться

Content — узел, который был удален, или null , если по данному индексу узла нет.


setDocType(docType)

Задает объявление DocType документа. Если документ уже имеет другой узел DocType , этот метод перезаписывает старый узел. Этот метод создает исключение, если документ уже содержит тот же устанавливаемый узел DocType .

Параметры

Имя Тип Описание
docType DocType DocumentType для установки

Возвращаться

Document — документ, для цепочки


setRootElement(element)

Задает корневой узел Element документа. Если в документе уже есть корневой узел Element , этот метод перезаписывает старый узел.

Параметры

Имя Тип Описание
element Element узел корневого Element для установки

Возвращаться

Document — документ, для цепочки