org.eclipse.xtext.generator.trace
Interface ITraceInformation

All Known Implementing Classes:

FileBasedTraceInformation, ITraceInformation.Null

@NonNullByDefault
public interface ITraceInformation

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

Since:

2.3

Author:

Sebastian Zarnekow - Initial contribution and API

This interface is not intended to be implemented by clients.

This interface is not intended to be implemented by clients.

This class is not intended to be subclassed by clients.

This interface is not intended to be extended by clients.

Nested Class Summary

static class

ITraceInformation.Null

Method Summary

ITrace	getTraceToSource(org.eclipse.core.resources.IStorage derivedResource) Returns the trace information to the sources that were used as input for the given derived resource.
ITrace	getTraceToTarget(org.eclipse.core.resources.IStorage sourceResource) Returns the trace information to the targets that were generated from the given source.

Method Detail

getTraceToSource

@Nullable
ITrace getTraceToSource(org.eclipse.core.resources.IStorage 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

@Nullable
ITrace getTraceToTarget(org.eclipse.core.resources.IStorage 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.