Класс DocTreeScanner<R,P>

java.lang.Object

com.sun.source.util.DocTreeScanner<R,P>

Параметры типа:: R — тип возвращаемого значения методов этого посетителя. Используйте Void для посетителей, которым не нужно возвращать результаты.; P — тип дополнительного параметра методов этого посетителя. Используйте Void для посетителей, которым не нужен дополнительный параметр.

Все реализуемые интерфейсы:: DocTreeVisitor<R,P>

Прямые известные подклассы:: DocTreePathScanner

public class DocTreeScanner<R,P> extends Object implements DocTreeVisitor<R,P>

DocTreeVisitor, посещающий все дочерние узлы дерева. Чтобы посещать узлы определённого типа, переопределите соответствующий метод visitXYZ. Внутри метода вызовите super.visitXYZ, чтобы посетить дочерние узлы.

Вот пример подсчёта количества ошибочных узлов в дереве:

  class CountErrors extends DocTreeScanner<Integer,Void> {
     @Override
     public Integer visitErroneous(ErroneousTree node, Void p) {
         return 1;
     }
     @Override
     public Integer reduce(Integer r1, Integer r2) {
         return (r1 == null ? 0 : r1) + (r2 == null ? 0 : r2);
     }
  }

Требования к реализации:

Реализация методов visitXYZ по умолчанию определяет результат следующим образом:

Если у посещаемого узла нет дочерних узлов, результатом будет null.
Если у посещаемого узла один дочерний узел, результатом будет результат вызова scan для этого дочернего узла. Дочерний узел может быть простым узлом или списком узлов.
Если у посещаемого узла больше одного дочернего узла, результат определяется вызовом scan для каждого дочернего узла по очереди, а затем объединением результата каждого обхода, начиная со второго, с накопленным результатом, как определено методом reduce(R, R). Каждый дочерний узел может быть простым узлом или списком узлов. По умолчанию метод reduce устроен так, что результатом метода visitXYZ становится результат обхода последнего дочернего узла.

С версии:

1.8

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

Конструктор	Описание
`DocTreeScanner()`	Создаёт `DocTreeScanner`.

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

