org.eclipse.xtext.generator.trace.internal

Interface IPlatformSpecificTrace<PlatformResource,Location extends IPlatformSpecificLocation<? extends PlatformResource>>

All Superinterfaces:

ITrace

All Known Subinterfaces:

IEclipseTrace

All Known Implementing Classes:

AbstractEclipseTrace, AbstractTraceWithoutStorage, FolderAwareTrace, StorageAwareTrace, ZipFileAwareTrace

public interface IPlatformSpecificTrace<PlatformResource,Location extends IPlatformSpecificLocation<? extends PlatformResource>>
extends ITrace

SPI for platform specific enhancements to the traces.

Author:

Sebastian Zarnekow - Initial contribution and API

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Iterable<? extends Location>	getAllAssociatedLocations() Returns all known associated locations.
java.lang.Iterable<? extends Location>	getAllAssociatedLocations(AbsoluteURI uri) Returns all known locations that were produced from the associated resource in the given absoluteTargetResource.
java.lang.Iterable<? extends Location>	getAllAssociatedLocations(ITextRegion localRegion) Returns all associated locations that match the given region.
java.lang.Iterable<? extends Location>	getAllAssociatedLocations(ITextRegion localRegion, AbsoluteURI uri) Returns all individual locations that match the given localRegion for the expected absoluteTargetResource.
java.lang.Iterable<? extends Location>	getAllAssociatedLocations(ITextRegion localRegion, PlatformResource associatedStorage) Returns all individual locations that match the given sourceRegion for the expected targetResource.
java.lang.Iterable<? extends Location>	getAllAssociatedLocations(PlatformResource associatedStorage) Returns all known locations that were produced from the associated resource in the given targetResource.
Location	getBestAssociatedLocation(ITextRegion localRegion) Returns the best associated location that matches the given region.
Location	getBestAssociatedLocation(ITextRegion localRegion, AbsoluteURI uri) Returns the best location that matches the given localRegion in the absoluteTargetResource.
Location	getBestAssociatedLocation(ITextRegion localRegion, PlatformResource associatedStorage) Returns the best location that matches the given sourceRegion in the targetResource.
PlatformResource	getLocalStorage() Returns the storage that is associated with this trace.

Methods inherited from interface org.eclipse.xtext.generator.trace.ITrace

getLocalLanguage, getLocalProjectConfig, getLocalURI, getSrcRelativeLocalURI, hasTraceData

Method Detail

getLocalStorage

PlatformResource getLocalStorage()

Returns the storage that is associated with this trace.

Returns:

the associated storage. Never null.

getBestAssociatedLocation

Location getBestAssociatedLocation(ITextRegion localRegion,
                                 PlatformResource associatedStorage)

Returns the best location that matches the given sourceRegion in the targetResource. If the region does not match a single location in the target, the following strategy applies:

• The merged region of all matching locations in the targetResource is returned.

If no location data is available or the sourceRegion does not yield a location in targetResource, returns null.

Parameters:

localRegion - the region in the current resource. May not be null.

associatedStorage - the expected target resource. May not be null.

Returns:

the best associated location or null if none.

getAllAssociatedLocations

java.lang.Iterable<? extends Location> getAllAssociatedLocations(ITextRegion localRegion,
                                                               PlatformResource associatedStorage)

Returns all individual locations that match the given sourceRegion for the expected targetResource.

Parameters:

localRegion - the region in the current resource. May not be null.

associatedStorage - the expected target resource. May not be null.

Returns:

all associated locations. Never null.

getAllAssociatedLocations

java.lang.Iterable<? extends Location> getAllAssociatedLocations(PlatformResource associatedStorage)

Returns all known locations that were produced from the associated resource in the given targetResource.

Parameters:

associatedStorage - the expected target resource. May not be null.

Returns:

all locations. Never null.

getBestAssociatedLocation

Location getBestAssociatedLocation(ITextRegion localRegion)

Description copied from interface: ITrace

Returns the best associated location that matches the given region. If the region does not match a single location, the following strategy applies:

• If the region spans multiple locations where the first and the last location belong to the same resource, the merged location is returned.
• If the region spans multiple locations that belong to different resources, the longest prefix location for a single resource is returned.
• If the region spans multiple overlapping locations that belong to different resources, null is returned.

If no location data is available, returns null.

Specified by:

getBestAssociatedLocation in interface ITrace

Parameters:

localRegion - the region in the current resource. May not be null.

Returns:

the best associated location or null if none.

getAllAssociatedLocations

java.lang.Iterable<? extends Location> getAllAssociatedLocations(ITextRegion localRegion)

Description copied from interface: ITrace

Returns all associated locations that match the given region.

Specified by:

getAllAssociatedLocations in interface ITrace

Parameters:

localRegion - the region in the current resource. May not be null.

Returns:

all associated locations. Never null.

getAllAssociatedLocations

java.lang.Iterable<? extends Location> getAllAssociatedLocations()

Description copied from interface: ITrace

Returns all known associated locations.

Specified by:

getAllAssociatedLocations in interface ITrace

Returns:

all associated locations. Never null.

getBestAssociatedLocation

Location getBestAssociatedLocation(ITextRegion localRegion,
                                 AbsoluteURI uri)

Description copied from interface: ITrace

Returns the best location that matches the given localRegion in the absoluteTargetResource. If the region does not match a single location in the target, the following strategy applies:

• The merged region of all matching locations in the targetResource is returned.

If no location data is available or the localRegion does not yield a location in absoluteTargetResource, returns null.

Specified by:

getBestAssociatedLocation in interface ITrace

Parameters:

localRegion - the region in the current resource. May not be null.

uri - the expected target resource. May not be null.

Returns:

the best associated location or null if none.

getAllAssociatedLocations

java.lang.Iterable<? extends Location> getAllAssociatedLocations(ITextRegion localRegion,
                                                               AbsoluteURI uri)

Description copied from interface: ITrace

Returns all individual locations that match the given localRegion for the expected absoluteTargetResource.

Specified by:

getAllAssociatedLocations in interface ITrace

Parameters:

localRegion - the region in the current resource. May not be null.

uri - the expected target resource. May not be null.

Returns:

all associated locations. Never null.

getAllAssociatedLocations

java.lang.Iterable<? extends Location> getAllAssociatedLocations(AbsoluteURI uri)

Description copied from interface: ITrace

Returns all known locations that were produced from the associated resource in the given absoluteTargetResource.

Specified by:

getAllAssociatedLocations in interface ITrace

Parameters:

uri - the expected target resource. May not be null.

Returns:

all locations. Never null.