org.eclipse.sphinx.emf.workspace.jobs

Class CreateNewModelProjectJob<T extends IMetaModelDescriptor>

java.lang.Object

org.eclipse.core.runtime.PlatformObject

org.eclipse.core.internal.jobs.InternalJob

org.eclipse.core.runtime.jobs.Job

org.eclipse.core.internal.resources.InternalWorkspaceJob

org.eclipse.core.resources.WorkspaceJob

org.eclipse.sphinx.emf.workspace.jobs.CreateNewModelProjectJob<T>

All Implemented Interfaces:

java.lang.Comparable, org.eclipse.core.runtime.IAdaptable

public class CreateNewModelProjectJob<T extends IMetaModelDescriptor>
extends org.eclipse.core.resources.WorkspaceJob

A CreateNewModelProjectJob capable of creating a new model project with given nature. A new project is created, and the required nature is added to this project.

This job is set by default the priority to Job.BUILD and the rule to the workspace root.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.net.URI	location
protected T	metaModelVersionDescriptor
protected IProjectWorkspacePreference<T>	metaModelVersionPreference
protected java.lang.String	natureId
protected org.eclipse.core.resources.IProject	newProject
protected org.eclipse.core.resources.IProject	project Deprecated. Use newProject instead.

Fields inherited from class org.eclipse.core.runtime.jobs.Job

ASYNC_FINISH, BUILD, DECORATE, INTERACTIVE, LONG, NONE, RUNNING, SHORT, SLEEPING, WAITING

Fields inherited from class org.eclipse.core.internal.jobs.InternalJob

manager

Constructor Summary

Constructors

Constructor and Description
CreateNewModelProjectJob(java.lang.String jobName, org.eclipse.core.resources.IProject newProject) Creates a new instance of model project job
CreateNewModelProjectJob(java.lang.String jobName, org.eclipse.core.resources.IProject newProject, java.net.URI location, java.lang.String natureId) Creates a new instance of model project job with a required project nature id.
CreateNewModelProjectJob(java.lang.String jobName, org.eclipse.core.resources.IProject newProject, java.net.URI location, T metaModelVersionDescriptor, IProjectWorkspacePreference<T> metaModelVersionPreference) Creates a new instance of model project job.
CreateNewModelProjectJob(java.lang.String jobName, org.eclipse.core.resources.IProject newProject, java.net.URI location, T metaModelVersionDescriptor, java.lang.String natureId, IProjectWorkspacePreference<T> metaModelVersionPreference) Deprecated. Use CreateNewModelProjectJob(String, IProject, URI, IMetaModelDescriptor, IProjectWorkspacePreference) instead.
CreateNewModelProjectJob(java.lang.String jobName, java.lang.String natureId) Deprecated. Use CreateNewModelProjectJob(String, IProject, URI, String) instead.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addNatures(org.eclipse.core.runtime.IProgressMonitor monitor) Adds the required natures to the project created by this CreateNewModelFileJob.
protected void	createNewProject(org.eclipse.core.runtime.IProgressMonitor monitor) Creates the project on disk.
org.eclipse.core.resources.IProject[]	getReferencedProjects()
org.eclipse.core.runtime.IAdaptable	getUIInfoAdaptable()
org.eclipse.core.runtime.IStatus	runInWorkspace(org.eclipse.core.runtime.IProgressMonitor monitor)
void	setReferencedProjects(org.eclipse.core.resources.IProject[] referencedProjects) Sets the referenced project.
void	setUIInfoAdaptable(org.eclipse.core.runtime.IAdaptable uiInfo) Sets an adaptable to be used by IOperationHistory.execute(org.eclipse.core.commands.operations.IUndoableOperation, IProgressMonitor, IAdaptable) At a minimum the adaptable should be able to adapt to org.eclipse.swt.widgets.Shell. Having a shell, such an adaptable can be obtained by WorkspaceUndoUtil.getUIInfoAdapter(shell) If null, a default shell will be created to ask the user for confirmation.

Methods inherited from class org.eclipse.core.internal.resources.InternalWorkspaceJob

run

Methods inherited from class org.eclipse.core.runtime.jobs.Job

addJobChangeListener, belongsTo, cancel, canceling, create, done, getJobGroup, getJobManager, getName, getPriority, getProperty, getResult, getRule, getState, getThread, isBlocking, isSystem, isUser, join, join, removeJobChangeListener, schedule, schedule, setJobGroup, setName, setPriority, setProgressGroup, setProperty, setRule, setSystem, setThread, setUser, shouldRun, shouldSchedule, sleep, toString, wakeUp, wakeUp, yieldRule

Methods inherited from class org.eclipse.core.internal.jobs.InternalJob

compareTo

Methods inherited from class org.eclipse.core.runtime.PlatformObject

getAdapter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Field Detail

newProject

protected org.eclipse.core.resources.IProject newProject

location

protected java.net.URI location

natureId

protected java.lang.String natureId

metaModelVersionDescriptor

protected T extends IMetaModelDescriptor metaModelVersionDescriptor

metaModelVersionPreference

