org.eclipse.sphinx.emf.saving

Class SaveIndicatorUtil

java.lang.Object

org.eclipse.sphinx.emf.saving.SaveIndicatorUtil

public class SaveIndicatorUtil
extends java.lang.Object

A utility class providing convenience methods for determining and changing the save status of individual resources or entire models.

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getDirtyResources(org.eclipse.emf.edit.domain.EditingDomain editingDomain) Returns all resources in specified editing domain which are currently dirty.
static IModelSaveIndicator	getModelSaveIndicator(IModelDescriptor modelDescriptor) Returns an IModelSaveIndicator for the provided model.
static IResourceSaveIndicator	getResourceSaveIndicator(org.eclipse.emf.edit.domain.EditingDomain editingDomain) Returns an IResourceSaveIndicator for the provided editing domain.
static boolean	isDirty(org.eclipse.emf.edit.domain.EditingDomain editingDomain, org.eclipse.emf.ecore.resource.Resource resource) Determines if the specified resource in given editing domain is dirty.
static boolean	isDirty(IModelDescriptor modelDescriptor) Determines if the given model is dirty.
static boolean	isSaved(org.eclipse.emf.edit.domain.EditingDomain editingDomain, org.eclipse.emf.common.util.URI uri) Test if the resource behind given URI in specified editing domain has just been saved.
static void	setDirty(org.eclipse.emf.edit.domain.EditingDomain editingDomain, org.eclipse.emf.ecore.resource.Resource resource) Makes the specified resource in given editing domain dirty.
static void	setSaved(org.eclipse.emf.edit.domain.EditingDomain editingDomain, java.util.Collection<org.eclipse.emf.ecore.resource.Resource> resources) Clears dirty state of given collection of resources in specified editing domain and remembers them as having just been saved.
static void	setSaved(org.eclipse.emf.edit.domain.EditingDomain editingDomain, org.eclipse.emf.ecore.resource.Resource resource) Clears dirty state of given resource in specified editing domain and remembers it as having just been saved.
static void	setSaved(IModelDescriptor modelDescriptor) Clears dirty state of given model and remembers it as having just been saved.
static void	unsetDirty(org.eclipse.emf.edit.domain.EditingDomain editingDomain, org.eclipse.emf.ecore.resource.Resource resource) Makes the specified resource in given editing domain un-dirty.

Methods inherited from class java.lang.Object

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

Method Detail

getResourceSaveIndicator

public static IResourceSaveIndicator getResourceSaveIndicator(org.eclipse.emf.edit.domain.EditingDomain editingDomain)

Returns an IResourceSaveIndicator for the provided editing domain.

Parameters:

editingDomain - The editing domain for which the IResourceSaveIndicator is to be returned.

Returns:

An IResourceSaveIndicator for the given editing domain, or null if no such is available.

getModelSaveIndicator

public static IModelSaveIndicator getModelSaveIndicator(IModelDescriptor modelDescriptor)

Returns an IModelSaveIndicator for the provided model.

Parameters:

modelDescriptor - The model for which the IModelSaveIndicator is to be returned.

Returns:

An IModelSaveIndicator for the given model, or null if no such is available.

isDirty

public static boolean isDirty(org.eclipse.emf.edit.domain.EditingDomain editingDomain,
              org.eclipse.emf.ecore.resource.Resource resource)

Determines if the specified resource in given editing domain is dirty. A resource is considered dirty if its content has been modified but not been saved yet.

Parameters:

editingDomain - The editing domain the resource in question is in.

resource - The resource to be investigated.

Returns:

true if specified resource is present in given editing domain and is dirty, or false otherwise.

See Also:

setDirty(EditingDomain, Resource), getDirtyResources(EditingDomain), setSaved(EditingDomain, Resource)

isDirty

public static boolean isDirty(IModelDescriptor modelDescriptor)

Determines if the given model is dirty. A model is considered dirty if it has resources whose content has been modified but not been saved yet.

Parameters:

modelDescriptor - The model to be investigated.

Returns:

true if specified model has dirty resources, or false otherwise.

See Also:

setSaved(IModelDescriptor)

setDirty

public static void setDirty(org.eclipse.emf.edit.domain.EditingDomain editingDomain,
            org.eclipse.emf.ecore.resource.Resource resource)

