com.google.template.soy.base

Class SourceLocation

java.lang.Object

com.google.template.soy.base.SourceLocation

All Implemented Interfaces:

Comparable<SourceLocation>

@ParametersAreNonnullByDefault
public final class SourceLocation
extends Object
implements Comparable<SourceLocation>

Describes a source location in a Soy input file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SourceLocation.Point A Point in a source file.

Field Summary

Fields

Modifier and Type	Field and Description
static SourceLocation	UNKNOWN A nullish source location.

Constructor Summary

Constructors

Constructor and Description
SourceLocation(String filePath)
SourceLocation(String filePath, int beginLine, int beginColumn, int endLine, int endColumn)
SourceLocation(String filePath, SourceLocation.Point begin, SourceLocation.Point end)

Method Summary

Modifier and Type	Method and Description
int	compareTo(SourceLocation o)
boolean	equals(Object o)
SourceLocation	extend(int lines, int cols) Returns a new SourceLocation that starts where this SourceLocation starts and ends lines and cols further than where it ends.
SourceLocation	extend(SourceLocation other) Returns a new SourceLocation that starts where this SourceLocation starts and ends where other ends.
int	getBeginColumn() Returns the column number in the source file where this location begins (1-based).
int	getBeginLine() Returns the line number in the source file where this location begins (1-based).
SourceLocation	getBeginLocation() Returns a new location that points to the first character of this location.
SourceLocation.Point	getBeginPoint()
int	getEndColumn() Returns the column number in the source file where this location ends (1-based).
int	getEndLine() Returns the line number in the source file where this location ends (1-based).
SourceLocation	getEndLocation() Returns a new location that points to the last character of this location.
SourceLocation.Point	getEndPoint()
String	getFileName()
String	getFilePath() Returns a file path or URI useful for error messages.
int	hashCode()
boolean	isJustBefore(SourceLocation that) Returns true if this location ends one character before the other location starts.
boolean	isKnown() True iff this location is known, i.e.
SourceLocation	offsetEndCol(int offset)
SourceLocation	offsetStartCol(int offset)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN

public static final SourceLocation UNKNOWN

A nullish source location.

This is useful for default initialization of field values or when dealing with situations when you may or may not have a location. Obviously, associating real locations is always preferred when possible.

Constructor Detail

SourceLocation

public SourceLocation(String filePath,
                      int beginLine,
                      int beginColumn,
                      int endLine,
                      int endColumn)

Parameters:

filePath - A file path or URI useful for error messages.

beginLine - The line number in the source file where this location begins (1-based), or -1 if associated with the entire file instead of a line.

beginColumn - The column number in the source file where this location begins (1-based), or -1 if associated with the entire file instead of a line.

endLine - The line number in the source file where this location ends (1-based), or -1 if associated with the entire file instead of a line.

endColumn - The column number in the source file where this location ends (1-based), or -1 if associated with the entire file instead of a line.

SourceLocation

public SourceLocation(String filePath)

SourceLocation

public SourceLocation(String filePath,
                      SourceLocation.Point begin,
                      SourceLocation.Point end)

Method Detail

getFilePath

@Nonnull
public String getFilePath()

Returns a file path or URI useful for error messages. This should not be used to fetch content from the file system.

getFileName

@Nullable
public String getFileName()

getBeginLine

public int getBeginLine()

Returns the line number in the source file where this location begins (1-based).

getBeginColumn

public int getBeginColumn()

Returns the column number in the source file where this location begins (1-based).

getEndLine

public int getEndLine()

Returns the line number in the source file where this location ends (1-based).

getEndColumn

public int getEndColumn()

Returns the column number in the source file where this location ends (1-based).

isJustBefore

public boolean isJustBefore(SourceLocation that)

Returns true if this location ends one character before the other location starts.

isKnown

public boolean isKnown()

True iff this location is known, i.e. not the special value UNKNOWN.

compareTo

public int compareTo(SourceLocation o)

Specified by:

compareTo in interface Comparable<SourceLocation>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

offsetStartCol

public SourceLocation offsetStartCol(int offset)

offsetEndCol

public SourceLocation offsetEndCol(int offset)

extend

public SourceLocation extend(SourceLocation other)

Returns a new SourceLocation that starts where this SourceLocation starts and ends where other ends.

extend

public SourceLocation extend(int lines,
                             int cols)

Returns a new SourceLocation that starts where this SourceLocation starts and ends lines and cols further than where it ends.

getBeginLocation

public SourceLocation getBeginLocation()

Returns a new location that points to the first character of this location.

getBeginPoint

public SourceLocation.Point getBeginPoint()

getEndLocation

public SourceLocation getEndLocation()

Returns a new location that points to the last character of this location.

getEndPoint

public SourceLocation.Point getEndPoint()