org.eclipse.xtext.resource

Interface IResourceDescription

All Superinterfaces:

ISelectable

All Known Implementing Classes:

AbstractResourceDescription, CopiedResourceDescription, DefaultResourceDescription, DirtyStateResourceDescription, Indexer.ResolvedResourceDescription, LayeredTypeResourceDescription, ResourceDescriptionImpl, SerializableResourceDescription, StatefulResourceDescription, TypeResourceDescription, TypeResourceDescription, URIBasedTestResourceDescription

public interface IResourceDescription
extends ISelectable

A representation of a resource's contents as an ISelectable. The exported objects of a Resource describe its public interface. A description holds information about the imported names which can be used to compute the transitive closure when a resource is modified. Information about the actually established cross references is available, too.

Author:

Sebastian Zarnekow - Initial contribution and API, Sven Efftinge, Jan Koehnlein

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IResourceDescription.CoarseGrainedEvent This event is used to indicate that there were changes but it was not possible to determine what kind of changes had been done.
static interface	IResourceDescription.Delta A delta describing the differences between two versions of the same IResourceDescription.
static interface	IResourceDescription.Event
static interface	IResourceDescription.Manager

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Iterable<IEObjectDescription>	getExportedObjects()
java.lang.Iterable<QualifiedName>	getImportedNames()
java.lang.Iterable<IReferenceDescription>	getReferenceDescriptions()
org.eclipse.emf.common.util.URI	getURI()

Methods inherited from interface org.eclipse.xtext.resource.ISelectable

getExportedObjects, getExportedObjectsByObject, getExportedObjectsByType, isEmpty

Method Detail

getExportedObjects

java.lang.Iterable<IEObjectDescription> getExportedObjects()

Specified by:

getExportedObjects in interface ISelectable

Returns:

descriptions of all EObjects provided by the given Resource. The result is expected to return any combination of name and eObjectOrProxy only once as an IEObjectDescription. The order of the exported objects matters.

getImportedNames

java.lang.Iterable<QualifiedName> getImportedNames()

Returns:

the list of names the described resource depends depends on.

getReferenceDescriptions

java.lang.Iterable<IReferenceDescription> getReferenceDescriptions()

Returns:

the list of all references contained in the underlying resource.

getURI

org.eclipse.emf.common.util.URI getURI()

Returns:

the uri of the described resource. Will not return null.