org.eclipse.sphinx.emf.workspace.saving

Class ModelSaveManager

java.lang.Object

org.eclipse.sphinx.emf.workspace.saving.ModelSaveManager

public class ModelSaveManager
extends java.lang.Object

The Workspace Model Save Manager.

Field Summary

Fields

Modifier and Type	Field and Description
static ModelSaveManager	INSTANCE The singleton instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addModelDirtyChangedListener(IModelSaveLifecycleListener listener) Deprecated. Use #addModelSaveLifecycleListener(IModelSaveLifecycleListener) instead.
void	addModelPreSaveListener(IModelSaveLifecycleListener listener) Deprecated. Use #addModelSaveLifecycleListener(IModelSaveLifecycleListener) instead.
void	addModelSaveLifecycleListener(IMetaModelDescriptor mmDescriptor, IModelSaveLifecycleListener listener) Adds the provided listener for model save lifecycle events related to given metamodel.
protected java.util.Set<IModelDescriptor>	getModelDescriptors(java.lang.Object source)
void	handleDirtyStateChanged(org.eclipse.emf.ecore.resource.Resource resource)
boolean	isDirty(org.eclipse.core.resources.IContainer container)
boolean	isDirty(org.eclipse.core.resources.IFile contextFile)
boolean	isDirty(IModelDescriptor modelDescriptor)
boolean	isDirty(org.eclipse.emf.ecore.resource.Resource contextResource)
protected void	notifyDirtyChanged(java.lang.Object source) Notifies listeners that given source object's dirty state has changed.
protected void	notifyPreSave(java.lang.Object source) Notifies listeners that given source object's should be pre-saved.
void	removeModelDirtyChangedListener(IModelSaveLifecycleListener listener) Deprecated. Use removeModelSaveLifecycleListener(IModelSaveLifecycleListener) instead.
void	removeModelPreSaveListener(IModelSaveLifecycleListener listener) Deprecated. Use removeModelSaveLifecycleListener(IModelSaveLifecycleListener) instead.
void	removeModelSaveLifecycleListener(IModelSaveLifecycleListener listener) Removes the given model save lifecycle listener.
void	saveModel(IModelDescriptor modelDescriptor, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor) Saves all modified resources of the model behind given model descriptor.
void	saveModel(IModelDescriptor modelDescriptor, java.util.Map<?,?> saveOptions, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor) Saves all modified resources of the model behind given model descriptor.
void	saveModel(org.eclipse.emf.ecore.resource.Resource contextResource, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor) Saves all modified resources of the model behind given resource (i.e. all resources in the context of the given one).
void	saveModel(org.eclipse.emf.ecore.resource.Resource contextResource, java.util.Map<?,?> saveOptions, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor)
void	saveProject(org.eclipse.core.resources.IProject project, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor) Saves all modified resources of all models behind given project.
void	saveProject(org.eclipse.core.resources.IProject project, java.util.Map<?,?> saveOptions, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor) Saves all modified resources of all models behind given project.
void	setDirty(org.eclipse.core.resources.IContainer container) Deprecated. Use setDirty(IFile) instead.
void	setDirty(org.eclipse.core.resources.IFile file) Deprecated. Use SaveIndicatorUtil.setDirty(org.eclipse.emf.edit.domain.EditingDomain, Resource) instead.
void	setDirty(org.eclipse.emf.ecore.resource.Resource resource) Deprecated. Use SaveIndicatorUtil.setDirty(org.eclipse.emf.edit.domain.EditingDomain, Resource) instead.
void	setSaved(org.eclipse.core.resources.IContainer container) Deprecated. Use SaveIndicatorUtil.setSaved(IModelDescriptor) instead.
void	setSaved(org.eclipse.core.resources.IFile file) Deprecated. Use SaveIndicatorUtil.setSaved(org.eclipse.emf.edit.domain.EditingDomain, Resource) instead.
void	setSaved(IModelDescriptor modelDescriptor) Deprecated. Use SaveIndicatorUtil.setSaved(IModelDescriptor) instead.
void	setSaved(org.eclipse.emf.ecore.resource.Resource resource) Deprecated. Use SaveIndicatorUtil.setSaved(org.eclipse.emf.edit.domain.EditingDomain, Resource) instead.
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static ModelSaveManager INSTANCE

