Класс DocTreeScanner<R,​P>

Все реализованные интерфейсы:
DocTreeVisitor<R,​P>
Прямые известные подклассы:
DocTreePathScanner
public class DocTreeScanner<R,P>
extends Object
implements DocTreeVisitor<R,​P>

A TreeVisitor that visits all the child tree nodes. To visit nodes of a particular type, just override the corresponding visitXYZ method. Inside your method, call super.visitXYZ to visit descendant nodes.

The default implementation of the visitXYZ methods will determine a result as follows:

  • If the node being visited has no children, the result will be null.
  • If the node being visited has one child, the result will be the result of calling scan on that child. The child may be a simple node or itself a list of nodes.
  • If the node being visited has more than one child, the result will be determined by calling scan each child in turn, and then combining the result of each scan after the first with the cumulative result so far, as determined by the reduce(R, R) method. Each child may be either a simple node of a list of nodes. The default behavior of the reduce method is such that the result of the visitXYZ method will be the result of the last child scanned.

Here is an example to count the number of erroneous nodes in a tree:

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);
      }
   }
Since:
1.8

Конструкторы

Конструктор Описание
DocTreeScanner()

Методы

Модификатор и тип Метод Описание
R reduce​(R r1, R r2)

Reduces two results into a combined result.

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 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)

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

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

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

Конструкторы

DocTreeScanner

public 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. Эта реализация возвращает null.

Указано в:
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. Эта реализация возвращает null.

Указано в:
visitComment в интерфейсе DocTreeVisitor<R,​P>
Параметры:
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. Эта реализация возвращает null.

Указано в:
visitDocRoot в интерфейсе DocTreeVisitor<R,​P>
Параметры:
node - посещаемый узел
p - значение параметра
Возвращает:
результат сканирования

visitDocType

public R visitDocType(DocTypeTree node,
                      P p)

Посещает узел DocTypeTree. Эта реализация возвращает null.

Указано в:
visitDocType в интерфейсе DocTreeVisitor<R,​P>
Параметры:
node - посещаемый узел
p - значение параметра
Возвращает:
результат сканирования

visitEndElement

public R visitEndElement(EndElementTree node,
                         P p)

Посещает узел EndElementTree. Эта реализация возвращает null.

Указано в:
visitEndElement в интерфейсе DocTreeVisitor<R,​P>
Параметры:
node - посещаемый узел
p - значение параметра
Возвращает:
результат сканирования

visitEntity

public R visitEntity(EntityTree node,
                     P p)

Посещает узел EntityTree. Эта реализация возвращает null.

Указано в:
visitEntity в интерфейсе DocTreeVisitor<R,​P>
Параметры:
node - посещаемый узел
p - значение параметра
Возвращает:
результат сканирования

visitErroneous

public R visitErroneous(ErroneousTree node,
                        P p)

Посещает узел ErroneousTree. Эта реализация возвращает null.

Указано в:
visitErroneous в интерфейсе DocTreeVisitor<R,​P>
Параметры:
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. Эта реализация возвращает null.

Указано в:
visitIdentifier в интерфейсе DocTreeVisitor<R,​P>
Параметры:
node - посещаемый узел
p - значение параметра
Возвращает:
результат сканирования

visitIndex

public R visitIndex(IndexTree node,
                    P p)

Посещает узел IndexTree. Эта реализация возвращает null.

Указано в:
visitIndex в интерфейсе DocTreeVisitor<R,​P>
Параметры:
node - посещаемый узел
p - значение параметра
Возвращает:
результат сканирования

visitInheritDoc

public R visitInheritDoc(InheritDocTree node,
                         P p)

Посещает узел InheritDocTree. Эта реализация возвращает null.

Указано в:
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. Эта реализация возвращает null.

Указано в:
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. Эта реализация возвращает null.

Указано в:
visitReference в интерфейсе DocTreeVisitor<R,​P>
Параметры:
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

visitText

public R visitText(TextTree node,
                   P p)

Посещает узел TextTree. Эта реализация возвращает null.

Определяется:
visitText в интерфейсе DocTreeVisitor<R,​P>
Параметры:
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)

Посещает узел VersionTreeTree. Эта реализация сканирует дочерние элементы в порядке слева направо.

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

visitOther

public R visitOther(DocTree node,
                    P p)

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

Определяется:
visitOther в интерфейсе DocTreeVisitor<R,​P>
Параметры:
node - посещаемый узел
p - значение параметра
Возвращает:
результат сканирования

© 1993, 2020, 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/11/docs/api/jdk.compiler/com/sun/source/util/DocTreeScanner.html

Spec-Zone .ru
спецификации, руководства, описания, API