com.sun.source.util

Интерфейс DocSourcePositions

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

SourcePositions

@Supported
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. Данное дерево должно находиться под данным деревом комментария, и данное дерево комментария для документации должно быть возвращено из a 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. Данное дерево должно находиться под данным деревом комментария, и данное дерево комментария для документации должно быть возвращено из a 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 - дерево, которое разыскивается позиция.

Возвраты:

позиция запуска дерева.