org.apache.cocoon.util.location
Interface Location

All Known Implementing Classes:

LocationImpl

public interface Location

A location in a resource. The location is composed of the URI of the resource, and the line and column numbers within that resource (when available), along with a description.

Locations are mostly provided by Locatables objects.

Since:

2.1.8

Version:

$Id: Location.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary

static Location

UNKNOWN Constant for unknown locations.

Method Summary

int	getColumnNumber() Get the column number of this location
String	getDescription() Get the description of this location
int	getLineNumber() Get the line number of this location
String	getURI() Get the URI of this location

Field Detail

UNKNOWN

public static final Location UNKNOWN

Constant for unknown locations.

Method Detail

getDescription

public String getDescription()

Get the description of this location

Returns:

the description (can be null)

getURI

public String getURI()

Get the URI of this location

Returns:

the URI (null if unknown).

getLineNumber

public int getLineNumber()

Get the line number of this location

Returns:

the line number (-1 if unknown)

getColumnNumber

public int getColumnNumber()

Get the column number of this location

Returns:

the column number (-1 if unknown)