Интерфейс DocSourcePositions

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

public interface DocSourcePositions extends SourcePositions

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

С версии:: 1.8

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

Модификатор и тип	Метод	Описание
`long`	`getEndPosition(DocCommentTree comment, DocTree tree)`	Возвращает конечную позицию указанного `Tree`. Если конечная позиция недоступна, возвращает `Diagnostic.NOPOS`.
`default long`	`getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. вместо этого используйте `getEndPosition(DocCommentTree, DocTree)`
`long`	`getStartPosition(DocCommentTree comment, DocTree tree)`	Возвращает начальную позицию указанного `Tree`. Если начальная позиция недоступна, возвращает `Diagnostic.NOPOS`.
`default long`	`getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. вместо этого используйте `getStartPosition(DocCommentTree, DocTree)`

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

getEndPosition, getEndPosition, getStartPosition, getStartPosition

Модификатор и тип	Метод	Описание
`default long`	`getEndPosition(CompilationUnitTree file, Tree tree)`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. вместо этого используйте `SourcePositions.getEndPosition(Tree)`
`long`	`getEndPosition(Tree tree)`	Возвращает конечную позицию указанного `Tree`. Если конечная позиция недоступна, возвращает `Diagnostic.NOPOS`.
`default long`	`getStartPosition(CompilationUnitTree file, Tree tree)`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. вместо этого используйте `SourcePositions.getStartPosition(Tree)`
`long`	`getStartPosition(Tree tree)`	Возвращает начальную позицию указанного `Tree` или, если начальная позиция недоступна, возвращает `Diagnostic.NOPOS`.

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

getStartPosition

@Deprecated(since="27", forRemoval=true) default long getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)

Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии.

вместо этого используйте getStartPosition(DocCommentTree, DocTree)

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

getStartPosition

long getStartPosition(DocCommentTree comment, DocTree tree)

Возвращает начальную позицию указанного Tree. Если начальная позиция недоступна, возвращает Diagnostic.NOPOS.

Указанное дерево должно находиться внутри указанного дерева комментария. Возвращаемая позиция должна указывать на начало результата этого дерева, то есть для любого поддерева этого дерева должно выполняться следующее:

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

Параметры:: comment — дерево комментария, содержащего дерево, для которого определяется позиция; tree — дерево, для которого определяется позиция
Возвращает:: начальную позицию указанного Tree. Если начальная позиция недоступна, возвращает Diagnostic.NOPOS
С версии:: 27

getEndPosition

@Deprecated(since="27", forRemoval=true) default long getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)

Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии.

вместо этого используйте getEndPosition(DocCommentTree, DocTree)

Возвращает конечную позицию дерева внутри комментария в файле. Если дерево не найдено в файле или конечная позиция недоступна, возвращает 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 — дерево, для которого определяется позиция
Возвращает:: конечную позицию дерева

getEndPosition

long getEndPosition(DocCommentTree comment, DocTree tree)

Возвращает конечную позицию указанного Tree. Если конечная позиция недоступна, возвращает Diagnostic.NOPOS.

Указанное дерево должно находиться внутри указанного дерева комментария. Возвращаемая позиция должна указывать на конец результата этого дерева, то есть для любого поддерева этого дерева должно выполняться следующее:

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

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

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

Параметры:: comment — дерево комментария, содержащего дерево, для которого определяется позиция; tree — дерево, для которого определяется позиция
Возвращает:: конечную позицию указанного Tree. Если конечная позиция недоступна, возвращает Diagnostic.NOPOS
С версии:: 27

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