org.eclipse.xtext.ui.generator.trace

Class AbstractEclipseTrace

java.lang.Object

org.eclipse.xtext.generator.trace.internal.AbstractTrace

org.eclipse.xtext.ui.generator.trace.AbstractEclipseTrace

All Implemented Interfaces:

IPlatformSpecificTrace<org.eclipse.core.resources.IStorage,ILocationInEclipseResource>, ITrace, IEclipseTrace

Direct Known Subclasses:

AbstractTraceWithoutStorage, StorageAwareTrace

public abstract class AbstractEclipseTrace
extends AbstractTrace
implements IEclipseTrace

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.xtext.generator.trace.internal.AbstractTrace

AbstractTrace.TraceAccess, AbstractTrace.TraceRegionsByURI

Constructor Summary

Constructors

Constructor and Description
AbstractEclipseTrace()

Method Summary

Methods

Modifier and Type	Method and Description
protected ILocationInEclipseResource	createLocationInResource(ITextRegionWithLineInformation region, SourceRelativeURI srcRelativePath)
protected org.eclipse.core.resources.IProject	findProject(java.lang.String projectName)
protected abstract org.eclipse.core.resources.IStorage	findStorage(SourceRelativeURI srcRelativeLocation, org.eclipse.core.resources.IProject project)
java.lang.Iterable<? extends ILocationInEclipseResource>	getAllAssociatedLocations() Returns all known associated locations.
java.lang.Iterable<? extends ILocationInEclipseResource>	getAllAssociatedLocations(AbsoluteURI uri) Returns all known locations that were produced from the associated resource in the given absoluteTargetResource.
java.lang.Iterable<? extends ILocationInEclipseResource>	getAllAssociatedLocations(org.eclipse.core.resources.IStorage associatedStorage) Returns all known locations that were produced from the associated resource in the given targetResource.
java.lang.Iterable<? extends ILocationInEclipseResource>	getAllAssociatedLocations(ITextRegion localRegion) Returns all associated locations that match the given region.
java.lang.Iterable<? extends ILocationInEclipseResource>	getAllAssociatedLocations(ITextRegion localRegion, AbsoluteURI uri) Returns all individual locations that match the given localRegion for the expected absoluteTargetResource.
java.lang.Iterable<? extends ILocationInEclipseResource>	getAllAssociatedLocations(ITextRegion localRegion, org.eclipse.core.resources.IStorage associatedStorage) Returns all individual locations that match the given sourceRegion for the expected targetResource.
ILocationInEclipseResource	getBestAssociatedLocation(ITextRegion region) Returns the best associated location that matches the given region.
ILocationInEclipseResource	getBestAssociatedLocation(ITextRegion localRegion, AbsoluteURI uri) Returns the best location that matches the given localRegion in the absoluteTargetResource.
ILocationInEclipseResource	getBestAssociatedLocation(ITextRegion region, org.eclipse.core.resources.IStorage associatedStorage) Returns the best location that matches the given sourceRegion in the targetResource.
protected java.io.InputStream	getContents(SourceRelativeURI uri)
protected abstract java.io.InputStream	getContents(SourceRelativeURI uri, org.eclipse.core.resources.IProject project)
protected java.io.Reader	getContentsAsText(SourceRelativeURI uri)
protected abstract java.io.Reader	getContentsAsText(SourceRelativeURI uri, org.eclipse.core.resources.IProject projectConfig)
protected java.io.Reader	getLocalContentsAsText()
protected abstract java.io.Reader	getLocalContentsAsText(org.eclipse.core.resources.IProject project)
abstract org.eclipse.core.resources.IProject	getLocalProject()
IProjectConfig	getLocalProjectConfig() Returns the local project.
protected IStorage2UriMapper	getStorage2uriMapper()
protected AbsoluteURI	getURIForStorage(org.eclipse.core.resources.IStorage storage)
protected org.eclipse.core.resources.IWorkspace	getWorkspace()

Methods inherited from class org.eclipse.xtext.generator.trace.internal.AbstractTrace

createLocationInResourceFor, doGetRootTraceRegion, encloses, encloses, findLanguage, findParentByURI, findTraceRegionAt, findTraceRegionAtLeftOffset, findTraceRegionAtRightOffset, getAllTraceRegions, getAllTraceRegions, getLocalLanguage, getLocalURI, getMergedLocationInResource, getRootTraceRegion, getService, getSrcRelativeLocalURI, getTraceRegionProvider, hasTraceData, isAssociatedWith, isTraceToSource, isTraceToTarget, mergeRegions, resolvePath, setTraceRegionProvider, setTraceToSource, toLocations, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.xtext.generator.trace.internal.IPlatformSpecificTrace

getLocalStorage

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

getLocalLanguage, getLocalURI, getSrcRelativeLocalURI, hasTraceData

Constructor Detail

AbstractEclipseTrace

public AbstractEclipseTrace()

Method Detail

findProject

protected org.eclipse.core.resources.IProject findProject(java.lang.String projectName)

getWorkspace

protected org.eclipse.core.resources.IWorkspace getWorkspace()

getStorage2uriMapper

protected IStorage2UriMapper getStorage2uriMapper()

getURIForStorage

protected AbsoluteURI getURIForStorage(org.eclipse.core.resources.IStorage storage)

findStorage

protected abstract org.eclipse.core.resources.IStorage findStorage(SourceRelativeURI srcRelativeLocation,
                                              org.eclipse.core.resources.IProject project)

getContents

