org.eclipse.xtext.ui.editor

Class DirtyStateManager

java.lang.Object

org.eclipse.xtext.resource.impl.AbstractResourceDescriptionChangeEventSource

org.eclipse.xtext.ui.editor.DirtyStateManager

All Implemented Interfaces:

IExternalContentSupport.IExternalContentProvider, IResourceDescription.Event.Source, ISelectable, IDirtyStateManager, IDirtyStateManagerExtension

public class DirtyStateManager
extends AbstractResourceDescriptionChangeEventSource
implements IDirtyStateManager, IDirtyStateManagerExtension

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

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

IDirtyStateManager.Event

Constructor Summary

Constructors

Constructor and Description
DirtyStateManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	announceDirtyStateChanged(IDirtyResource dirtyResource) Announce the dirty state of the given resource.
void	discardDirtyState(IDirtyResource dirtyResource) Mark the given dirty resource as unmanaged.
protected IDirtyResource	findDirtyResourcebyURIorNormalizedURI(org.eclipse.emf.common.util.URI uri)
IExternalContentSupport.IExternalContentProvider	getActualContentProvider()
String	getContent(org.eclipse.emf.common.util.URI uri)
IDirtyResource	getDirtyResource(org.eclipse.emf.common.util.URI uri)
IResourceDescription	getDirtyResourceDescription(org.eclipse.emf.common.util.URI uri)
List<org.eclipse.emf.common.util.URI>	getDirtyResourceURIs()
Iterable<IEObjectDescription>	getExportedObjects()
Iterable<IEObjectDescription>	getExportedObjects(org.eclipse.emf.ecore.EClass type, QualifiedName name, boolean ignoreCase)
Iterable<IEObjectDescription>	getExportedObjectsByObject(org.eclipse.emf.ecore.EObject object)
Iterable<IEObjectDescription>	getExportedObjectsByType(org.eclipse.emf.ecore.EClass type)
ResourceStorageLoadable	getResourceStorageLoadable(org.eclipse.emf.common.util.URI uri)
boolean	hasContent(org.eclipse.emf.common.util.URI uri)
boolean	isEmpty()
boolean	manageDirtyState(IDirtyResource dirtyResource) Initially try to manage the given resource and its dirty state.
protected void	notifyListeners(IDirtyResource dirtyResource, boolean managed)

Methods inherited from class org.eclipse.xtext.resource.impl.AbstractResourceDescriptionChangeEventSource

addListener, addListeners, notifyListeners, removeListener, removeListeners

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.xtext.resource.IResourceDescription.Event.Source

addListener, notifyListeners, removeListener

Constructor Detail

DirtyStateManager

public DirtyStateManager()

Method Detail

announceDirtyStateChanged

public void announceDirtyStateChanged(IDirtyResource dirtyResource)

Description copied from interface: IDirtyStateManager

Announce the dirty state of the given resource. Clients should decide on their own when to call this method. The dirty state manager will not refuse any announcement due to incorrect internal state of the resource. Listeners will be notified about the changed dirty state. It is up to the implementor to decide about the actual point in time. Implementations are free to collect various announcement before actually raising an event. Events may be fired in a different thread. If there is no managed resource in the state manager, the change will be refused and no change will be announced.

Specified by:

announceDirtyStateChanged in interface IDirtyStateManager

discardDirtyState

public void discardDirtyState(IDirtyResource dirtyResource)

Description copied from interface: IDirtyStateManager

Mark the given dirty resource as unmanaged. This method may be called even if manageDirtyState has not been called before. Another dirty resource with the same URI will not become unmanaged. A call to this method will raise an event.

Specified by:

discardDirtyState in interface IDirtyStateManager

See Also:

IDirtyStateManager.announceDirtyStateChanged(IDirtyResource)

notifyListeners

protected void notifyListeners(IDirtyResource dirtyResource,
                   boolean managed)

manageDirtyState

public boolean manageDirtyState(IDirtyResource dirtyResource)

Description copied from interface: IDirtyStateManager

Initially try to manage the given resource and its dirty state. True will be returned, if the resource with the given URI was not managed before. However clients are free to call IDirtyStateManager.announceDirtyStateChanged(IDirtyResource) even if false was returned. A call to IDirtyStateManager.manageDirtyState(IDirtyResource) does not raise any events.

Specified by:

manageDirtyState in interface IDirtyStateManager

Returns:

true if this resource is the first one that has been registered for its URI

getDirtyResource

public IDirtyResource getDirtyResource(org.eclipse.emf.common.util.URI uri)

getDirtyResourceDescription

public IResourceDescription getDirtyResourceDescription(org.eclipse.emf.common.util.URI uri)

Specified by:

getDirtyResourceDescription in interface IDirtyStateManager

getContent

public String getContent(org.eclipse.emf.common.util.URI uri)

Specified by:

getContent in interface IExternalContentSupport.IExternalContentProvider

getResourceStorageLoadable

public ResourceStorageLoadable getResourceStorageLoadable(org.eclipse.emf.common.util.URI uri)

Since:

2.8

findDirtyResourcebyURIorNormalizedURI

protected IDirtyResource findDirtyResourcebyURIorNormalizedURI(org.eclipse.emf.common.util.URI uri)

Since:

2.4

getActualContentProvider

public IExternalContentSupport.IExternalContentProvider getActualContentProvider()

Specified by:

getActualContentProvider in interface IExternalContentSupport.IExternalContentProvider

hasContent

public boolean hasContent(org.eclipse.emf.common.util.URI uri)

Specified by:

hasContent in interface IExternalContentSupport.IExternalContentProvider

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ISelectable

getExportedObjects

public Iterable<IEObjectDescription> getExportedObjects()

Specified by:

getExportedObjects in interface ISelectable

getExportedObjects

public Iterable<IEObjectDescription> getExportedObjects(org.eclipse.emf.ecore.EClass type,
                                               QualifiedName name,
                                               boolean ignoreCase)

Specified by:

getExportedObjects in interface ISelectable

getExportedObjectsByObject

public Iterable<IEObjectDescription> getExportedObjectsByObject(org.eclipse.emf.ecore.EObject object)

Specified by:

getExportedObjectsByObject in interface ISelectable

getExportedObjectsByType

public Iterable<IEObjectDescription> getExportedObjectsByType(org.eclipse.emf.ecore.EClass type)

Specified by:

getExportedObjectsByType in interface ISelectable

getDirtyResourceURIs

public List<org.eclipse.emf.common.util.URI> getDirtyResourceURIs()

Specified by:

getDirtyResourceURIs in interface IDirtyStateManagerExtension

Since:

2.7