Интерфейс DocTreeVisitor

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

Все известные реализующие классы:: DocTreePathScanner, DocTreeScanner, SimpleDocTreeVisitor

public interface DocTreeVisitor<R,P>

Посетитель деревьев, в стиле паттерна проектирования «Посетитель». Классы, реализующие этот интерфейс, используются для работы с деревом, когда тип дерева неизвестен во время компиляции. Когда посетитель передаётся методу accept дерева, вызывается метод visitXyz, наиболее подходящий для этого дерева.

Классы, реализующие этот интерфейс, могут или не могут выбрасывать NullPointerException, если дополнительный параметр p имеет значение null; см. документацию реализующего класса для получения подробностей.

ПРЕДУПРЕЖДЕНИЕ: Возможно, в этот интерфейс будут добавлены методы для поддержки новых, на данный момент неизвестных, структур документации комментариев, добавленных в будущие версии языка программирования Java™. Поэтому классы-посетители, реализующие этот интерфейс напрямую, могут быть несовместимы с будущими версиями платформы.

C момента:: 1.8

Методы

Модификатор и тип	Метод	Описание
`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.
`default 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.
`default R`	`visitHidden(HiddenTree node, P p)`	Посещает узел HiddenTree.
`R`	`visitIdentifier(IdentifierTree node, P p)`	Посещает узел IdentifierTree.
`default 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.
`default 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.
`default R`	`visitSummary(SummaryTree node, P p)`	Посещает узел SummaryTree.
`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.
`default R`	`visitUses(UsesTree node, P p)`	Посещает узел UsesTree.
`R`	`visitValue(ValueTree node, P p)`	Посещает узел ValueTree.
`R`	`visitVersion(VersionTree node, P p)`	Посещает узел VersionTreeTree.

Методы

visitAttribute

R visitAttribute(AttributeTree node,
                 P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitAuthor

R visitAuthor(AuthorTree node,
              P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitComment

R visitComment(CommentTree node,
               P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitDeprecated

R visitDeprecated(DeprecatedTree node,
                  P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitDocComment

R visitDocComment(DocCommentTree node,
                  P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitDocRoot

R visitDocRoot(DocRootTree node,
               P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitDocType

default R visitDocType(DocTypeTree node,
                       P p)

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

Требования к реализации:: Посещает узел DocTypeTree, вызвав visitOther(node, p).
Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата
С момента:: 10

visitEndElement

R visitEndElement(EndElementTree node,
                  P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitEntity

R visitEntity(EntityTree node,
              P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitErroneous

R visitErroneous(ErroneousTree node,
                 P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitHidden

default R visitHidden(HiddenTree node,
                      P p)

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

Требования к реализации:: Посещает узел HiddenTree, вызвав visitOther(node, p).
Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата
С момента:: 9

visitIdentifier

R visitIdentifier(IdentifierTree node,
                  P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitIndex

default R visitIndex(IndexTree node,
                     P p)

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

Требования к реализации:: Посещает узел IndexTree вызвав visitOther(node, p).
Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата
С момента:: 9

visitInheritDoc

R visitInheritDoc(InheritDocTree node,
                  P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitLink

R visitLink(LinkTree node,
            P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitLiteral

R visitLiteral(LiteralTree node,
               P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitParam

R visitParam(ParamTree node,
             P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitProvides

default R visitProvides(ProvidesTree node,
                        P p)

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

Требования к реализации:: Посещает узел ProvidesTree вызвав visitOther(node, p).
Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата
С момента:: 9

visitReference

R visitReference(ReferenceTree node,
                 P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitReturn

R visitReturn(ReturnTree node,
              P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitSee

R visitSee(SeeTree node,
           P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitSerial

R visitSerial(SerialTree node,
              P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitSerialData

R visitSerialData(SerialDataTree node,
                  P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitSerialField

R visitSerialField(SerialFieldTree node,
                   P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitSince

R visitSince(SinceTree node,
             P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitStartElement

R visitStartElement(StartElementTree node,
                    P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitSummary

default R visitSummary(SummaryTree node,
                       P p)

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

Требования к реализации:: Посещает узел SummaryTree вызвав visitOther(node, p).
Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата
С момента:: 10

visitText

R visitText(TextTree node,
            P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitThrows

R visitThrows(ThrowsTree node,
              P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitUnknownBlockTag

R visitUnknownBlockTag(UnknownBlockTagTree node,
                       P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitUnknownInlineTag

R visitUnknownInlineTag(UnknownInlineTagTree node,
                        P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitUses

default R visitUses(UsesTree node,
                    P p)

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

Требования к реализации:: Посещает узел UsesTree вызовом visitOther(node, p).
Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата
С:: 9

visitValue

R visitValue(ValueTree node,
             P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitVersion

R visitVersion(VersionTree node,
               P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

visitOther

R visitOther(DocTree node,
             P p)

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

Параметры:: node - посещаемый узел; p - значение параметра
Возвращает:: значение результата

© 1993, 2020, 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/11/docs/api/jdk.compiler/com/sun/source/doctree/DocTreeVisitor.html