Модификатор и тип	Метод	Описание
`R`	`reduce(R r1, R r2)`	Объединяет два результата в один.
`R`	`scan(DocTree node, P p)`	Обходит один узел.
`R`	`scan(Iterable<? extends DocTree> nodes, P p)`	Обходит последовательность узлов.
`R`	`visitAttribute(AttributeTree node, P p)`	Посещает узел `AttributeTree`.
`R`	`visitAuthor(AuthorTree node, P p)`	Посещает узел `AuthorTree`.
`R`	`visitComment(CommentTree node, P p)`	Посещает узел `CommentTree`.
`R`	`visitDeprecated(DeprecatedTree node, P p)`	Посещает узел `DeprecatedTree`.
`R`	`visitDocComment(DocCommentTree node, P p)`	Посещает узел `DocCommentTree`.
`R`	`visitDocRoot(DocRootTree node, P p)`	Посещает узел `DocRootTree`.
`R`	`visitDocType(DocTypeTree node, P p)`	Посещает узел `DocTypeTree`.
`R`	`visitEndElement(EndElementTree node, P p)`	Посещает узел `EndElementTree`.
`R`	`visitEntity(EntityTree node, P p)`	Посещает узел `EntityTree`.
`R`	`visitErroneous(ErroneousTree node, P p)`	Посещает узел `ErroneousTree`.
`R`	`visitEscape(EscapeTree node, P p)`	Посещает узел `EscapeTree`.
`R`	`visitHidden(HiddenTree node, P p)`	Посещает узел `HiddenTree`.
`R`	`visitIdentifier(IdentifierTree node, P p)`	Посещает узел `IdentifierTree`.
`R`	`visitIndex(IndexTree node, P p)`	Посещает узел `IndexTree`.
`R`	`visitInheritDoc(InheritDocTree node, P p)`	Посещает узел `InheritDocTree`.
`R`	`visitLink(LinkTree node, P p)`	Посещает узел `LinkTree`.
`R`	`visitLiteral(LiteralTree node, P p)`	Посещает узел `LiteralTree`.
`R`	`visitOther(DocTree node, P p)`	Посещает узел `DocTree` неизвестного типа.
`R`	`visitParam(ParamTree node, P p)`	Посещает узел `ParamTree`.
`R`	`visitProvides(ProvidesTree node, P p)`	Посещает узел `ProvidesTree`.
`R`	`visitRawText(RawTextTree node, P p)`	Посещает узел `RawTextTree`.
`R`	`visitReference(ReferenceTree node, P p)`	Посещает узел `ReferenceTree`.
`R`	`visitReturn(ReturnTree node, P p)`	Посещает узел `ReturnTree`.
`R`	`visitSee(SeeTree node, P p)`	Посещает узел `SeeTree`.
`R`	`visitSerial(SerialTree node, P p)`	Посещает узел `SerialTree`.
`R`	`visitSerialData(SerialDataTree node, P p)`	Посещает узел `SerialDataTree`.
`R`	`visitSerialField(SerialFieldTree node, P p)`	Посещает узел `SerialFieldTree`.
`R`	`visitSince(SinceTree node, P p)`	Посещает узел `SinceTree`.
`R`	`visitSnippet(SnippetTree node, P p)`	Посещает узел `SnippetTree`.
`R`	`visitSpec(SpecTree node, P p)`	Посещает узел `SpecTree`.
`R`	`visitStartElement(StartElementTree node, P p)`	Посещает узел `StartElementTree`.
`R`	`visitSummary(SummaryTree node, P p)`	Посещает узел `SummaryTree`.
`R`	`visitSystemProperty(SystemPropertyTree node, P p)`	Посещает узел `SystemPropertyTree`.
`R`	`visitText(TextTree node, P p)`	Посещает узел `TextTree`.
`R`	`visitThrows(ThrowsTree node, P p)`	Посещает узел `ThrowsTree`.
`R`	`visitUnknownBlockTag(UnknownBlockTagTree node, P p)`	Посещает узел `UnknownBlockTagTree`.
`R`	`visitUnknownInlineTag(UnknownInlineTagTree node, P p)`	Посещает узел `UnknownInlineTagTree`.
`R`	`visitUses(UsesTree node, P p)`	Посещает узел `UsesTree`.
`R`	`visitValue(ValueTree node, P p)`	Посещает узел `ValueTree`.
`R`	`visitVersion(VersionTree node, P p)`	Посещает узел `VersionTree`.

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело и подлежит удалению: этот элемент API подлежит удалению в будущей версии. Финализация объявлена устаревшей и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает значение хеш-кода этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Переводит текущий поток в режим ожидания до пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Переводит текущий поток в режим ожидания до пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Переводит текущий поток в режим ожидания до пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

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

DocTreeScanner

public DocTreeScanner()

Создает DocTreeScanner.

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

scan

public R scan(DocTree node, P p)

Сканирует один узел.

Параметры:: node — узел для сканирования; p — значение параметра, передаваемое методу visit
Возвращает:: значение результата метода visit

scan

public R scan(Iterable<? extends DocTree> nodes, P p)

Сканирует последовательность узлов.

Параметры:: nodes — узлы для сканирования; p — значение параметра, передаваемое методу visit для каждого узла
Возвращает:: объединенное возвращаемое значение методов visit. Значения объединяются с помощью метода reduce.

reduce

public R reduce(R r1, R r2)

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

Параметры:: r1 — первое из объединяемых значений; r2 — второе из объединяемых значений
Возвращает:: результат объединения двух параметров

visitAttribute

public R visitAttribute(AttributeTree node, P p)

Посещает узел AttributeTree.

Определено:: visitAttribute в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitAuthor

public R visitAuthor(AuthorTree node, P p)

Посещает узел AuthorTree.

Определено:: visitAuthor в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitComment

public R visitComment(CommentTree node, P p)

Посещает узел CommentTree.

Определено:: visitComment в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitDeprecated

public R visitDeprecated(DeprecatedTree node, P p)

Посещает узел DeprecatedTree.

Определено:: visitDeprecated в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitDocComment

public R visitDocComment(DocCommentTree node, P p)

Посещает узел DocCommentTree.

Определено:: visitDocComment в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitDocRoot

public R visitDocRoot(DocRootTree node, P p)

Посещает узел DocRootTree.

Определено:: visitDocRoot в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitDocType

public R visitDocType(DocTypeTree node, P p)

Посещает узел DocTypeTree.

Определено:: visitDocType в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования
С версии:: 10

visitEndElement

public R visitEndElement(EndElementTree node, P p)

Посещает узел EndElementTree.

Определено:: visitEndElement в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitEntity

public R visitEntity(EntityTree node, P p)

Посещает узел EntityTree.

Определено:: visitEntity в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitErroneous

public R visitErroneous(ErroneousTree node, P p)