The singleton instance.

Method Detail

start

public void start()

stop

public void stop()

handleDirtyStateChanged

public void handleDirtyStateChanged(org.eclipse.emf.ecore.resource.Resource resource)

addModelSaveLifecycleListener

public void addModelSaveLifecycleListener(IMetaModelDescriptor mmDescriptor,
                                 IModelSaveLifecycleListener listener)

Adds the provided listener for model save lifecycle events related to given metamodel. Has no effect if an identical listener is already registered.

Parameters:

listener - the model save lifecycle listener to be added.

removeModelSaveLifecycleListener

public void removeModelSaveLifecycleListener(IModelSaveLifecycleListener listener)

Removes the given model save lifecycle listener. Has no effect if the listener is not registered.

Parameters:

listener - the model save lifecycle listener to be removed.

addModelDirtyChangedListener

@Deprecated
public void addModelDirtyChangedListener(IModelSaveLifecycleListener listener)

Deprecated. Use #addModelSaveLifecycleListener(IModelSaveLifecycleListener) instead.

Adds a listener to this model save manager, which will be notified whenever the dirty state of one of its model changes.

Parameters:

listener - the listener to add.

removeModelDirtyChangedListener

@Deprecated
public void removeModelDirtyChangedListener(IModelSaveLifecycleListener listener)

Deprecated. Use removeModelSaveLifecycleListener(IModelSaveLifecycleListener) instead.

Removes a IModelDirtyChangeListener from this model save manager.

Parameters:

listener - the listener to remove.

addModelPreSaveListener

@Deprecated
public void addModelPreSaveListener(IModelSaveLifecycleListener listener)

Deprecated. Use #addModelSaveLifecycleListener(IModelSaveLifecycleListener) instead.

Adds a listener to this model save manager, which will be notified whenever the model is pre-saving.

Parameters:

listener - the listener to add.

removeModelPreSaveListener

@Deprecated
public void removeModelPreSaveListener(IModelSaveLifecycleListener listener)

Deprecated. Use removeModelSaveLifecycleListener(IModelSaveLifecycleListener) instead.

Removes a IModelSaveLifecycleListener from this model save manager.

Parameters:

listener - the listener to remove.

notifyDirtyChanged

protected void notifyDirtyChanged(java.lang.Object source)

Notifies listeners that given source object's dirty state has changed.

Parameters:

source - The source object whose dirty state has changed.

notifyPreSave

protected void notifyPreSave(java.lang.Object source)

Notifies listeners that given source object's should be pre-saved.

Parameters:

source - The source object to be saved.

getModelDescriptors

protected java.util.Set<IModelDescriptor> getModelDescriptors(java.lang.Object source)

isDirty

public boolean isDirty(org.eclipse.emf.ecore.resource.Resource contextResource)

Parameters:

contextResource - A resource of the model whose dirty state must be returned.

Returns:

The dirty state of the given resource.

isDirty

public boolean isDirty(org.eclipse.core.resources.IFile contextFile)

Parameters:

contextFile - The file whose dirty state must be returned.

Returns:

The dirty state of the given file.

isDirty

public boolean isDirty(org.eclipse.core.resources.IContainer container)

Parameters:

container - The container whose dirty state must be returned.

Returns:

The dirty state of the given container.

isDirty

public boolean isDirty(IModelDescriptor modelDescriptor)

Parameters:

modelDescriptor - The descriptor of the model whose dirty state must be returned.

Returns:

The dirty state of the given model.

setDirty

@Deprecated
public void setDirty(org.eclipse.emf.ecore.resource.Resource resource)

Deprecated. Use SaveIndicatorUtil.setDirty(org.eclipse.emf.edit.domain.EditingDomain, Resource) instead.

Marks the given resource as dirty.

Parameters:

resource - The resource to mark as dirty.

setDirty

