Класс SimpleDocTreeVisitor<R,P>

java.lang.Object

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

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

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

DEFAULT_VALUE

protected final R DEFAULT_VALUE

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

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

SimpleDocTreeVisitor

protected SimpleDocTreeVisitor()

Создаёт посетителя со значением DEFAULT_VALUE, равным null.

SimpleDocTreeVisitor

protected SimpleDocTreeVisitor(R defaultValue)

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

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

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

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

visitEscape

public R visitEscape(EscapeTree node, P p)

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

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

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

visitSnippet

public R visitSnippet(SnippetTree node, P p)

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

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

visitSpec

public R visitSpec(SpecTree node, P p)

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

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

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
С:: 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, 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/SimpleDocTreeVisitor.html