Class DocTreePathScanner<R,P>

java.lang.Object

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

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

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

Все реализуемые интерфейсы:: DocTreeVisitor<R,P>

public class DocTreePathScanner<R,P> extends DocTreeScanner<R,P>

Посетитель DocTreeVisitor, который посещает все дочерние узлы дерева и обеспечивает поддержку пути к родительским узлам. Чтобы посещать узлы определённого типа, просто переопределите соответствующий метод visitorXYZ. Внутри метода вызовите super.visitXYZ, чтобы посетить дочерние узлы.

Начиная с версии:: 1.8

Краткое описание конструкторов

Конструктор	Описание
`DocTreePathScanner()`	Создаёт `DocTreePathScanner`.

Краткое описание методов

Модификатор и тип	Метод	Описание
`DocTreePath`	`getCurrentPath()`	Возвращает текущий путь к узлу, сформированный активным на данный момент набором вызовов scan.
`R`	`scan(DocTree tree, P p)`	Сканирует один узел.
`R`	`scan(DocTreePath path, P p)`	Сканирует дерево, начиная с позиции, заданной путём к узлу дерева.

Методы, объявленные в классе DocTreeScanner

reduce, scan, visitAttribute, visitAuthor, visitComment, visitDeprecated, visitDocComment, visitDocRoot, visitDocType, visitEndElement, visitEntity, visitErroneous, visitEscape, visitHidden, visitIdentifier, visitIndex, visitInheritDoc, visitLink, visitLiteral, visitOther, visitParam, visitProvides, visitRawText, visitReference, visitReturn, visitSee, visitSerial, visitSerialData, visitSerialField, visitSince, visitSnippet, visitSpec, visitStartElement, visitSummary, visitSystemProperty, visitText, visitThrows, visitUnknownBlockTag, visitUnknownInlineTag, visitUses, visitValue, visitVersion

Модификатор и тип	Метод	Описание
`R`	`reduce(R r1, R r2)`	Объединяет два результата в один.
`R`	`scan(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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело и будет удалено: этот элемент API подлежит удалению в будущей версии. Финализация устарела и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого объекта `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо до истечения определённого интервала реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо до истечения определённого интервала реального времени.

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

DocTreePathScanner

public DocTreePathScanner()

Создаёт DocTreePathScanner.

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

scan

public R scan(DocTreePath path, P p)

Сканирует дерево, начиная с позиции, заданной путём к узлу дерева.

Параметры:: path — путь; p — значение, передаваемое методам посетителя
Возвращает:: результат, возвращённый основным методом посетителя

scan

public R scan(DocTree tree, P p)

Сканирует один узел. Текущий путь обновляется на время сканирования.

Переопределяет:: scan в классе DocTreeScanner<R,P>
Параметры:: tree — сканируемое дерево; p — значение, передаваемое методам посетителя
Возвращает:: результат, возвращённый основным методом посетителя

getCurrentPath

public DocTreePath getCurrentPath()

Возвращает текущий путь к узлу, сформированный активным на данный момент набором вызовов scan.

Возвращает:: текущий путь

© 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.