org.eclipse.xtext.ui.editor

Class DocumentBasedDirtyResource

java.lang.Object

org.eclipse.xtext.ui.editor.DocumentBasedDirtyResource

All Implemented Interfaces:

javax.inject.Provider<IResourceDescription>, IDirtyResource, IDirtyResource.ICurrentStateProvidingExtension, IDirtyResource.InitializationAware, IDirtyResource.NormalizedURISupportExtension

public class DocumentBasedDirtyResource
extends Object
implements IDirtyResource.NormalizedURISupportExtension, IDirtyResource.ICurrentStateProvidingExtension, com.google.inject.Provider<IResourceDescription>, IDirtyResource.InitializationAware

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.xtext.ui.editor.IDirtyResource

IDirtyResource.ICurrentStateProvidingExtension, IDirtyResource.InitializationAware, IDirtyResource.NormalizedURISupportExtension

Constructor Summary

Constructors

Constructor and Description
DocumentBasedDirtyResource()

Method Summary

Methods

Modifier and Type	Method and Description
void	connect(IXtextDocument document)
void	copyState(IResourceDescription original)
void	disconnect(IXtextDocument document)
IResourceDescription	get() Callback method for the copied resource description.
String	getActualContents()
String	getActualContentsIfInitialized() Returns the current content of the underlying document or resource as text.
String	getContents()
String	getContentsIfInitialized() Returns the content of the resource as text.
IResourceDescription	getDescription()
IResourceDescription	getDescriptionIfInitialized()
org.eclipse.emf.common.util.URI	getNormalizedURI()
ResourceStorageLoadable	getResourceStorageLoadable()
IXtextDocument	getUnderlyingDocument()
org.eclipse.emf.common.util.URI	getURI()
protected void	initiallyProcessResource(XtextResource resource)
boolean	isInitialized() Returns true if the resource is initialized.
void	setResourceStorageLoadableProvider(com.google.inject.Provider<ResourceStorageLoadable> provider)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentBasedDirtyResource

public DocumentBasedDirtyResource()

Method Detail

connect

public void connect(IXtextDocument document)

initiallyProcessResource

protected void initiallyProcessResource(XtextResource resource)

disconnect

public void disconnect(IXtextDocument document)

get

public IResourceDescription get()

Callback method for the copied resource description. Is triggered as soon as somebody is interested in the reference descriptions which shall be up to date all the time. This allows for lazy resolution of proxies instead of eager copying.

Specified by:

get in interface javax.inject.Provider<IResourceDescription>

Returns:

the current resource description of the associated document. May be null.

copyState

public void copyState(IResourceDescription original)

getUnderlyingDocument

public IXtextDocument getUnderlyingDocument()

getDescriptionIfInitialized

public IResourceDescription getDescriptionIfInitialized()

Specified by:

getDescriptionIfInitialized in interface IDirtyResource.InitializationAware

Returns:

the description of the resource or null, if the resource is not yet initialized.

Since:

2.8

See Also:

IDirtyResource.getDescription()

isInitialized

public boolean isInitialized()

Description copied from interface: IDirtyResource.InitializationAware

Returns true if the resource is initialized.

Specified by:

isInitialized in interface IDirtyResource.InitializationAware

getURI

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

Specified by:

getURI in interface IDirtyResource

Returns:

the URI of the resource, never null.

getDescription

public IResourceDescription getDescription()

Specified by:

getDescription in interface IDirtyResource

Returns:

the description of the resource, never null.

See Also:

IDirtyResource.InitializationAware.getDescriptionIfInitialized()

getContents

public String getContents()

Specified by:

getContents in interface IDirtyResource

Returns:

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

See Also:

IDirtyResource.InitializationAware.getContentsIfInitialized()

getContentsIfInitialized

public String getContentsIfInitialized()

Description copied from interface: IDirtyResource.InitializationAware

Returns the content of the resource as text. If the dirty description is not yet initialized, returns null.

Specified by:

getContentsIfInitialized in interface IDirtyResource.InitializationAware

Since:

2.8

See Also:

IDirtyResource.getContents()

getActualContents

public String getActualContents()

Specified by:

getActualContents in interface IDirtyResource

Returns:

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

See Also:

IDirtyResource.InitializationAware.getActualContentsIfInitialized()

getActualContentsIfInitialized

public String getActualContentsIfInitialized()

Description copied from interface: IDirtyResource.InitializationAware

Returns the current content of the underlying document or resource as text. If the dirty description is not yet initialized, returns null.

Specified by:

getActualContentsIfInitialized in interface IDirtyResource.InitializationAware

Since:

2.8

See Also:

IDirtyResource.getActualContents()

getNormalizedURI

public org.eclipse.emf.common.util.URI getNormalizedURI()

Specified by:

getNormalizedURI in interface IDirtyResource.NormalizedURISupportExtension

Returns:

the normalized URI of the resource, never null.

Since:

2.4

getResourceStorageLoadable

public ResourceStorageLoadable getResourceStorageLoadable()

Specified by:

getResourceStorageLoadable in interface IDirtyResource.ICurrentStateProvidingExtension

Since:

2.8

setResourceStorageLoadableProvider

public void setResourceStorageLoadableProvider(com.google.inject.Provider<ResourceStorageLoadable> provider)

Since:

2.8