org.foxlabs.util

Class Location

java.lang.Object

org.foxlabs.util.Location

All Implemented Interfaces:

Serializable, Comparable<Location>

public final class Location
extends Object
implements Comparable<Location>, Serializable

This class represents text position in some abstract resource.

Author:

Fox Mulder

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	column Column position.
String	file Abstract resource name.
int	line Line position.
static Location	UNKNOWN Unknown location.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Location other) Compares this location to the specified one.
boolean	equals(Object obj) Determines if this location equals to the specified one.
int	hashCode() Returns a hash code value for this location.
String	toString() Returns string representing this location.
void	toString(StringBuilder buf) Appends string representation of this location to the specified buffer.
static Location	valueOf(int line, int column) Returns location for the specified line and column positions.
static Location	valueOf(String file) Returns location for the specified resource name.
static Location	valueOf(String file, int line, int column) Returns location for the specified resource name, line and column positions.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final Location UNKNOWN

Unknown location.

file

public final String file

Abstract resource name.

line

public final int line

Line position.

column

public final int column

Column position.

Method Detail

compareTo

public int compareTo(Location other)

Compares this location to the specified one. Returns a negative integer, zero, or a positive integer as this location is less than, equal to, or greater than the specified location.

Specified by:

compareTo in interface Comparable<Location>

Parameters:

other - Another location.

Returns:

A negative integer, zero, or a positive integer as this location is less than, equal to, or greater than the specified location.

hashCode

public int hashCode()

Returns a hash code value for this location.

Overrides:

hashCode in class Object

Returns:

A hash code value for this location.

equals

public boolean equals(Object obj)

Determines if this location equals to the specified one. Two locations considered to be equal if they have equal resource names, line and column positions.

Overrides:

equals in class Object

Parameters:

obj - Another location.

Returns:

true if this location equals to the specified one; false otherwise.

toString

public String toString()

Returns string representing this location.

Overrides:

toString in class Object

Returns:

String representing this location.

See Also:

toString(StringBuilder)

toString

public void toString(StringBuilder buf)

Appends string representation of this location to the specified buffer. The full format is file:line:column.

Parameters:

buf - Buffer to append.

valueOf

public static Location valueOf(String file)

Returns location for the specified resource name.

Parameters:

file - Abstract resource name.

Returns:

Location for the specified resource name.

valueOf

public static Location valueOf(int line,
               int column)

Returns location for the specified line and column positions.

Parameters:

line - Line position.

column - Column position.

Returns:

Location for the specified line and column positions.

valueOf

public static Location valueOf(String file,
               int line,
               int column)

Returns location for the specified resource name, line and column positions.

Parameters:

file - Abstract resource name.

line - Line position.

column - Column position.

Returns:

Location for the specified resource name, line and column positions.