org.eclipse.xtext.ui.wizard

Interface IProjectCreator

All Superinterfaces:

org.eclipse.jface.operation.IRunnableWithProgress

All Known Implementing Classes:

AbstractPluginProjectCreator, AbstractProjectCreator, Ecore2XtextProjectCreator, RelengProjectsCreator, XtextProjectCreator

public interface IProjectCreator
extends org.eclipse.jface.operation.IRunnableWithProgress

A project creator is used to create one or more projects.
First the corresponding IProjectInfo is set. After that the IRunnableWithProgress.run(org.eclipse.core.runtime.IProgressMonitor) method is called.
If the execution successes, the result returned by getResult() method
will be selected and opened.

Author:

Peter Friese - Initial contribution and API, Dennis Huebner - Javadoc

See Also:

XtextNewProjectWizard

Method Summary

Methods

Modifier and Type	Method and Description
org.eclipse.core.resources.IFile	getResult() Result is a file that will be opened after the the project creation was successfully completed.
void	setProjectInfo(IProjectInfo projectInfo) Sets project creator configuration object.

Methods inherited from interface org.eclipse.jface.operation.IRunnableWithProgress

run

Method Detail

setProjectInfo

void setProjectInfo(IProjectInfo projectInfo)

Sets project creator configuration object.
A IProjectInfo, normally created by XtextNewProjectWizard subclasses,
is a kind of data holder for values which were collected
from the corresponding Wizard pages.
This data should be used to create a proper project

See Also:

IProjectInfo

getResult

org.eclipse.core.resources.IFile getResult()

Result is a file that will be opened after the the project creation was successfully completed.

(Dennis: This method name is misleading. Should be fileToOpenOnFinish or something. Consider to deprecate it in 2.4)

Returns:

IFile that should be opened after the project creation was successfully done.