Position

java.lang.Object
- com.github.javaparser.Position

All Implemented Interfaces:

java.lang.Comparable<Position>

Direct Known Subclasses:

UnicodeEscapeProcessingProvider.PositionMapping.DeltaInfo
```
public class Position
extends java.lang.Object
implements java.lang.Comparable<Position>
```
A position in a source file. Lines and columns start counting at 1.

Field Summary

Fields
Modifier and Type Field Description

int column

static Position HOME
The first position in the file

int line

Constructor Summary

Constructors
Constructor Description

Position(int line, int column)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(Position o)`
`boolean`	`equals(java.lang.Object o)`
`int`	`hashCode()`
`boolean`	`invalid()`
`boolean`	`isAfter(Position position)`
`boolean`	`isBefore(Position position)`
`Position`	`nextLine()`
`Position`	`orIfInvalid(Position anotherPosition)`
`static Position`	`pos(int line, int column)`	Convenient factory method.
`Position`	`right(int characters)`
`java.lang.String`	`toString()`
`boolean`	`valid()`	Check if the position is usable.
`Position`	`withColumn(int column)`
`Position`	`withLine(int line)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

line
```
public final int line
```

column
```
public final int column
```

HOME
```
public static final Position HOME
```
The first position in the file

Constructor Detail

Position

public Position(int line,
                int column)

Method Detail
- pos
```
public static Position pos(int line,
                           int column)
```
  Convenient factory method.
- withColumn
```
public Position withColumn(int column)
```
- withLine
```
public Position withLine(int line)
```
- right
```
public Position right(int characters)
```
  Returns:
  
  a position that is "characters" characters more to the right than this position.
- nextLine
```
public Position nextLine()
```
  Returns:
  
  a position that is on the start of the next line from this position.
- valid
```
public boolean valid()
```
  Check if the position is usable. Does not know what it is pointing at, so it can't check if the position is after the end of the source.
- invalid
```
public boolean invalid()
```
- orIfInvalid
```
public Position orIfInvalid(Position anotherPosition)
```
- isAfter
```
public boolean isAfter(Position position)
```
- isBefore
```
public boolean isBefore(Position position)
```
- compareTo
```
public int compareTo(Position o)
```
  Specified by:
  
  compareTo in interface java.lang.Comparable<Position>
- equals
```
public boolean equals(java.lang.Object o)
```
  Overrides:
  
  equals in class java.lang.Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class java.lang.Object
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class java.lang.Object