Spec-Zone.ru › OpenJDK 25

Класс 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)
Действие по умолчанию, используемое всеми переопределенными методами посещения.
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 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.

Методы, объявленные в классе 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)
Действие по умолчанию, используемое всеми методами visit, которые не переопределены.
Параметры:
node — посещаемый узел
p — значение параметра, переданное методу visit
Возвращает:
значение результата, возвращаемое методом visit

visit

public final R visit(DocTree node, P p)
Вызывает соответствующий метод visit, предназначенный для типа узла.
Параметры:
node — узел, для которого выполняется диспетчеризация
p — параметр, передаваемый соответствующему методу visit
Возвращает:
значение, возвращаемое соответствующим методом visit

visit

public final R visit(Iterable<? extends DocTree> nodes, P p)
Вызывает соответствующий метод visit для каждого узла в последовательности.
Параметры:
nodes — узлы, для которых выполняется диспетчеризация
p — значение параметра, передаваемое каждому соответствующему методу visit
Возвращает:
значение, возвращенное последним из методов visit, или 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

visitRawText

public R visitRawText(RawTextTree node, P p)
Посещает узел RawTextTree.
Определено в:
visitRawText в интерфейсе DocTreeVisitor<R,P>
Требования к реализации:
Эта реализация вызывает defaultAction.
Параметры:
node — посещаемый узел
p — значение параметра
Возвращает:
результат defaultAction
Начиная с версии:
23

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

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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://docs.oracle.com/en/java/javase/25/docs/api/jdk.compiler/com/sun/source/util/SimpleDocTreeVisitor.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API