org.eclipse.xtext.generator.trace.internal

Interface IPlatformSpecificTraceProvider<PlatformResource,Trace extends IPlatformSpecificTrace<PlatformResource,?>>

All Superinterfaces:

ITraceForURIProvider

All Known Subinterfaces:

ITraceForStorageProvider

All Known Implementing Classes:

ITraceForStorageProvider.Null, NoTraces, TraceForStorageProvider

public interface IPlatformSpecificTraceProvider<PlatformResource,Trace extends IPlatformSpecificTrace<PlatformResource,?>>
extends ITraceForURIProvider

SPI for platform specific enhancements to trace providers.

Author:

Sebastian Zarnekow - Initial contribution and API

Method Summary

Methods

Modifier and Type	Method and Description
Trace	getTraceToSource(AbsoluteURI absoluteDerivedResource, IProjectConfig project) Returns the trace information to the sources that were used as input for the given derived resource.
Trace	getTraceToSource(PlatformResource derivedResource) Returns the trace information to the sources that were used as input for the given derived resource.
Trace	getTraceToSource(SourceRelativeURI srcRelativeDerivedResource, IProjectConfig project) Returns the trace information to the sources that were used as input for the given derived resource.
Trace	getTraceToTarget(AbsoluteURI absoluteSourceResource, IProjectConfig project) Returns the trace information to the targets that were generated from the given source.
Trace	getTraceToTarget(PlatformResource sourceResource) Returns the trace information to the targets that were generated from the given source.
Trace	getTraceToTarget(SourceRelativeURI srcRelativeSourceResource, IProjectConfig project) Returns the trace information to the targets that were generated from the given source.

Method Detail

getTraceToSource

Trace getTraceToSource(PlatformResource derivedResource)

Returns the trace information to the sources that were used as input for the given derived resource. May return null if no such data is available for the given storage.

Parameters:

derivedResource - the resource whose source trace is requested. May not be null.

Returns:

the trace to the source or null.

getTraceToTarget

Trace getTraceToTarget(PlatformResource sourceResource)

Returns the trace information to the targets that were generated from the given source. May return null if no such data is available for the given storage.

Parameters:

sourceResource - the resource whose target trace is requested. May not be null.

Returns:

the trace to the generation targets or null.

getTraceToSource

Trace getTraceToSource(AbsoluteURI absoluteDerivedResource,
                     IProjectConfig project)

Description copied from interface: ITraceForURIProvider

Returns the trace information to the sources that were used as input for the given derived resource. May return null if no such data is available for the given storage.

Specified by:

getTraceToSource in interface ITraceForURIProvider

Parameters:

absoluteDerivedResource - the resource whose source trace is requested. May not be null.

project - the project that contains the derived resource. May not be null.

Returns:

the trace to the source or null.

getTraceToSource

Trace getTraceToSource(SourceRelativeURI srcRelativeDerivedResource,
                     IProjectConfig project)

Description copied from interface: ITraceForURIProvider

Returns the trace information to the sources that were used as input for the given derived resource. May return null if no such data is available for the given storage.

Specified by:

getTraceToSource in interface ITraceForURIProvider

Parameters:

srcRelativeDerivedResource - the resource whose source trace is requested. May not be null.

project - the project that contains the derived resource. May not be null.

Returns:

the trace to the source or null.

getTraceToTarget

Trace getTraceToTarget(AbsoluteURI absoluteSourceResource,
                     IProjectConfig project)

Description copied from interface: ITraceForURIProvider

Returns the trace information to the targets that were generated from the given source. May return null if no such data is available for the given storage.

Specified by:

getTraceToTarget in interface ITraceForURIProvider

Parameters:

absoluteSourceResource - the resource whose target trace is requested. May not be null.

project - the project that contains the derived resource. May not be null.

Returns:

the trace to the generation targets or null.

getTraceToTarget

Trace getTraceToTarget(SourceRelativeURI srcRelativeSourceResource,
                     IProjectConfig project)

Description copied from interface: ITraceForURIProvider

Returns the trace information to the targets that were generated from the given source. May return null if no such data is available for the given storage.

Specified by:

getTraceToTarget in interface ITraceForURIProvider

Parameters:

srcRelativeSourceResource - the resource whose target trace is requested. May not be null.

project - the project that contains the resource. May not be null.

Returns:

the trace to the generation targets or null.