protected java.io.InputStream getContents(SourceRelativeURI uri)
                                   throws java.io.IOException

Specified by:

getContents in class AbstractTrace

Throws:

java.io.IOException

getContents

protected abstract java.io.InputStream getContents(SourceRelativeURI uri,
                              org.eclipse.core.resources.IProject project)
                                            throws java.io.IOException

Throws:

java.io.IOException

getContentsAsText

protected java.io.Reader getContentsAsText(SourceRelativeURI uri)
                                    throws java.io.IOException

Specified by:

getContentsAsText in class AbstractTrace

Throws:

java.io.IOException

getContentsAsText

protected abstract java.io.Reader getContentsAsText(SourceRelativeURI uri,
                               org.eclipse.core.resources.IProject projectConfig)
                                             throws java.io.IOException

Throws:

java.io.IOException

getLocalContentsAsText

protected java.io.Reader getLocalContentsAsText()
                                         throws java.io.IOException

Specified by:

getLocalContentsAsText in class AbstractTrace

Throws:

java.io.IOException

getLocalContentsAsText

protected abstract java.io.Reader getLocalContentsAsText(org.eclipse.core.resources.IProject project)
                                                  throws java.io.IOException

Throws:

java.io.IOException

getBestAssociatedLocation

public ILocationInEclipseResource getBestAssociatedLocation(ITextRegion region,
                                                   org.eclipse.core.resources.IStorage associatedStorage)

Description copied from interface: IPlatformSpecificTrace

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.

Specified by:

getBestAssociatedLocation in interface IPlatformSpecificTrace<org.eclipse.core.resources.IStorage,ILocationInEclipseResource>

Parameters:

region - 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

public java.lang.Iterable<? extends ILocationInEclipseResource> getAllAssociatedLocations(ITextRegion localRegion,
                                                                                 org.eclipse.core.resources.IStorage associatedStorage)

Description copied from interface: IPlatformSpecificTrace

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

Specified by:

getAllAssociatedLocations in interface IPlatformSpecificTrace<org.eclipse.core.resources.IStorage,ILocationInEclipseResource>

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

public java.lang.Iterable<? extends ILocationInEclipseResource> getAllAssociatedLocations(org.eclipse.core.resources.IStorage associatedStorage)

Description copied from interface: IPlatformSpecificTrace

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

Specified by:

getAllAssociatedLocations in interface IPlatformSpecificTrace<org.eclipse.core.resources.IStorage,ILocationInEclipseResource>

Parameters:

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

Returns:

all locations. Never null.

getBestAssociatedLocation

public ILocationInEclipseResource getBestAssociatedLocation(ITextRegion region)

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 IPlatformSpecificTrace<org.eclipse.core.resources.IStorage,ILocationInEclipseResource>

Specified by:

getBestAssociatedLocation in interface ITrace

Overrides:

getBestAssociatedLocation in class AbstractTrace

Parameters:

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

Returns:

the best associated location or null if none.

createLocationInResource

protected ILocationInEclipseResource createLocationInResource(ITextRegionWithLineInformation region,
                                                  SourceRelativeURI srcRelativePath)

Overrides:

createLocationInResource in class AbstractTrace

getAllAssociatedLocations

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

Description copied from interface: ITrace

Returns all associated locations that match the given region.

Specified by:

getAllAssociatedLocations in interface IPlatformSpecificTrace<org.eclipse.core.resources.IStorage,ILocationInEclipseResource>

Specified by:

getAllAssociatedLocations in interface ITrace

Overrides:

getAllAssociatedLocations in class AbstractTrace

Parameters:

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

Returns:

all associated locations. Never null.

getBestAssociatedLocation

public ILocationInEclipseResource 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 IPlatformSpecificTrace<org.eclipse.core.resources.IStorage,ILocationInEclipseResource>

Specified by:

getBestAssociatedLocation in interface ITrace

Overrides:

getBestAssociatedLocation in class AbstractTrace

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

public java.lang.Iterable<? extends ILocationInEclipseResource> 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 IPlatformSpecificTrace<org.eclipse.core.resources.IStorage,ILocationInEclipseResource>

Specified by:

getAllAssociatedLocations in interface ITrace

Overrides:

getAllAssociatedLocations in class AbstractTrace

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

public java.lang.Iterable<? extends ILocationInEclipseResource> 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 IPlatformSpecificTrace<org.eclipse.core.resources.IStorage,ILocationInEclipseResource>

Specified by:

getAllAssociatedLocations in interface ITrace

Overrides:

getAllAssociatedLocations in class AbstractTrace

Parameters:

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

Returns:

all locations. Never null.

getLocalProjectConfig

public IProjectConfig getLocalProjectConfig()

Description copied from interface: ITrace

Returns the local project. Never null.

Specified by:

getLocalProjectConfig in interface ITrace

Specified by:

getLocalProjectConfig in class AbstractTrace

Returns:

the local project. Never null.

getLocalProject

public abstract org.eclipse.core.resources.IProject getLocalProject()

getAllAssociatedLocations

public java.lang.Iterable<? extends ILocationInEclipseResource> getAllAssociatedLocations()

Description copied from interface: ITrace

Returns all known associated locations.

Specified by:

getAllAssociatedLocations in interface IPlatformSpecificTrace<org.eclipse.core.resources.IStorage,ILocationInEclipseResource>

Specified by:

getAllAssociatedLocations in interface ITrace

Overrides:

getAllAssociatedLocations in class AbstractTrace

Returns:

all associated locations. Never null.