Класс DocTreeScanner<R,P>

java.lang.Object

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

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

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

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

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

A 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`	`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`.

Методы, унаследованные от класса java.lang.Object

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

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

DocTreeScanner

public DocTreeScanner()

Создаёт объект DocTreeScanner.

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

scan

public R scan(DocTree node, P p)

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

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

scan

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

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

Параметры:: nodes - сканируемые узлы; p - значение параметра, передаваемое методу посещения для каждого узла
Возвращает:: совокупное возвращаемое значение из методов посещения. Значения объединяются с помощью метода 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 - значение параметра
Возвращает:: результат сканирования

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 - значение параметра
Возвращает:: результат сканирования
C момента:: 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>
Требования к реализации:: Эта реализация возвращает null.
Параметры:: 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 - значение параметра
Возвращает:: результат сканирования

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 - значение параметра
Возвращает:: результат сканирования
Since:: 18

visitSpec

public R visitSpec(SpecTree node, P p)

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

Указано:: visitSpec в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация сканирует дочерние узлы слева направо.
Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: результат сканирования
Since:: 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 - значение параметра
Возвращает:: результат сканирования
Since:: 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, 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/jdk.compiler/com/sun/source/util/DocTreeScanner.html