Spec-Zone.ru › OpenJDK 25

Интерфейс NodeFilter

Все известные подинтерфейсы:
LSSerializerFilter
public interface NodeFilter
Фильтры — это объекты, которые умеют «отфильтровывать» узлы. Если NodeIterator или TreeWalker передан NodeFilter, он применяет фильтр перед возвратом следующего узла. Если фильтр указывает принять узел, логика обхода возвращает его; в противном случае обход ищет следующий узел и ведёт себя так, как будто отклонённого узла не было.

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

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

См. также Спецификацию обхода и диапазонов объектной модели документа (DOM) уровня 2.

Начиная с версии:
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 — узел, для которого проверяется, проходит ли он фильтр.
Возвращает:
Константу, определяющую, следует ли принять, отклонить или пропустить узел, как описано выше.

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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/traversal/NodeFilter.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API