Интерфейс XPathResult

public interface XPathResult

Интерфейс XPathResult представляет результат вычисления XPath 1.0 выражения в контексте конкретного узла. Поскольку вычисление XPath выражения может привести к различным типам результатов, этот объект позволяет определить и обработать тип и значение результата.

См. также Спецификацию XPath для DOM уровня 3.

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

Модификатор и тип	Поле	Описание
`static final short`	`ANY_TYPE`	Этот код не представляет конкретный тип.
`static final short`	`ANY_UNORDERED_NODE_TYPE`	Результат — набор узлов, определенный в соответствии с и будет доступен как одиночный узел, который может быть `null` если набор узлов пуст.
`static final short`	`BOOLEAN_TYPE`	Результат — булево значение, определенное в соответствии с .
`static final short`	`FIRST_ORDERED_NODE_TYPE`	Результат — набор узлов, определенный в соответствии с и будет доступен как одиночный узел, который может быть `null` если набор узлов пуст.
`static final short`	`NUMBER_TYPE`	Результат — число, определенное в соответствии с .
`static final short`	`ORDERED_NODE_ITERATOR_TYPE`	Результат — набор узлов, определенный в соответствии с, который будет доступен итеративно, что обеспечит узлы в порядке документа.
`static final short`	`ORDERED_NODE_SNAPSHOT_TYPE`	Результат — набор узлов, определенный в соответствии с, который будет доступен как моментальный список узлов, которые будут в оригинальном порядке документа.
`static final short`	`STRING_TYPE`	Результат — строка, определенная в соответствии с .
`static final short`	`UNORDERED_NODE_ITERATOR_TYPE`	Результат — набор узлов, определенный в соответствии с, который будет доступен итеративно, что может не обеспечить узлы в определённом порядке.
`static final short`	`UNORDERED_NODE_SNAPSHOT_TYPE`	Результат — набор узлов, определенный в соответствии с, который будет доступен как моментальный список узлов, которые могут не быть в определённом порядке.

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

Модификатор и тип	Метод	Описание
`boolean`	`getBooleanValue()`	Значение этого булева результата.
`boolean`	`getInvalidIteratorState()`	Указывает, что итератор стал недоступным.
`double`	`getNumberValue()`	Значение этого числового результата.
`short`	`getResultType()`	Код, представляющий тип этого результата, как определено в константах типа.
`Node`	`getSingleNodeValue()`	Значение этого результата единственного узла, который может быть `null`.
`int`	`getSnapshotLength()`	Количество узлов в моментальном снимке результата.
`String`	`getStringValue()`	Значение этого строкового результата.
`Node`	`iterateNext()`	Итерирует и возвращает следующий узел из набора узлов или `null` если больше узлов нет.
`Node`	`snapshotItem(int index)`	Возвращает `index`-й элемент в коллекции моментального снимка.

Подробное описание полей

ANY_TYPE

static final short ANY_TYPE

Этот код не представляет конкретный тип. Оценка выражения XPath никогда не даст этот тип. Если этот тип затребован, оценка вернёт тот тип, который естественным образом получается в результате оценки выражения.
Если естественный результат — набор узлов, когда был запрошен ANY_TYPE, тогда UNORDERED_NODE_ITERATOR_TYPE всегда является результатом типа. Любая другая форма представления набора узлов должна быть явно запрошена.

См. также:

Значения константных полей

NUMBER_TYPE

static final short NUMBER_TYPE

Результат — число, как определено . Изменение документа не делает число недействительным, но может означать, что повторная оценка не даст то же самое число.

См. также:

Значения константных полей

STRING_TYPE

static final short STRING_TYPE

Результат — строка, как определено . Изменение документа не делает строку недействительной, но может означать, что строка больше не соответствует текущему документу.

См. также:

Значения константных полей

BOOLEAN_TYPE

static final short BOOLEAN_TYPE

Результат — булево значение, как определено . Изменение документа не делает булево значение недействительным, но может означать, что повторная оценка не даст то же самое булево значение.

См. также:

Значения константных полей

UNORDERED_NODE_ITERATOR_TYPE

static final short UNORDERED_NODE_ITERATOR_TYPE

Результат — набор узлов, как определено , к которому будет осуществляться итеративный доступ, и который может не выдавать узлы в определённом порядке. Изменение документа делает итерацию недействительной.
Это тип по умолчанию, возвращаемый, если результатом является набор узлов и запрошен ANY_TYPE.

См. также:

Значения константных полей

ORDERED_NODE_ITERATOR_TYPE

static final short ORDERED_NODE_ITERATOR_TYPE

Результат — набор узлов, как определено , к которому будет осуществляться итеративный доступ, выдавая узлы в порядке документа. Изменение документа делает итерацию недействительной.

См. также:

Значения константных полей

UNORDERED_NODE_SNAPSHOT_TYPE

static final short UNORDERED_NODE_SNAPSHOT_TYPE

