Package net.ssehub.easy.producer.eclipse.persistency.project_creation

Class AbstractProjectCreator

java.lang.Object

net.ssehub.easy.producer.eclipse.persistency.project_creation.AbstractProjectCreator

Direct Known Subclasses:

DerivedProjectCreator, NewProjectCreator

abstract class AbstractProjectCreator
extends java.lang.Object

Super class for creating new EASy projects.

Author:

El-Sharkawy

Field Summary

Fields

Modifier and Type	Field	Description
private IEASyProjectConfigurator[]	configurators	Configurators to configure the project during creation.
private boolean	lazy
private static EASyLoggerFactory.EASyLogger	LOGGER
private ProductLineProject	newPLP
private EclipsePersistencer	persistencer
private org.eclipse.core.resources.IProject	project
private java.lang.String	projectName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractProjectCreator(java.lang.String projectName, boolean lazy, IEASyProjectConfigurator... configurators)	Sole constructor for creating new EASy projects.

Method Summary

Modifier and Type	Method	Description
private void	configureProject()	Configures the newly created project.
protected abstract void	configureProject(org.eclipse.core.resources.IProject createdProject, IEASyProjectConfigurator configurator)	Configures the newly created Eclipse project.
(package private) abstract ProductLineProject	createEASyProject()	Creates the new ProductLineProject with the specified parameters.
private void	createNewEASyProject()	Create the project related information, i.e., the PLP instance, possibly including the containing project.
protected void	createProject()	Creates the (empty) ProductLineProject, which may needs further configuration.
protected ProductLineProject	getCreatedProject()	Returns the newly created ProductLineProject.
protected boolean	isLazyCreation()	Returns whether the project should be created lazy.
protected void	setPersistenceProperties()	Sets persistence properties for the newly created project and refreshes the workspace/models.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final EASyLoggerFactory.EASyLogger LOGGER

newPLP

private ProductLineProject newPLP

projectName

private java.lang.String projectName

persistencer

private EclipsePersistencer persistencer

project

private org.eclipse.core.resources.IProject project

lazy

private boolean lazy

configurators

private IEASyProjectConfigurator[] configurators

Configurators to configure the project during creation. Maybe null.

Constructor Detail

AbstractProjectCreator

protected AbstractProjectCreator(java.lang.String projectName,
                                 boolean lazy,
                                 IEASyProjectConfigurator... configurators)

Sole constructor for creating new EASy projects.

Parameters:

projectName - The name of the new project (should already be checked, whether the name is valid).

lazy - if true, create only required parts, else assume that project does not exist before

configurators - Optional list of configurators to configure the newly created project, maybe null. The configurators whill be applied in the ordering of the array.

Method Detail

getCreatedProject

protected final ProductLineProject getCreatedProject()

Returns the newly created ProductLineProject.

Returns:

The newly created ProductLineProject or null if this method was called before the creation was finished.

isLazyCreation

protected final boolean isLazyCreation()

Returns whether the project should be created lazy.

Returns:

true if only required parts should be created, else assume that project does not exist before

createProject

protected final void createProject()

Creates the (empty) ProductLineProject, which may needs further configuration. This is the first step while creating a derived or not derived project. This project will also be configured with the given IEASyProjectConfigurators.

configureProject

private void configureProject()

Configures the newly created project. For instance, this may include to change the project to a Java project. Part of the createProject() method.

configureProject

protected abstract void configureProject(org.eclipse.core.resources.IProject createdProject,
                                         IEASyProjectConfigurator configurator)

Configures the newly created Eclipse project.

Parameters:

createdProject - The newly created EASy (Eclipse) project.

configurator - The configurator to use for configuring the project.

createNewEASyProject

private void createNewEASyProject()

Create the project related information, i.e., the PLP instance, possibly including the containing project. This project needs further configuration. Part of the createProject() method.

setPersistenceProperties

protected final void setPersistenceProperties()

Sets persistence properties for the newly created project and refreshes the workspace/models.

createEASyProject

abstract ProductLineProject createEASyProject()

Creates the new ProductLineProject with the specified parameters.

Returns:

The newly created ProductLineProject.