Интерфейс DocSourcePositions

Все супер-интерфейсы:: SourcePositions

public interface DocSourcePositions extends SourcePositions

Предоставляет методы для получения позиции DocTree внутри комментария javadoc. Позиция определяется как смещение в символах от начала CompilationUnit, где первый символ находится по смещению 0.

С версии:: 1.8

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

Модификатор и тип	Метод	Описание
`long`	`getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)`	Возвращает конечную позицию дерева внутри комментария в файле.
`long`	`getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)`	Возвращает начальную позицию дерева внутри комментария в файле.

Методы, объявленные в интерфейсе SourcePositions

getEndPosition, getStartPosition

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

getStartPosition

long getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)

Возвращает начальную позицию дерева внутри комментария в файле. Если дерево не найдено в файле или начальная позиция недоступна, возвращает Diagnostic.NOPOS. Данное дерево должно находиться внутри данного дерева комментария, а данное дерево комментария документации должно возвращаться методом DocTrees.getDocCommentTree(com.sun.source.util.TreePath) для дерева внутри данного файла. Возвращаемая позиция должна указывать на начало фрагмента, соответствующего этому дереву, то есть для любого поддерева этого дерева должно выполняться одно из следующих условий:

getStartPosition(file, comment, tree) <= getStartPosition(file, comment, subtree) или
getStartPosition(file, comment, tree) == NOPOS или
getStartPosition(file, comment, subtree) == NOPOS

Параметры:: file — единица компиляции, в которой нужно найти дерево; comment — дерево комментария, содержащего дерево, для которого определяется позиция; tree — дерево, для которого определяется позиция
Возвращает:: начальную позицию дерева

getEndPosition

long getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)

Возвращает конечную позицию дерева внутри комментария в файле. Если дерево не найдено в файле или конечная позиция недоступна, возвращает Diagnostic.NOPOS. Данное дерево должно находиться внутри данного дерева комментария, а данное дерево комментария документации должно возвращаться методом DocTrees.getDocCommentTree(com.sun.source.util.TreePath) для дерева внутри данного файла. Возвращаемая позиция должна указывать на конец фрагмента, соответствующего этому дереву, то есть для любого поддерева этого дерева должно выполняться одно из следующих условий:

getEndPosition(file, comment, tree) >= getEndPosition(file, comment, subtree) или
getEndPosition(file, comment, tree) == NOPOS или
getEndPosition(file, comment, subtree) == NOPOS

Кроме того, должно выполняться одно из следующих условий:

getStartPosition(file, comment, tree) <= getEndPosition(file, comment, tree) или
getStartPosition(file, comment, tree) == NOPOS или
getEndPosition(file, comment, tree) == NOPOS

Параметры:: file — единица компиляции, в которой нужно найти дерево; comment — дерево комментария, содержащего дерево, для которого определяется позиция; tree — дерево, для которого определяется позиция
Возвращает:: конечную позицию дерева

© 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/DocSourcePositions.html