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:

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(String projectName)
protected abstract org.eclipse.core.resources.IStorage	findStorage(SourceRelativeURI srcRelativeLocation, org.eclipse.core.resources.IProject project)
Iterable<? extends ILocationInEclipseResource>	getAllAssociatedLocations()
Iterable<? extends ILocationInEclipseResource>	getAllAssociatedLocations(AbsoluteURI uri)
Iterable<? extends ILocationInEclipseResource>	getAllAssociatedLocations(org.eclipse.core.resources.IStorage associatedStorage)
Iterable<? extends ILocationInEclipseResource>	getAllAssociatedLocations(ITextRegion localRegion)
Iterable<? extends ILocationInEclipseResource>	getAllAssociatedLocations(ITextRegion localRegion, AbsoluteURI uri)
Iterable<? extends ILocationInEclipseResource>	getAllAssociatedLocations(ITextRegion localRegion, org.eclipse.core.resources.IStorage associatedStorage)
ILocationInEclipseResource	getBestAssociatedLocation(ITextRegion region)
ILocationInEclipseResource	getBestAssociatedLocation(ITextRegion localRegion, AbsoluteURI uri)
ILocationInEclipseResource	getBestAssociatedLocation(ITextRegion region, org.eclipse.core.resources.IStorage associatedStorage)
protected InputStream	getContents(SourceRelativeURI uri)
protected abstract InputStream	getContents(SourceRelativeURI uri, org.eclipse.core.resources.IProject project)
protected Reader	getContentsAsText(SourceRelativeURI uri)
protected abstract Reader	getContentsAsText(SourceRelativeURI uri, org.eclipse.core.resources.IProject projectConfig)
protected Reader	getLocalContentsAsText()
protected abstract Reader	getLocalContentsAsText(org.eclipse.core.resources.IProject project)
abstract org.eclipse.core.resources.IProject	getLocalProject()
IProjectConfig	getLocalProjectConfig()
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(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 InputStream getContents(SourceRelativeURI uri)
                           throws IOException

Specified by:

getContents in class AbstractTrace

Throws:

IOException

getContents

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

Throws:

IOException

getContentsAsText

protected Reader getContentsAsText(SourceRelativeURI uri)
                            throws IOException

Specified by:

getContentsAsText in class AbstractTrace

Throws:

IOException

getContentsAsText

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

Throws:

IOException

getLocalContentsAsText

protected Reader getLocalContentsAsText()
                                 throws IOException

Specified by:

getLocalContentsAsText in class AbstractTrace

Throws:

IOException

getLocalContentsAsText

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

Throws:

IOException

getBestAssociatedLocation

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

Specified by:

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

getAllAssociatedLocations

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

Specified by:

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

getAllAssociatedLocations

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

Specified by:

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

getBestAssociatedLocation

public ILocationInEclipseResource getBestAssociatedLocation(ITextRegion region)

Specified by:

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

Specified by:

getBestAssociatedLocation in interface ITrace

Overrides:

getBestAssociatedLocation in class AbstractTrace

createLocationInResource

protected ILocationInEclipseResource createLocationInResource(ITextRegionWithLineInformation region,
                                                  SourceRelativeURI srcRelativePath)

Overrides:

createLocationInResource in class AbstractTrace

getAllAssociatedLocations

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

Specified by:

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

Specified by:

getAllAssociatedLocations in interface ITrace

Overrides:

getAllAssociatedLocations in class AbstractTrace

getBestAssociatedLocation

public ILocationInEclipseResource getBestAssociatedLocation(ITextRegion localRegion,
                                                   AbsoluteURI uri)

Specified by:

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

Specified by:

getBestAssociatedLocation in interface ITrace

Overrides:

getBestAssociatedLocation in class AbstractTrace

getAllAssociatedLocations

public Iterable<? extends ILocationInEclipseResource> getAllAssociatedLocations(ITextRegion localRegion,
                                                                       AbsoluteURI uri)

Specified by:

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

Specified by:

getAllAssociatedLocations in interface ITrace

Overrides:

getAllAssociatedLocations in class AbstractTrace

getAllAssociatedLocations

public Iterable<? extends ILocationInEclipseResource> getAllAssociatedLocations(AbsoluteURI uri)

Specified by:

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

Specified by:

getAllAssociatedLocations in interface ITrace

Overrides:

getAllAssociatedLocations in class AbstractTrace

getLocalProjectConfig

public IProjectConfig getLocalProjectConfig()

Specified by:

getLocalProjectConfig in interface ITrace

Specified by:

getLocalProjectConfig in class AbstractTrace

getLocalProject

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

getAllAssociatedLocations

public Iterable<? extends ILocationInEclipseResource> getAllAssociatedLocations()

Specified by:

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

Specified by:

getAllAssociatedLocations in interface ITrace

Overrides:

getAllAssociatedLocations in class AbstractTrace