@Deprecated
public void setDirty(org.eclipse.core.resources.IFile file)

Deprecated. Use SaveIndicatorUtil.setDirty(org.eclipse.emf.edit.domain.EditingDomain, Resource) instead.

Marks the given file as dirty.

Parameters:

file - The file to mark as dirty.

setDirty

@Deprecated
public void setDirty(org.eclipse.core.resources.IContainer container)

Deprecated. Use setDirty(IFile) instead.

Marks the given container as dirty.

Parameters:

container - The container to mark as dirty.

setSaved

@Deprecated
public void setSaved(org.eclipse.emf.ecore.resource.Resource resource)

Deprecated. Use SaveIndicatorUtil.setSaved(org.eclipse.emf.edit.domain.EditingDomain, Resource) instead.

Marks the given resource as saved.

Parameters:

resource - The resource to mark as saved.

setSaved

@Deprecated
public void setSaved(org.eclipse.core.resources.IFile file)

Deprecated. Use SaveIndicatorUtil.setSaved(org.eclipse.emf.edit.domain.EditingDomain, Resource) instead.

Marks the given file as saved.

Parameters:

file - The file to mark as saved.

setSaved

@Deprecated
public void setSaved(org.eclipse.core.resources.IContainer container)

Deprecated. Use SaveIndicatorUtil.setSaved(IModelDescriptor) instead.

Marks the models behind the given container as saved.

Parameters:

container - The container to mark as saved.

setSaved

@Deprecated
public void setSaved(IModelDescriptor modelDescriptor)

Deprecated. Use SaveIndicatorUtil.setSaved(IModelDescriptor) instead.

Marks the given model as saved.

Parameters:

modelDescriptor - The modelDescriptor to mark as saved.

saveModel

public void saveModel(org.eclipse.emf.ecore.resource.Resource contextResource,
             boolean async,
             org.eclipse.core.runtime.IProgressMonitor monitor)

Saves all modified resources of the model behind given resource (i.e. all resources in the context of the given one).

Parameters:

contextResource - The object resource identifying the model to save.

async - If true, model will be saved within a workspace job.

monitor - The progress monitor to use for showing save process progress.

saveModel

public void saveModel(org.eclipse.emf.ecore.resource.Resource contextResource,
             java.util.Map<?,?> saveOptions,
             boolean async,
             org.eclipse.core.runtime.IProgressMonitor monitor)

saveModel

public void saveModel(IModelDescriptor modelDescriptor,
             boolean async,
             org.eclipse.core.runtime.IProgressMonitor monitor)

Saves all modified resources of the model behind given model descriptor.

Parameters:

modelDescriptor - The descriptor of the model to save.

async - If true, model will be saved within a workspace job.

monitor - The progress monitor to use for showing save process progress.

saveModel

public void saveModel(IModelDescriptor modelDescriptor,
             java.util.Map<?,?> saveOptions,
             boolean async,
             org.eclipse.core.runtime.IProgressMonitor monitor)

Saves all modified resources of the model behind given model descriptor.

Parameters:

modelDescriptor - The descriptor of the model to save.

saveOptions - the save options to be used.

async - If true, model will be saved within a workspace job.

monitor - The progress monitor to use for showing save process progress.

saveProject

public void saveProject(org.eclipse.core.resources.IProject project,
               boolean async,
               org.eclipse.core.runtime.IProgressMonitor monitor)

Saves all modified resources of all models behind given project.

Parameters:

project - The project whose models are to be saved.

async - If true, models will be saved within a workspace job.

monitor - The progress monitor to use for showing save process progress.

Since:

0.7.0

saveProject

public void saveProject(org.eclipse.core.resources.IProject project,
               java.util.Map<?,?> saveOptions,
               boolean async,
               org.eclipse.core.runtime.IProgressMonitor monitor)

Saves all modified resources of all models behind given project.

Parameters:

project - The project whose models are to be saved.

saveOptions - the save options to be used.

async - If true, models will be saved within a workspace job.

monitor - The progress monitor to use for showing save process progress.

Since:

0.7.0