Класс DocTreeScanner<R,P>

java.lang.Object

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

Все реализованные интерфейсы:: 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`	`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`	`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 - значение параметра, передаваемое методу 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 - значение параметра
Возвращает:: результат сканирования

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

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

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

END_OF_DOCUMENT_MARKER

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, 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.compiler/com/sun/source/util/DocTreeScanner.html