Package net.sourceforge.pmd.lang.document

Class FileLocation

java.lang.Object

net.sourceforge.pmd.lang.document.FileLocation

public final class FileLocation
extends Object

Represents the coordinates of a text region, used for reporting. This provides access to the line and column positions, as well as the text file. Instances can be obtained from a TextRegion with TextDocument::toLocation.

This should replace the text coordinates methods in Node, GenericToken, and RuleViolation at least (see Reportable). TODO the end line/end column are barely used, mostly ignored even by renderers. Maybe these could be optional, or replaced by just a length in case a renderer wants to cut out a piece of the file.

Field Summary

Fields

Modifier and Type	Field	Description
static Comparator<FileLocation>	COMPARATOR
static Comparator<FileLocation>	COORDS_COMPARATOR

Method Summary

Modifier and Type	Method	Description
static FileLocation	caret(String fileName, int line, int column)	Returns a new location that starts and ends at the same position.
int	getEndColumn()	Exclusive, 1-based column number.
int	getEndLine()	Inclusive, 1-based line number.
TextPos2d	getEndPos()	Returns the end position.
String	getFileName()	File name of this position.
@Nullable TextRegion	getRegionInFile()	Returns the region in the file, or null if this was not available.
int	getStartColumn()	Inclusive, 1-based column number.
int	getStartLine()	Inclusive, 1-based line number.
TextPos2d	getStartPos()	Returns the start position.
static FileLocation	range(String fileName, TextRange2d range2d)	Creates a new location for a range of text.
String	startPosToString()	Formats the start position as e.g.
String	startPosToStringWithFile()	Formats the start position as e.g.
TextRange2d	toRange2d()	Turn this into a range country.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COORDS_COMPARATOR

public static final Comparator<FileLocation> COORDS_COMPARATOR

COMPARATOR

public static final Comparator<FileLocation> COMPARATOR

Method Detail

getFileName

public String getFileName()

File name of this position. This is a display name, it shouldn't be parsed as a Path.

getStartLine

public int getStartLine()

Inclusive, 1-based line number.

getEndLine

public int getEndLine()

Inclusive, 1-based line number.

getStartColumn

public int getStartColumn()

Inclusive, 1-based column number.

getEndColumn

public int getEndColumn()

Exclusive, 1-based column number.

getStartPos

public TextPos2d getStartPos()

Returns the start position.

getEndPos

public TextPos2d getEndPos()

Returns the end position.

toRange2d

public TextRange2d toRange2d()

Turn this into a range country.

getRegionInFile

public @Nullable TextRegion getRegionInFile()

Returns the region in the file, or null if this was not available.

startPosToString

public String startPosToString()

Formats the start position as e.g. "line 1, column 2".

startPosToStringWithFile

public String startPosToStringWithFile()

Formats the start position as e.g. "/path/to/file:1:2".

range

public static FileLocation range(String fileName,
                                 TextRange2d range2d)

Creates a new location for a range of text.

Throws:

IllegalArgumentException - If the file name is null

IllegalArgumentException - If any of the line/col parameters are strictly less than 1

IllegalArgumentException - If the line and column are not correctly ordered

IllegalArgumentException - If the start offset or length are negative

caret

public static FileLocation caret(String fileName,
                                 int line,
                                 int column)

Returns a new location that starts and ends at the same position.

Parameters:

fileName - File name

line - Line number

column - Column number

Returns:

A new location

Throws:

IllegalArgumentException - See #range(String, int, int, int, int)

toString

public String toString()

Overrides:

toString in class Object