Интерфейс NodeFilter

Все известные подинтерфейсы:: LSSerializerFilter

public interface NodeFilter

Фильтры — это объекты, которые умеют "фильтровать" узлы. Если NodeIterator или TreeWalker получают NodeFilter, они применяют фильтр перед тем, как вернуть следующий узел. Если фильтр разрешает принять узел, логика обхода возвращает его; в противном случае обход ищет следующий узел и делает вид, что отклоненный узел отсутствует.

DOM не предоставляет фильтры. NodeFilter — это всего лишь интерфейс, который пользователи могут реализовать, чтобы предоставить свои собственные фильтры.

NodeFilters не нужно знать, как переходить от узла к узлу, ни о структуре данных, по которой происходит обход. Это значительно упрощает написание фильтров, поскольку им нужно только уметь оценивать отдельный узел. Один фильтр можно использовать с несколькими видами обходов, что способствует повторному использованию кода.

См. также Спецификацию Document Object Model (DOM) Level 2 Traversal and Range.

С:: 9, DOM Level 2

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

Модификатор и тип	Поле	Описание
`static final short`	`FILTER_ACCEPT`	Принять узел.
`static final short`	`FILTER_REJECT`	Отклонить узел.
`static final short`	`FILTER_SKIP`	Пропустить текущий узел.
`static final int`	`SHOW_ALL`	Показать все `Nodes`.
`static final int`	`SHOW_ATTRIBUTE`	Показать `Attr` узлы.
`static final int`	`SHOW_CDATA_SECTION`	Показать `CDATASection` узлы.
`static final int`	`SHOW_COMMENT`	Показать `Comment` узлы.
`static final int`	`SHOW_DOCUMENT`	Показать `Document` узлы.
`static final int`	`SHOW_DOCUMENT_FRAGMENT`	Показать `DocumentFragment` узлы.
`static final int`	`SHOW_DOCUMENT_TYPE`	Показать `DocumentType` узлы.
`static final int`	`SHOW_ELEMENT`	Показать `Element` узлы.
`static final int`	`SHOW_ENTITY`	Показать `Entity` узлы.
`static final int`	`SHOW_ENTITY_REFERENCE`	Показать `EntityReference` узлы.
`static final int`	`SHOW_NOTATION`	Показать `Notation` узлы.
`static final int`	`SHOW_PROCESSING_INSTRUCTION`	Показать `ProcessingInstruction` узлы.
`static final int`	`SHOW_TEXT`	Показать `Text` узлы.

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

Модификатор и тип	Метод	Описание
`short`	`acceptNode(Node n)`	Проверить, является ли указанный узел видимым в логическом представлении `TreeWalker` или `NodeIterator`.

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

FILTER_ACCEPT

static final short FILTER_ACCEPT

Принять узел. Методы навигации, определенные для NodeIterator или TreeWalker, вернут этот узел.

См. также:

FILTER_REJECT

static final short FILTER_REJECT

Отклонить узел. Методы навигации, определенные для NodeIterator или TreeWalker, не вернут этот узел. Для TreeWalker, дети этого узла также будут отклонены. NodeIterators рассматривает это как синоним FILTER_SKIP.

См. также:

FILTER_SKIP

static final short FILTER_SKIP

Пропустить этот единственный узел. Методы навигации, определенные для NodeIterator или TreeWalker, не вернут этот узел. Для NodeIterator и TreeWalker, дети этого узла по-прежнему будут рассмотрены.

См. также:

SHOW_ALL

static final int SHOW_ALL

Показать все Nodes.

См. также:

SHOW_ELEMENT

static final int SHOW_ELEMENT

Показать узлы Element.

См. также:

SHOW_ATTRIBUTE

static final int SHOW_ATTRIBUTE

Показать узлы Attr. Это имеет смысл только при создании NodeIterator или TreeWalker с узлом атрибута в качестве root; в этом случае это означает, что узел атрибута будет появляться на первом месте итерации или обхода. Поскольку атрибуты никогда не являются детьми других узлов, они не отображаются при обходе по дереву документа.

См. также:

SHOW_TEXT

static final int SHOW_TEXT

Показать узлы Text.

См. также:

SHOW_CDATA_SECTION

static final int SHOW_CDATA_SECTION

Показать узлы CDATASection.

См. также:

SHOW_ENTITY_REFERENCE

static final int SHOW_ENTITY_REFERENCE

Показать узлы EntityReference.

См. также:

SHOW_ENTITY

static final int SHOW_ENTITY

Показать узлы Entity. Это имеет смысл только при создании NodeIterator или TreeWalker с узлом Entity в качестве root; в этом случае это означает, что узел Entity будет появляться на первом месте обхода.

См. также:

SHOW_PROCESSING_INSTRUCTION

static final int SHOW_PROCESSING_INSTRUCTION

Показать узлы ProcessingInstruction.

См. также:

SHOW_COMMENT

static final int SHOW_COMMENT

Показать узлы Comment.

См. также:

SHOW_DOCUMENT

static final int SHOW_DOCUMENT

Показать узлы Document.

См. также:

SHOW_DOCUMENT_TYPE

static final int SHOW_DOCUMENT_TYPE

Показать узлы DocumentType.

См. также:

SHOW_DOCUMENT_FRAGMENT

static final int SHOW_DOCUMENT_FRAGMENT

Показать узлы DocumentFragment.

См. также:

SHOW_NOTATION

static final int SHOW_NOTATION

Показать узлы Notation. Это имеет смысл только при создании NodeIterator или TreeWalker с узлом Notation в качестве root; в этом случае это означает, что узел Notation будет появляться на первом месте обхода.

См. также:

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

acceptNode

short acceptNode(Node n)

Проверить, виден ли указанный узел в логическом представлении TreeWalker или NodeIterator. Эта функция будет вызвана реализацией TreeWalker и NodeIterator; обычно она не вызывается напрямую из кода пользователя. (Хотя вы можете это сделать, если хотите использовать тот же фильтр для управления своей логикой приложения.)

Параметры:: n - Узел для проверки на соответствие фильтру.
Возвращает:: Константу, определяющую, принят, отклонен или пропущен узел, как описано выше.

© 1993, 2023, 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/21/docs/api/java.xml/org/w3c/dom/traversal/NodeFilter.html