org.eclipse.xtext.generator.trace.internal

Class AbstractTraceForURIProvider<SomeFile,Trace extends AbstractTrace>

java.lang.Object

org.eclipse.xtext.generator.trace.internal.AbstractTraceForURIProvider<SomeFile,Trace>

All Implemented Interfaces:

ITraceForURIProvider

public abstract class AbstractTraceForURIProvider<SomeFile,Trace extends AbstractTrace>
extends Object
implements ITraceForURIProvider

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractTraceForURIProvider.CachedTraces
protected static interface	AbstractTraceForURIProvider.PersistedTrace

Constructor Summary

Constructors

Constructor and Description
AbstractTraceForURIProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract SomeFile	asFile(AbsoluteURI absoluteURI, IProjectConfig project) Obtain the file representation from the given URI.
protected SomeFile	asFile(SourceRelativeURI srcRelativeDerivedResource, IProjectConfig project)
protected abstract List<AbstractTraceForURIProvider.PersistedTrace>	findInverseTraceFiles(SomeFile sourceFile) Find all the trace files that have been written for the given source file.
protected abstract AbstractTraceForURIProvider.PersistedTrace	findPersistedTrace(SomeFile generatedFile) Find the persisted trace information for the given generated file.
protected abstract AbsoluteURI	getAbsoluteLocation(SomeFile file) Returns the absolute location from the given file representation.
protected AbsoluteURI	getGeneratedLocation(AbstractTraceForURIProvider.PersistedTrace trace) Compute the location of the generated file from the given trace file.
protected SourceRelativeURI	getGeneratedUriForTrace(IProjectConfig projectConfig, AbsoluteURI absoluteSourceResource, AbsoluteURI generatedFileURI, ITraceURIConverter traceURIConverter)
protected abstract IProjectConfig	getProjectConfig(SomeFile sourceFile) Find the project configuration for the given generated file.
protected IResourceServiceProvider	getServiceProvider(AbsoluteURI absoluteSourceResource)
protected TraceFileNameProvider	getTraceFileNameProvider()
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(SomeFile generatedFile)
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(SomeFile sourceFile, AbsoluteURI absoluteSourceResource, IProjectConfig projectConfig)
Trace	getTraceToTarget(SourceRelativeURI srcRelativeSourceResource, IProjectConfig project) Returns the trace information to the targets that were generated from the given source.
protected abstract Trace	newAbstractTrace(SomeFile file) Instantiate a new instance of the trace and associate the locate information with the given file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractTraceForURIProvider

public AbstractTraceForURIProvider()

Method Detail

newAbstractTrace

protected abstract Trace newAbstractTrace(SomeFile file)

Instantiate a new instance of the trace and associate the locate information with the given file.

asFile

protected abstract SomeFile asFile(AbsoluteURI absoluteURI,
              IProjectConfig project)

Obtain the file representation from the given URI.

getAbsoluteLocation

protected abstract AbsoluteURI getAbsoluteLocation(SomeFile file)

Returns the absolute location from the given file representation.

asFile

protected SomeFile asFile(SourceRelativeURI srcRelativeDerivedResource,
              IProjectConfig project)

findInverseTraceFiles

protected abstract List<AbstractTraceForURIProvider.PersistedTrace> findInverseTraceFiles(SomeFile sourceFile)

Find all the trace files that have been written for the given source file.

findPersistedTrace

protected abstract AbstractTraceForURIProvider.PersistedTrace findPersistedTrace(SomeFile generatedFile)

Find the persisted trace information for the given generated file.

getProjectConfig

protected abstract IProjectConfig getProjectConfig(SomeFile sourceFile)

Find the project configuration for the given generated file.

getTraceToSource

public 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

public 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.

getTraceToSource

public Trace getTraceToSource(SomeFile generatedFile)

getTraceToTarget

public 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

public 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.

getTraceToTarget

public Trace getTraceToTarget(SomeFile sourceFile,
                     AbsoluteURI absoluteSourceResource,
                     IProjectConfig projectConfig)

getGeneratedUriForTrace

protected SourceRelativeURI getGeneratedUriForTrace(IProjectConfig projectConfig,
                                        AbsoluteURI absoluteSourceResource,
                                        AbsoluteURI generatedFileURI,
                                        ITraceURIConverter traceURIConverter)

getServiceProvider

protected IResourceServiceProvider getServiceProvider(AbsoluteURI absoluteSourceResource)

getGeneratedLocation

protected AbsoluteURI getGeneratedLocation(AbstractTraceForURIProvider.PersistedTrace trace)

Compute the location of the generated file from the given trace file.

getTraceFileNameProvider

protected TraceFileNameProvider getTraceFileNameProvider()