Результат — набор узлов, как определено , к которому будет осуществляться доступ как к снимку списка узлов, которые могут не быть в определённом порядке. Изменение документа не делает снимок недействительным, но может означать, что повторная оценка не даст тот же снимок, а узлы в снимке могут быть изменены, перемещены или удалены из документа.

См. также:

Значения константных полей

ORDERED_NODE_SNAPSHOT_TYPE

static final short ORDERED_NODE_SNAPSHOT_TYPE

Результат — набор узлов, как определено , к которому будет осуществляться доступ как к снимку списка узлов, которые будут в исходном порядке документа. Изменение документа не делает снимок недействительным, но может означать, что повторная оценка не даст тот же снимок, а узлы в снимке могут быть изменены, перемещены или удалены из документа.

См. также:

Значения константных полей

ANY_UNORDERED_NODE_TYPE

static final short ANY_UNORDERED_NODE_TYPE

Результат — набор узлов, как определено , и к нему будет осуществляться доступ как к одному узлу, который может быть null если набор узлов пуст. Изменение документа не делает узел недействительным, но может означать, что узел результата больше не соответствует текущему документу. Это удобство позволяет оптимизацию, так как реализация может остановиться, как только любой узел в результирующем наборе будет найден.
Если в фактическом результате более одного узла, единственный возвращённый узел может не быть первым в порядке документа.

См. также:

Значения константных полей

FIRST_ORDERED_NODE_TYPE

static final short FIRST_ORDERED_NODE_TYPE

Результат — набор узлов, как определено , и к нему будет осуществляться доступ как к одному узлу, который может быть null если набор узлов пуст. Изменение документа не делает узел недействительным, но может означать, что узел результата больше не соответствует текущему документу. Это удобство позволяет оптимизацию, так как реализация может остановиться, как только первый узел в порядке документа результирующего набора будет найден.
Если в фактическом результате более одного узла, единственный возвращённый узел будет первым в порядке документа.

См. также:

Значения константных полей

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

getResultType

short getResultType()

Код, представляющий тип этого результата, как определено константами типов.

getNumberValue

double getNumberValue() throws XPathException

Значение этого числового результата. Если базовый тип double привязки DOM не поддерживает непосредственно точное значение IEEE 754 результата выражения XPath, то определение привязки должно указать, как число XPath преобразуется в число привязки.

Исключения:: XPathException - TYPE_ERR: возбуждается, если resultType не NUMBER_TYPE.

getStringValue

String getStringValue() throws XPathException

Значение этого строкового результата.

Исключения:: XPathException - TYPE_ERR: возбуждается, если resultType не STRING_TYPE.

getBooleanValue

boolean getBooleanValue() throws XPathException

Значение этого булева результата.

Исключения:: XPathException - TYPE_ERR: возбуждается, если resultType не BOOLEAN_TYPE.

getSingleNodeValue

Node getSingleNodeValue() throws XPathException

Значение этого результата с единственным узлом, которое может быть null.

Исключения:: XPathException - TYPE_ERR: возбуждается, если resultType не ANY_UNORDERED_NODE_TYPE или FIRST_ORDERED_NODE_TYPE.

getInvalidIteratorState

boolean getInvalidIteratorState()

Указывает, что итератор стал недействительным. Истина, если resultType является UNORDERED_NODE_ITERATOR_TYPE или ORDERED_NODE_ITERATOR_TYPE и документ был изменён с момента возвращения этого результата.

getSnapshotLength

int getSnapshotLength() throws XPathException

Количество узлов в снимке результата. Допустимые значения для индексов snapshotItem — 0 до snapshotLength-1 включительно.

Исключения:: XPathException - TYPE_ERR: возбуждается, если resultType не UNORDERED_NODE_SNAPSHOT_TYPE или ORDERED_NODE_SNAPSHOT_TYPE.

iterateNext

Node iterateNext() throws XPathException, DOMException

Итерация и возврат следующего узла из набора узлов или null если больше нет узлов.

Возвращает:: Возвращает следующий узел.
Исключения:: XPathException - TYPE_ERR: возбуждается, если resultType не UNORDERED_NODE_ITERATOR_TYPE или ORDERED_NODE_ITERATOR_TYPE.; DOMException - INVALID_STATE_ERR: Документ был изменён с момента возвращения результата.

snapshotItem

Node snapshotItem(int index) throws XPathException

Возвращает index-й элемент в коллекции снимков. Если index больше или равно количеству узлов в списке, этот метод возвращает null. В отличие от результата итератора, снимок не становится недействительным, но может не соответствовать текущему документу, если он изменён.

Параметры:: index - Индекс в коллекции снимков.
Возвращает:: Узел в index-й позиции в NodeList, или null если это недействительный индекс.
Исключения:: XPathException - TYPE_ERR: возбуждается, если resultType не UNORDERED_NODE_SNAPSHOT_TYPE или ORDERED_NODE_SNAPSHOT_TYPE.

© 1993, 2021, 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/17/docs/api/jdk.xml.dom/org/w3c/dom/xpath/XPathResult.html