org.eclipse.xtext.generator.trace

Interface ILocationInResource

All Known Subinterfaces:

IPlatformSpecificLocation<PlatformResource>

All Known Implementing Classes:

AbstractLocationInResource, LocationInResource

public interface ILocationInResource

Describes the location in a given file or storage.

Since:

2.3

Author:

Sebastian Zarnekow - Initial contribution and API

Method Summary

Methods

Modifier and Type	Method and Description
AbsoluteURI	getAbsoluteResourceURI()
InputStream	getContents() Returns the contents of the resource.
LanguageInfo	getLanguage()
IProjectConfig	getProjectConfig()
SourceRelativeURI	getSrcRelativeResourceURI() Returns the URI of this resource relative to the classpath if applicable.
ITextRegionWithLineInformation	getTextRegion()

Method Detail

getLanguage

LanguageInfo getLanguage()

Returns:

the language that this resource belongs to. May be null.

getAbsoluteResourceURI

AbsoluteURI getAbsoluteResourceURI()

Returns:

the EMF resource URI for this location. May be null if the resource is not an EMF resource.

getSrcRelativeResourceURI

SourceRelativeURI getSrcRelativeResourceURI()

Returns the URI of this resource relative to the classpath if applicable. Otherwise the URI relative to the project root.

getContents

InputStream getContents()
                        throws IOException

Returns the contents of the resource. May be null.

Throws:

IOException

getProjectConfig

IProjectConfig getProjectConfig()

Returns:

the project configuration for this location. Never null.

getTextRegion

ITextRegionWithLineInformation getTextRegion()

Returns:

the range in the resource. May be null.