protected IProjectWorkspacePreference<T extends IMetaModelDescriptor> metaModelVersionPreference

project

@Deprecated
protected org.eclipse.core.resources.IProject project

Deprecated. Use newProject instead.

Constructor Detail

CreateNewModelProjectJob

public CreateNewModelProjectJob(java.lang.String jobName,
                        org.eclipse.core.resources.IProject newProject)

Creates a new instance of model project job

Parameters:

jobName - the name of the job, must not be null

newProject - the new project to be created, must not be null

CreateNewModelProjectJob

@Deprecated
public CreateNewModelProjectJob(java.lang.String jobName,
                                   java.lang.String natureId)

Deprecated. Use CreateNewModelProjectJob(String, IProject, URI, String) instead.

Creates a new instance of model project job with a required project nature id.

Parameters:

jobName - the name of the job, must not be null

natureId - the (principal) nature of the project to be created; when set to null no nature will be added

CreateNewModelProjectJob

public CreateNewModelProjectJob(java.lang.String jobName,
                        org.eclipse.core.resources.IProject newProject,
                        java.net.URI location,
                        java.lang.String natureId)

Creates a new instance of model project job with a required project nature id.

Parameters:

jobNname - the name of the job, must not be null

newProject - the new project to be created, must not be null

location - the location where the project will be created; when set to null the default location will be used

natureId - the (principal) nature of the project to be created; when set to null no nature will be added

CreateNewModelProjectJob

public CreateNewModelProjectJob(java.lang.String jobName,
                        org.eclipse.core.resources.IProject newProject,
                        java.net.URI location,
                        T metaModelVersionDescriptor,
                        IProjectWorkspacePreference<T> metaModelVersionPreference)

Creates a new instance of model project job.

Parameters:

jobName - the name of the job, must not be null

newProject - the new project to be created, must not be null

location - the location where the project will be created; when set to null the default location will be used

metaModelVersionDescriptor - the meta-model version that the project will be used for; when set to null no metamodel version will be configured

metaModelVersionPreference - the metamodel version preference of the project; when set to null no metamodel version will be configured

CreateNewModelProjectJob

@Deprecated
public CreateNewModelProjectJob(java.lang.String jobName,
                                   org.eclipse.core.resources.IProject newProject,
                                   java.net.URI location,
                                   T metaModelVersionDescriptor,
                                   java.lang.String natureId,
                                   IProjectWorkspacePreference<T> metaModelVersionPreference)

Deprecated. Use CreateNewModelProjectJob(String, IProject, URI, IMetaModelDescriptor, IProjectWorkspacePreference) instead.

Creates a new instance of model project job.

Parameters:

jobName - the name of the job, must not be null

newProject - the new project to be created, must not be null

location - the location where the project will be created; when set to null the default location will be used

metaModelVersionDescriptor - the meta-model version that this project will be used for; when set to null no metamodel version will be configured

natureId - the (principal) nature of the project to be created; when set to null no nature will be added

metaModelVersionPreference - the metamodel version preference of this project; when set to null no metamodel version will be configured

Method Detail

setUIInfoAdaptable

public void setUIInfoAdaptable(org.eclipse.core.runtime.IAdaptable uiInfo)

Sets an adaptable to be used by IOperationHistory.execute(org.eclipse.core.commands.operations.IUndoableOperation, IProgressMonitor, IAdaptable)
At a minimum the adaptable should be able to adapt to org.eclipse.swt.widgets.Shell.
Having a shell, such an adaptable can be obtained by WorkspaceUndoUtil.getUIInfoAdapter(shell)
If null, a default shell will be created to ask the user for confirmation.

Parameters:

uiInfo - the uiInfo adaptable to set

getUIInfoAdaptable

public org.eclipse.core.runtime.IAdaptable getUIInfoAdaptable()

Returns:

the uiInfoAdaptable

getReferencedProjects

public org.eclipse.core.resources.IProject[] getReferencedProjects()

Returns:

the referencedProjects

setReferencedProjects

public void setReferencedProjects(org.eclipse.core.resources.IProject[] referencedProjects)

Sets the referenced project. Can be null or an empty array.

Parameters:

referencedProjects - the referencedProjects to set

runInWorkspace

public org.eclipse.core.runtime.IStatus runInWorkspace(org.eclipse.core.runtime.IProgressMonitor monitor)
                                                throws org.eclipse.core.runtime.CoreException

Specified by:

runInWorkspace in class org.eclipse.core.resources.WorkspaceJob

Throws:

org.eclipse.core.runtime.CoreException

createNewProject

protected void createNewProject(org.eclipse.core.runtime.IProgressMonitor monitor)
                         throws org.eclipse.core.runtime.CoreException

Creates the project on disk.

Parameters:

monitor -

Throws:

org.eclipse.core.runtime.CoreException

addNatures

protected void addNatures(org.eclipse.core.runtime.IProgressMonitor monitor)
                   throws org.eclipse.core.runtime.CoreException

Adds the required natures to the project created by this CreateNewModelFileJob.

Parameters:

monitor -

Throws:

org.eclipse.core.runtime.CoreException