Класс 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>

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

Since:: 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`	`visitRawText(RawTextTree node, P p)`	Посещает узел `RawTextTree`.
`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

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.

Specified by:: visitHidden in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction
Since:: 9

visitIdentifier

public R visitIdentifier(IdentifierTree node, P p)

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

Specified by:: visitIdentifier in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction

visitIndex

public R visitIndex(IndexTree node, P p)

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

Specified by:: visitIndex in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction
Since:: 9

visitInheritDoc

public R visitInheritDoc(InheritDocTree node, P p)

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

Specified by:: visitInheritDoc in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction

visitLink

public R visitLink(LinkTree node, P p)

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

Specified by:: visitLink in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction

visitLiteral

public R visitLiteral(LiteralTree node, P p)

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

Specified by:: visitLiteral in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction

visitParam

public R visitParam(ParamTree node, P p)

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

Specified by:: visitParam in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction

visitProvides

public R visitProvides(ProvidesTree node, P p)

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

Specified by:: visitProvides in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction
Since:: 9

visitRawText

public R visitRawText(RawTextTree node, P p)

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

Specified by:: visitRawText in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction
Since:: 23

visitReference

public R visitReference(ReferenceTree node, P p)

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

Specified by:: visitReference in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction

visitReturn

public R visitReturn(ReturnTree node, P p)

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

Specified by:: visitReturn in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction

visitSee

public R visitSee(SeeTree node, P p)

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

Specified by:: visitSee in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction

visitSerial

public R visitSerial(SerialTree node, P p)

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

Specified by:: visitSerial in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction

visitSerialData

public R visitSerialData(SerialDataTree node, P p)

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

Specified by:: visitSerialData in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат defaultAction

visitSerialField

public R visitSerialField(SerialFieldTree node, P p)

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

Specified by:: visitSerialField in interface DocTreeVisitor<R,P>
Implementation Requirements:: Эта реализация вызывает defaultAction.
Parameters:: node - посещаемый узел; p - значение параметра
Returns:: результат 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. Это может произойти, если набор тегов эволюционирует и к иерархии DocTree добавляются новые типы узлов.

Указано в:: 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, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/jdk.compiler/com/sun/source/util/SimpleDocTreeVisitor.html