org.apache.cocoon.util.location: public interface: MultiLocatable

org.apache.cocoon.util.location
public interface: MultiLocatable [javadoc | source]

All Implemented Interfaces:
Locatable

All Known Implementing Classes:
ResourceNotFoundException, LibraryException, FormsRuntimeException, DuplicateIdException, JXTException, LibraryException, IncompletenessException, ProcessingException, ConnectionResetException, InvalidContinuationException, FormsException, LocatedRuntimeException, LocatedException, BindingException

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 org.apache.cocoon.util.location.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.java 446917 2006-09-16 19:10:40Z vgritsenko $

Method from org.apache.cocoon.util.location.MultiLocatable Summary:
addLocation, getLocations

Method from org.apache.cocoon.util.location.MultiLocatable Detail:
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.
public List getLocations() Return the list of locations.

Method from org.apache.cocoon.util.location.MultiLocatable Detail:

 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.

 public List getLocations()Return the list of locations.