Package org.sonar.plugins.java.api.location

Interface Position

All Superinterfaces:

Comparable<Position>

All Known Implementing Classes:

InternalPosition

public interface Position
extends Comparable<Position>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FIRST_COLUMN
static final int	FIRST_LINE
static final Comparator<Tree>	TREE_START_POSITION_COMPARATOR

Method Summary

Modifier and Type	Method	Description
static Position	at(int line, int column)
int	column()	The column number at the specified line.
int	columnOffset()	The column offset at the specified line.
static Position	endOf(SyntaxToken token)
static Position	endOf(SyntaxTrivia trivia)
static Position	endOf(Tree tree)
boolean	isAfter(Position other)
boolean	isBefore(Position other)
int	line()	The line number in a file.
int	lineOffset()	The line offset in a file.
static Position	startOf(SyntaxToken token)
static Position	startOf(SyntaxTrivia trivia)
static Position	startOf(Tree tree)

Methods inherited from interface java.lang.Comparable

compareTo

Field Details

TREE_START_POSITION_COMPARATOR

static final Comparator<Tree> TREE_START_POSITION_COMPARATOR

FIRST_LINE

static final int FIRST_LINE

See Also:

• Constant Field Values

FIRST_COLUMN

static final int FIRST_COLUMN

See Also:

• Constant Field Values

Method Details

line

int line()

The line number in a file. First line number is 1.

lineOffset

int lineOffset()

The line offset in a file. First line offset is 0. (lineOffset() == line() - 1)

column

int column()

The column number at the specified line. First column number is 1. (column() == columnOffset() + 1)

columnOffset

int columnOffset()

The column offset at the specified line. First column offset is 0. (columnOffset() == column() - 1)

at

static Position at(int line,
 int column)

isBefore

boolean isBefore(Position other)

isAfter

boolean isAfter(Position other)

startOf

static Position startOf(Tree tree)

endOf

static Position endOf(Tree tree)

startOf

static Position startOf(SyntaxTrivia trivia)

endOf

static Position endOf(SyntaxTrivia trivia)

startOf

static Position startOf(SyntaxToken token)

endOf

static Position endOf(SyntaxToken token)