org.eclipse.xtext.ui.editor

Interface IDirtyResource

All Known Subinterfaces:

IDirtyResource.InitializationAware, IDirtyResource.NormalizedURISupportExtension

All Known Implementing Classes:

DocumentBasedDirtyResource

public interface IDirtyResource

Representation of a resource that is currently edited. The accessible values may represent a cached, intermediate state of the resource. They are not necessarily a live view on the underlying resource.

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IDirtyResource.ICurrentStateProvidingExtension An extension interface for IDirtyResource.
static interface	IDirtyResource.InitializationAware Allows to query the dirty resource for its initialization state.
static interface	IDirtyResource.NormalizedURISupportExtension An extension interface for IDirtyResource

Method Summary

Methods

Modifier and Type	Method and Description
String	getActualContents()
String	getContents()
IResourceDescription	getDescription()
org.eclipse.emf.common.util.URI	getURI()

Method Detail

getContents

String getContents()

Returns:

the content of the resource as text, never null. May be the content of a snapshot.

See Also:

IDirtyResource.InitializationAware.getContentsIfInitialized()

getActualContents

String getActualContents()

Returns:

the current content of the underlying document or resource as text, never null.

See Also:

IDirtyResource.InitializationAware.getActualContentsIfInitialized()

getDescription

IResourceDescription getDescription()

Returns:

the description of the resource, never null.

See Also:

IDirtyResource.InitializationAware.getDescriptionIfInitialized()

getURI

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

Returns:

the URI of the resource, never null.