Посещает узел ErroneousTree.

Определено:: visitErroneous в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitEscape

public R visitEscape(EscapeTree node, P p)

Посещает узел EscapeTree.

Определено:: visitEscape в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования
С версии:: 21

visitHidden

public R visitHidden(HiddenTree node, P p)

Посещает узел HiddenTree.

Определено:: visitHidden в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitIdentifier

public R visitIdentifier(IdentifierTree node, P p)

Посещает узел IdentifierTree.

Определено:: visitIdentifier в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitIndex

public R visitIndex(IndexTree node, P p)

Посещает узел IndexTree.

Определено:: visitIndex в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitInheritDoc

public R visitInheritDoc(InheritDocTree node, P p)

Посещает узел InheritDocTree.

Определено:: visitInheritDoc в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitLink

public R visitLink(LinkTree node, P p)

Посещает узел LinkTree.

Определено:: visitLink в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitLiteral

public R visitLiteral(LiteralTree node, P p)

Посещает узел LiteralTree.

Определено:: visitLiteral в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitParam

public R visitParam(ParamTree node, P p)

Посещает узел ParamTree.

Определено:: visitParam в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitProvides

public R visitProvides(ProvidesTree node, P p)

Посещает узел ProvidesTree.

Определено:: visitProvides в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitRawText

public R visitRawText(RawTextTree node, P p)

Посещает узел RawTextTree.

Определено:: visitRawText в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования
С версии:: 23

visitReference

public R visitReference(ReferenceTree node, P p)

Посещает узел ReferenceTree.

Определено:: visitReference в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitReturn

public R visitReturn(ReturnTree node, P p)

Посещает узел ReturnTree.

Определено:: visitReturn в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitSee

public R visitSee(SeeTree node, P p)

Посещает узел SeeTree.

Определено:: visitSee в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitSerial

public R visitSerial(SerialTree node, P p)

Посещает узел SerialTree.

Определено:: visitSerial в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitSerialData

public R visitSerialData(SerialDataTree node, P p)

Посещает узел SerialDataTree.

Определено:: visitSerialData в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitSerialField

public R visitSerialField(SerialFieldTree node, P p)

Посещает узел SerialFieldTree.

Определено:: visitSerialField в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitSince

public R visitSince(SinceTree node, P p)

Посещает узел SinceTree.

Определено:: visitSince в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitSnippet

public R visitSnippet(SnippetTree node, P p)

Посещает узел SnippetTree.

Определено:: visitSnippet в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования
С версии:: 18

visitSpec

public R visitSpec(SpecTree node, P p)

Посещает узел SpecTree.

Определено:: visitSpec в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования
С версии:: 20

visitStartElement

public R visitStartElement(StartElementTree node, P p)

Посещает узел StartElementTree.

Определено:: visitStartElement в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitSummary

public R visitSummary(SummaryTree node, P p)

Посещает узел SummaryTree.

Определено:: visitSummary в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования
С версии:: 10

visitSystemProperty

public R visitSystemProperty(SystemPropertyTree node, P p)

Посещает узел SystemPropertyTree.

Определено:: visitSystemProperty в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования
С версии:: 12

visitText

public R visitText(TextTree node, P p)

Посещает узел TextTree.

Определено:: visitText в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitThrows

public R visitThrows(ThrowsTree node, P p)

Посещает узел ThrowsTree.

Определено:: visitThrows в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitUnknownBlockTag

public R visitUnknownBlockTag(UnknownBlockTagTree node, P p)

Посещает узел UnknownBlockTagTree.

Определено:: visitUnknownBlockTag в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitUnknownInlineTag

public R visitUnknownInlineTag(UnknownInlineTagTree node, P p)

Посещает узел UnknownInlineTagTree.

Определено:: visitUnknownInlineTag в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitUses

public R visitUses(UsesTree node, P p)

Посещает узел UsesTree.

Определено:: visitUses в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitValue

public R visitValue(ValueTree node, P p)

Посещает узел ValueTree.

Определено:: visitValue в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitVersion

public R visitVersion(VersionTree node, P p)

Посещает узел VersionTree.

Определено:: visitVersion в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

visitOther

public R visitOther(DocTree node, P p)

Посещает узел неизвестного типа DocTree. Это может произойти, если набор тегов изменится и в иерархию DocTree будут добавлены новые виды узлов.

Указано в:: visitOther в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: node — посещаемый узел; p — значение параметра
Возвращает:: результат сканирования

© 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.