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

Параметры типа:
R - тип возвращаемого значения методами этого посетителя. Используйте Void для посетителей, которым не нужно возвращать результаты.
P - тип дополнительного параметра для методов этого посетителя. Используйте Void для посетителей, которым не нужен дополнительный параметр.
Все реализованные интерфейсы:
DocTreeVisitor<R,​P>
public class SimpleDocTreeVisitor<R,P>
extends Object
implements DocTreeVisitor<R,​P>

Простой посетитель для узлов дерева.

С:
1.8

Поля

Модификатор и тип Поле Описание
protected R DEFAULT_VALUE

Значение по умолчанию, возвращаемое методом default action.

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

Модификатор Конструктор Описание
protected SimpleDocTreeVisitor()

Создает посетителя со значением по умолчанию null.
protected SimpleDocTreeVisitor​(R defaultValue)

Создает посетителя со заданным значением по умолчанию.

Методы

Модификатор и тип Метод Описание
protected R defaultAction​(DocTree node, P p)

Действие по умолчанию, используемое всеми методами visit, которые не переопределены.
R visit​(DocTree node, P p)

Вызывает соответствующий метод visit, специфичный для типа узла.
R visit​(Iterable<? extends DocTree> nodes, P p)

Вызывает соответствующий метод visit для каждого из последовательности узлов.
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

Поля

DEFAULT_VALUE

protected final R DEFAULT_VALUE

Значение по умолчанию, возвращаемое методом default action.

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

SimpleDocTreeVisitor

protected SimpleDocTreeVisitor()

Создает посетителя со значением по умолчанию null.

SimpleDocTreeVisitor

protected SimpleDocTreeVisitor(R defaultValue)

Создает посетителя со заданным значением по умолчанию.

Параметры:
defaultValue - значение по умолчанию, которое будет возвращаться методом по умолчанию.

Методы

defaultAction

protected R defaultAction(DocTree node,
                          P p)

Действие по умолчанию, используемое всеми методами посещения, которые не переопределены.

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

visit

public final R visit(DocTree node,
                     P p)

Вызывает соответствующий метод посещения, специфичный для типа узла.

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

visit

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

Вызывает соответствующий метод посещения для каждого из узлов последовательности.

Параметры:
nodes - узлы, на которых выполняется диспетчеризация
p - значение параметра, которое будет передано каждому соответствующему методу посещения
Возвращает:
значение, возвращаемое последним из методов посещения, или null, если ни один из них не был вызван.

visitAttribute

public R visitAttribute(AttributeTree node,
                        P p)

Посещает узел AttributeTree. Эта реализация вызывает defaultAction.

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

visitAuthor

public R visitAuthor(AuthorTree node,
                     P p)

Посещает узел AuthorTree. Эта реализация вызывает defaultAction.

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

visitComment

public R visitComment(CommentTree node,
                      P p)

Посещает узел CommentTree. Эта реализация вызывает defaultAction.

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

visitDeprecated

public R visitDeprecated(DeprecatedTree node,
                         P p)

Посещает узел DeprecatedTree. Эта реализация вызывает defaultAction.

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

visitDocComment

public R visitDocComment(DocCommentTree node,
                         P p)

Посещает узел DocCommentTree. Эта реализация вызывает defaultAction.

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

visitDocRoot

public R visitDocRoot(DocRootTree node,
                      P p)

Посещает узел DocRootTree. Эта реализация вызывает defaultAction.

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

visitDocType

public R visitDocType(DocTypeTree node,
                      P p)

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

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

visitEndElement

public R visitEndElement(EndElementTree node,
                         P p)

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

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

visitEntity

public R visitEntity(EntityTree node,
                     P p)

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

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

visitErroneous

public R visitErroneous(ErroneousTree node,
                        P p)

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

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

visitHidden

public R visitHidden(HiddenTree node,
                     P p)

Посещает узел HiddenTree. Эта реализация вызывает defaultAction.

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

visitIdentifier

public R visitIdentifier(IdentifierTree node,
                         P p)

Посещает узел IdentifierTree. Эта реализация вызывает defaultAction.

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

visitIndex

public R visitIndex(IndexTree node,
                    P p)

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

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

visitInheritDoc

public R visitInheritDoc(InheritDocTree node,
                         P p)

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

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

visitLink

public R visitLink(LinkTree node,
                   P p)

Посещает узел LinkTree. Эта реализация вызывает defaultAction.

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

visitLiteral

public R visitLiteral(LiteralTree node,
                      P p)

Посещает узел LiteralTree. Эта реализация вызывает defaultAction.

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

visitParam

public R visitParam(ParamTree node,
                    P p)

Посещает узел ParamTree. Эта реализация вызывает defaultAction.

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

visitProvides

public R visitProvides(ProvidesTree node,
                       P p)

Посещает узел ProvidesTree. Эта реализация вызывает defaultAction.

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

visitReference

public R visitReference(ReferenceTree node,
                        P p)

Посещает узел ReferenceTree. Эта реализация вызывает defaultAction.

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

visitReturn

public R visitReturn(ReturnTree node,
                     P p)

Посещает узел ReturnTree. Эта реализация вызывает defaultAction.

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

visitSee

public R visitSee(SeeTree node,
                  P p)

Посещает узел SeeTree. Эта реализация вызывает defaultAction.

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

visitSerial

public R visitSerial(SerialTree node,
                     P p)

Посещает узел SerialTree. Эта реализация вызывает defaultAction.

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

visitSerialData

public R visitSerialData(SerialDataTree node,
                         P p)

Посещает узел SerialDataTree. Эта реализация вызывает defaultAction.

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

visitSerialField

public R visitSerialField(SerialFieldTree node,
                          P p)

Посещает узел SerialFieldTree. Эта реализация вызывает defaultAction.

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

visitSince

public R visitSince(SinceTree node,
                    P p)

Посещает узел SinceTree. Эта реализация вызывает defaultAction.

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

visitStartElement

public R visitStartElement(StartElementTree node,
                           P p)

Посещает узел StartElementTree. Эта реализация вызывает defaultAction.

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

visitSummary

public R visitSummary(SummaryTree node,
                      P p)

Посещает узел SummaryTree. Эта реализация вызывает defaultAction.

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

visitText

public R visitText(TextTree node,
                   P p)

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

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

visitThrows

public R visitThrows(ThrowsTree node,
                     P p)

Посещает узел ThrowsTree. Эта реализация вызывает defaultAction.

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

visitUnknownBlockTag

public R visitUnknownBlockTag(UnknownBlockTagTree node,
                              P p)

Посещает узел UnknownBlockTagTree. Эта реализация вызывает defaultAction.

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

visitUnknownInlineTag

public R visitUnknownInlineTag(UnknownInlineTagTree node,
                               P p)

Посещает узел UnknownInlineTagTree. Эта реализация вызывает defaultAction.

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

visitUses

public R visitUses(UsesTree node,
                   P p)

Посещает узел UsesTree. Эта реализация вызывает defaultAction.

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

visitValue

public R visitValue(ValueTree node,
                    P p)

Посещает узел ValueTree. Эта реализация вызывает defaultAction.

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

visitVersion

public R visitVersion(VersionTree node,
                      P p)

Посещает узел VersionTreeTree. Эта реализация вызывает defaultAction.

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

visitOther

public R visitOther(DocTree node,
                    P p)

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

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

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

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