Класс 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. |
Краткое описание конструкторов
| Модификатор | Конструктор | Описание |
|---|---|---|
protected |
Создает посетителя со значением DEFAULT_VALUE, равным null. |
|
protected |
Создает посетителя с указанным значением DEFAULT_VALUE. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
protected R |
defaultAction |
Действие по умолчанию, используемое всеми переопределенными методами посещения. |
final R |
visit |
Вызывает соответствующий метод посещения, определяемый типом узла. |
final R |
visit |
Вызывает соответствующий метод посещения для каждого узла последовательности. |
R |
visitAttribute |
Посещает узел AttributeTree. |
R |
visitAuthor |
Посещает узел AuthorTree. |
R |
visitComment |
Посещает узел CommentTree. |
R |
visitDeprecated |
Посещает узел DeprecatedTree. |
R |
visitDocComment |
Посещает узел DocCommentTree. |
R |
visitDocRoot |
Посещает узел DocRootTree. |
R |
visitDocType |
Посещает узел DocTypeTree. |
R |
visitEndElement |
Посещает узел EndElementTree. |
R |
visitEntity |
Посещает узел EntityTree. |
R |
visitErroneous |
Посещает узел ErroneousTree. |
R |
visitEscape |
Посещает узел EscapeTree. |
R |
visitHidden |
Посещает узел HiddenTree. |
R |
visitIdentifier |
Посещает узел IdentifierTree. |
R |
visitIndex |
Посещает узел IndexTree. |
R |
visitInheritDoc |
Посещает узел InheritDocTree. |
R |
visitLink |
Посещает узел LinkTree. |
R |
visitLiteral |
Посещает узел LiteralTree. |
R |
visitOther |
Посещает узел DocTree неизвестного типа. |
R |
visitParam |
Посещает узел ParamTree. |
R |
visitProvides |
Посещает узел ProvidesTree. |
R |
visitRawText |
Посещает узел RawTextTree. |
R |
visitReference |
Посещает узел ReferenceTree. |
R |
visitReturn |
Посещает узел ReturnTree. |
R |
visitSee |
Посещает узел SeeTree. |
R |
visitSerial |
Посещает узел SerialTree. |
R |
visitSerialData |
Посещает узел SerialDataTree. |
R |
visitSerialField |
Посещает узел SerialFieldTree. |
R |
visitSince |
Посещает узел SinceTree. |
R |
visitSnippet |
Посещает узел SnippetTree. |
R |
visitSpec |
Посещает узел SpecTree. |
R |
visitStartElement |
Посещает узел StartElementTree. |
R |
visitSummary |
Посещает узел SummaryTree. |
R |
visitSystemProperty |
Посещает узел SystemPropertyTree. |
R |
visitText |
Посещает узел TextTree. |
R |
visitThrows |
Посещает узел ThrowsTree. |
R |
visitUnknownBlockTag |
Посещает узел UnknownBlockTagTree. |
R |
visitUnknownInlineTag |
Посещает узел UnknownInlineTagTree. |
R |
visitUses |
Посещает узел UsesTree. |
R |
visitValue |
Посещает узел ValueTree. |
R |
visitVersion |
Посещает узел VersionTree. |
Подробное описание полей
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
© 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