Top Description Fields Constructors Methods

org.codehaus.commons.compiler

public Class Location

Class Inheritance

extends Object
implements Serializable

java.lang.Object
org.codehaus.commons.compiler.Location

All Implemented Interfaces

java.io.Serializable

Imports

java.io.Serializable, org.codehaus.commons.nullanalysis.Nullable

Immutable representation of the location of a character in a document, as defined by an (optional) file name, a line number and a column number.

Field Summary

Modifier and Type	Field and Description
private final int	columnNumber
private final String	fileName
private final int	lineNumber
public static final Location	NOWHERE Representation of an unspecified location.

Constructor Summary

Access	Constructor and Description
public	Location(String A human-readable indication where the document related to this `Location` can be found fileName, int lineNumber, int columnNumber)

Method Summary

Modifier and Type	Method and Description
public int	Returns: The column number associated with this location, or -1 getColumnNumber()
public String	Returns: The "file name" associated with this location, or `null` getFileName()
public int	Returns: The line number associated with this location, or -1 getLineNumber()
public String	toString() Overrides java.lang.Object.toString. Converts this `Location` into an english text, like '`File Main.java, Line 23, Column 79`'.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

columnNumber	back to summary
private final int columnNumber

fileName	back to summary
private final String fileName Annotations @Nullable

lineNumber	back to summary
private final int lineNumber

NOWHERE	back to summary
public static final Location NOWHERE Representation of an unspecified location.

Constructor Detail

Location	back to summary
public Location(String fileName, int lineNumber, int columnNumber) Parameters fileName:String A human-readable indication where the document related to this `Location` can be found

Method Detail

getColumnNumber	back to summary
public int getColumnNumber() Returns:int The column number associated with this location, or -1

getFileName	back to summary
public String getFileName() Returns:String The "file name" associated with this location, or `null` Annotations @Nullable

getLineNumber	back to summary
public int getLineNumber() Returns:int The line number associated with this location, or -1

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Converts this Location into an english text, like 'File Main.java, Line 23, Column 79'.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override