Интерфейс 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)`	Возвращает начальную позицию дерева внутри комментария в файле.

Методы, объявленные в интерфейсе com.sun.source.util.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, 2023, 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/21/docs/api/jdk.compiler/com/sun/source/util/DocSourcePositions.html