org.apache.cocoon.util.location
Interface MultiLocatable

All Superinterfaces:
Locatable
All Known Implementing Classes:
LocatedException, LocatedRuntimeException

public interface MultiLocatable
extends Locatable

An extension of Location for classes that can hold a list of locations. It will typically be used to build location stacks.

The first location of the collection returned by getLocations() should be be identical to the result of Locatable.getLocation().

If the list of locations designates a call stack, then its first element should be the deepmost location of this stack. This is consistent with the need for getLocation() to return the most precise location.

Since:
2.1.8
Version:
$Id: MultiLocatable.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Method Summary
 void addLocation(Location location)
          Add a location to the current list of locations.
 List getLocations()
          Return the list of locations.
 
Methods inherited from interface org.apache.cocoon.util.location.Locatable
getLocation
 

Method Detail

getLocations

public List getLocations()
Return the list of locations.

Returns:
a list of locations, possibly empty but never null.

addLocation

public void addLocation(Location location)
Add a location to the current list of locations.

Implementations are free to filter locations that can be added (e.g. Location.UNKNOWN), and there is therefore no guarantee that the given location will actually be added to the list. Filtered locations are silently ignored.

Parameters:
location - the location to be added.


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.