jmlparser-core/com.github.javaparser/Position

Position

open class Position : Comparable<Position> (source)

A position in a source file. Lines and columns start counting at 1.

Constructors

constructor(line: Int, column: Int)

TODO: Do we refer to the characters as columns, ...or the spaces between (thus also before/after) characters as columns?

Properties

ABSOLUTE_BEGIN_LINE

val ABSOLUTE_BEGIN_LINE: Int = -1

Line numbers must be positive, thus

ABSOLUTE_END_LINE

val ABSOLUTE_END_LINE: Int = -2

column

val column: Int

FIRST_COLUMN

val FIRST_COLUMN: Int = 1

The first column -- note that it is 1-indexed (i.e.

FIRST_LINE

val FIRST_LINE: Int = 1

The first line -- note that it is 1-indexed (i.e.

HOME

val HOME: Position

The first position in the file.

line

val line: Int

Functions

compareTo

open fun compareTo(otherPosition: Position): Int

equals

open fun equals(o: Any): Boolean

hashCode

open fun hashCode(): Int

invalid

open fun invalid(): Boolean

isAfter

open fun isAfter(otherPosition: Position): Boolean

isAfterOrEqual

open fun isAfterOrEqual(otherPosition: Position): Boolean

isBefore

open fun isBefore(otherPosition: Position): Boolean

isBeforeOrEqual

open fun isBeforeOrEqual(otherPosition: Position): Boolean

nextLine

open fun nextLine(): Position

orIfInvalid

open fun orIfInvalid(alternativePosition: Position): Position

pos

open fun ~~pos~~(line: Int, column: Int): Position

Convenient factory method.

right

open fun right(characters: Int): Position

toString

open fun toString(): String

valid

open fun valid(): Boolean

Check if the position is usable, also checks for special positions (ABSOLUTE_BEGIN_LINE and ABSOLUTE_END_LINE).

withColumn

open fun withColumn(column: Int): Position

withLine

open fun withLine(line: Int): Position