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

tree.getStartPosition() <= subtree.getStartPosition() или
tree.getStartPosition() == NOPOS или
subtree.getStartPosition() == NOPOS

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

getEndPosition

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

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

tree.getEndPosition() >= subtree.getEndPosition() или
tree.getEndPosition() == NOPOS или
subtree.getEndPosition() == NOPOS

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

tree.getStartPosition() <= tree.getEndPosition() или
tree.getStartPosition() == NOPOS или
tree.getEndPosition() == NOPOS

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