SourceLocation (Closure Templates)

java.lang.Object
- com.google.template.soy.base.SourceLocation

@ParametersAreNonnullByDefault
public class SourceLocation
extends Object

Describes a source location in a Soy input file.

Field Summary

Fields
Modifier and Type Field and Description

static SourceLocation UNKNOWN
Deprecated.
There is no reason to use this other than laziness. Soy has complete source location information.

Fields
Modifier and Type	Field and Description
`static SourceLocation`	`UNKNOWN` Deprecated. There is no reason to use this other than laziness. Soy has complete source location information.

Constructor Summary

Constructors
Constructor and Description
`SourceLocation(String filePath)`
`SourceLocation(String filePath, int beginLine, int beginColumn, int endLine, int endColumn)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`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`	`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).
`String`	`getFileName()`
`String`	`getFilePath()` Returns a file path or URI useful for error messages.
`int`	`getLineNumber()` Returns the line number in the source file where this location begins (1-based).
`int`	`hashCode()`
`boolean`	`isKnown()` Deprecated. For the same reason that `UNKNOWN` is.
`String`	`toString()`

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

- Field Detail
  - UNKNOWN
```
@Deprecated
public static final SourceLocation UNKNOWN
```
    Deprecated. There is no reason to use this other than laziness. Soy has complete source location information.
    
    A nullish source location.
- 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)
```
- 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()
```
  - getLineNumber
```
public int getLineNumber()
```
    Returns the line number in the source file where this location begins (1-based). TODO(brndn): rename this to getBeginLine.
  - 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).
  - isKnown
```
@Deprecated
public boolean isKnown()
```
    Deprecated. For the same reason that UNKNOWN is.
    
    True iff this location is known, i.e. not the special value UNKNOWN.
  - 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
  - extend
```
public SourceLocation extend(SourceLocation other)
```
    Returns a new SourceLocation that starts where this SourceLocation starts and ends where other ends.

Class SourceLocation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNKNOWN

Constructor Detail

SourceLocation

SourceLocation

Method Detail

getFilePath

getFileName

getLineNumber

getBeginColumn

getEndLine

getEndColumn

isKnown

equals

hashCode

toString

extend