Класс SimpleDocTreeVisitor<R,P>

java.lang.Object

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

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

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

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

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

С момента:: 1.8

Краткое описание полей

Модификатор и тип	Поле	Описание
`protected final R`	`DEFAULT_VALUE`	Значение по умолчанию, возвращаемое методом `default action`.

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

SimpleDocTreeVisitor()

SimpleDocTreeVisitor(R defaultValue)

Модификатор	Конструктор	Описание
`protected`	Создаёт посетителя со значением по умолчанию DEFAULT_VALUE = `null`.
`protected`	Создаёт посетителя со заданным значением по умолчанию DEFAULT_VALUE.

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

Модификатор и тип	Метод	Описание
`protected R`	`defaultAction(DocTree node, P p)`	Действие по умолчанию, используемое всеми методами посещения, которые не переопределены.
`final R`	`visit(DocTree node, P p)`	Вызывает соответствующий метод посещения, специфичный для типа узла.
`final R`	`visit(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

Подробное описание полей

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.

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

visitAuthor

public R visitAuthor(AuthorTree node, P p)

Обрабатывает узел AuthorTree.

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

visitComment

public R visitComment(CommentTree node, P p)

Обрабатывает узел CommentTree.

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

visitDeprecated

public R visitDeprecated(DeprecatedTree node, P p)

Обрабатывает узел DeprecatedTree.

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

visitDocComment

public R visitDocComment(DocCommentTree node, P p)

Обрабатывает узел DocCommentTree.

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

visitDocRoot

public R visitDocRoot(DocRootTree node, P p)

Обрабатывает узел DocRootTree.

Определено в:: visitDocRoot в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:: Эта реализация вызывает defaultAction.
Параметры:: 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.

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

visitEntity

public R visitEntity(EntityTree node, P p)

Обрабатывает узел EntityTree.

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

visitErroneous

public R visitErroneous(ErroneousTree node, P p)

Обрабатывает узел ErroneousTree.

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

visitHidden

public R visitHidden(HiddenTree node, P p)

Обрабатывает узел HiddenTree.

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

visitIdentifier

public R visitIdentifier(IdentifierTree node, P p)

Обрабатывает узел IdentifierTree.

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

visitIndex

public R visitIndex(IndexTree node, P p)

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

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

visitInheritDoc

public R visitInheritDoc(InheritDocTree node, P p)

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

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

visitLink

public R visitLink(LinkTree node, P p)

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

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

visitLiteral

public R visitLiteral(LiteralTree node, P p)

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

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

visitParam

public R visitParam(ParamTree node, P p)

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

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

visitProvides

public R visitProvides(ProvidesTree node, P p)

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

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

visitReference

public R visitReference(ReferenceTree node, P p)

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

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

visitReturn

public R visitReturn(ReturnTree node, P p)

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

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

visitSee

public R visitSee(SeeTree node, P p)

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

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

visitSerial

public R visitSerial(SerialTree node, P p)

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

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

visitSerialData

public R visitSerialData(SerialDataTree node, P p)

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

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

visitSerialField

public R visitSerialField(SerialFieldTree node, P p)

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

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

visitSince

public R visitSince(SinceTree node, P p)

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

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

visitStartElement

public R visitStartElement(StartElementTree node, P p)

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

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

visitSummary

public R visitSummary(SummaryTree node, P p)

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

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

visitSystemProperty

public R visitSystemProperty(SystemPropertyTree node, P p)

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

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

visitText

public R visitText(TextTree node, P p)

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

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

visitThrows

public R visitThrows(ThrowsTree node, P p)

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

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

visitUnknownBlockTag

public R visitUnknownBlockTag(UnknownBlockTagTree node, P p)

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

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

visitUnknownInlineTag

public R visitUnknownInlineTag(UnknownInlineTagTree node, P p)

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

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

visitUses

public R visitUses(UsesTree node, P p)

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

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

visitValue

public R visitValue(ValueTree node, P p)

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

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

visitVersion

public R visitVersion(VersionTree node, P p)

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

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

visitOther

public R visitOther(DocTree node, P p)

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

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

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