Makes the specified resource in given editing domain dirty.

Parameters:

editingDomain - The editing domain the resource in question is in.

resource - The resource to be handled.

See Also:

isDirty(EditingDomain, Resource), unsetDirty(EditingDomain, Resource), getDirtyResources(EditingDomain)

unsetDirty

public static void unsetDirty(org.eclipse.emf.edit.domain.EditingDomain editingDomain,
              org.eclipse.emf.ecore.resource.Resource resource)

Makes the specified resource in given editing domain un-dirty.

Parameters:

editingDomain - The editing domain the resource in question is in.

resource - The resource to be handled.

See Also:

isDirty(EditingDomain, Resource), setDirty(EditingDomain, Resource), getDirtyResources(EditingDomain)

getDirtyResources

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getDirtyResources(org.eclipse.emf.edit.domain.EditingDomain editingDomain)

Returns all resources in specified editing domain which are currently dirty.

Parameters:

editingDomain - The editing domain the potentially resources are in.

Returns:

A collection with resources which are present in given editing domain and are currently dirty, or and empty collection if no dirty resources exist in given editing domain.

See Also:

isDirty(IModelDescriptor), setDirty(EditingDomain, Resource), setSaved(EditingDomain, Collection)

isSaved

public static boolean isSaved(org.eclipse.emf.edit.domain.EditingDomain editingDomain,
              org.eclipse.emf.common.util.URI uri)

Test if the resource behind given URI in specified editing domain has just been saved. This method typically needs to be called when an resource change event indicates that the content of the file behind given URI has changed. Based on the returned result the caller can determine if a resource change event is just a consequence of a preceding save operation or if the file's content has been changed otherwise (e.g., via a text editor or some other tool affecting the resource in its serialized form).

Parameters:

editingDomain - The editing domain the resource behind given URI is in.

uri - The URI of the resource to be investigated.

Returns:

true if given resource is present in given editing domain and has just been saved, or false otherwise.

See Also:

setSaved(EditingDomain, Resource), setSaved(EditingDomain, Collection)

setSaved

public static void setSaved(org.eclipse.emf.edit.domain.EditingDomain editingDomain,
            org.eclipse.emf.ecore.resource.Resource resource)

Clears dirty state of given resource in specified editing domain and remembers it as having just been saved. This method needs to be called by all clients which perform a save operation of some resource right after the save operation has been completed. It enables clients to determine if subsequently raised resource change events are just a consequence of the preceding save operation or if the underlying file's content has been changed otherwise (e.g., via a text editor or some other tool affecting the resource in its serialized form).

Parameters:

editingDomain - The editing domain the resource in question is in.

resource - The resource to be handled.

See Also:

isDirty(EditingDomain, Resource), isSaved(EditingDomain, URI), setSaved(EditingDomain, Collection)

setSaved

public static void setSaved(org.eclipse.emf.edit.domain.EditingDomain editingDomain,
            java.util.Collection<org.eclipse.emf.ecore.resource.Resource> resources)

Clears dirty state of given collection of resources in specified editing domain and remembers them as having just been saved. This method needs to be called by all clients which perform a save operation of some collection of resources right after the save operation has been completed. Clients can then call isSaved(EditingDomain, URI) to determine if subsequently raised resource change events are just a consequence of the preceding save operation or if the underlying files' content has been changed otherwise (e.g., via a text editor or some other tool affecting the resource in its serialized form).

Parameters:

editingDomain - The editing domain the resources in question are in.

resource - The collection of resources to be handled.

See Also:

isDirty(EditingDomain, Resource), isSaved(EditingDomain, URI), setSaved(EditingDomain, Resource)

setSaved

public static void setSaved(IModelDescriptor modelDescriptor)

Clears dirty state of given model and remembers it as having just been saved. This method needs to be called by all clients which perform a save operation of some model right after the save operation has been completed. Clients can then call isSaved(EditingDomain, URI) to determine if subsequently raised resource change events are just a consequence of the preceding save operation or if the underlying files' content has been changed otherwise (e.g., via a text editor or some other tool affecting the resource in its serialized form).

Parameters:

modelDescriptor - The model to be handled.

See Also:

isDirty(IModelDescriptor)