org.eclipse.xtext.generator.trace

Interface ITraceForURIProvider

All Known Subinterfaces:

IPlatformSpecificTraceProvider<PlatformResource,Trace>

All Known Implementing Classes:

AbstractTraceForURIProvider, NoTraces

public interface ITraceForURIProvider

Provides read access to the available trace information for generated resources or input resources.

Since:

2.9

Noextend:

This interface is not intended to be extended by clients.

Noimplement:

This interface is not intended to be implemented by clients.

Method Summary

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

Method Detail

getTraceToSource

ITrace getTraceToSource(AbsoluteURI absoluteDerivedResource,
                        IProjectConfig context)

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:

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

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

Returns:

the trace to the source or null.

getTraceToSource

ITrace getTraceToSource(SourceRelativeURI srcRelativeDerivedResource,
                        IProjectConfig project)

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:

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

ITrace getTraceToTarget(AbsoluteURI absoluteSourceResource,
                        IProjectConfig context)

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:

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

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

Returns:

the trace to the generation targets or null.

getTraceToTarget

ITrace getTraceToTarget(SourceRelativeURI srcRelativeSourceResource,
                        IProjectConfig project)

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:

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.