Class Document

Документ

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

Методы

Метод Тип возвращаемого значения Краткое описание
add Content(content) Document Добавляет указанный узел в конец документа.
add Content(index, content) Document Вставляет заданный узел по заданному индексу среди всех узлов, являющихся непосредственными дочерними элементами документа.
clone Content() Content[] Создает неприкрепленные копии всех узлов, являющихся непосредственными дочерними элементами документа.
detach Root Element() Element |null Отсоединяет и возвращает корневой узел Element документа.
get All Content() Content[] Получает все узлы, являющиеся непосредственными дочерними элементами документа.
get Content(index) Content |null Получает узел с заданным индексом среди всех узлов, являющихся непосредственными дочерними элементами документа.
get Content Size() Integer Получает количество узлов, являющихся непосредственными дочерними элементами документа.
get Descendants() Content[] Получает все узлы, являющиеся прямыми или косвенными дочерними элементами документа, в том порядке, в котором они появляются в документе.
get Doc Type() Doc Type |null Получает объявление Doc Type ).
get Root Element() Element |null Получает корневой узел Element документа.
has Root Element() Boolean Определяет, имеет ли документ корневой узел Element .
remove Content() Content[] Удаляет все узлы, являющиеся непосредственными дочерними элементами документа.
remove Content(content) Boolean Удаляет указанный узел, если он является непосредственным дочерним элементом документа.
remove Content(index) Content |null Удаляет узел с заданным индексом среди всех узлов, являющихся непосредственными дочерними элементами документа.
set Doc Type(docType) Document Задает тип документа Doc Type ).
set Root Element(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 |null — Отсоединенный узел Element , или null если документ не содержит корневого узла Element .

getAllContent()

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

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

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

getContent(index)

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

Параметры

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

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

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

getContentSize()

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

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

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

getDescendants()

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

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

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

getDocType()

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

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

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

getRootElement()

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

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

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

hasRootElement()

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

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

Boolean — true если документ содержит корневой узел Element ; false в противном случае.

removeContent()

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

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

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

removeContent(content)

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

Параметры

Имя Тип Описание
content Content Узел, который нужно удалить.

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

Boolean — true если узел являлся непосредственным дочерним узлом и был удален; false , если нет.

removeContent(index)

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

Параметры

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

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

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

setDocType(docType)

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

Параметры

Имя Тип Описание
doc Type Doc Type Document Type для установки.

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

Document — документ для создания цепочки сообщений.

setRootElement(element)

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

Параметры

Имя Тип Описание
element Element Корневой узел Element , который необходимо задать.

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

Document — документ для создания цепочки сообщений.