org.eclipse.m2e.core.internal.project

Class ProjectConfigurationManager

java.lang.Object

org.eclipse.m2e.core.internal.project.ProjectConfigurationManager

All Implemented Interfaces:

EventListener, org.eclipse.core.resources.IResourceChangeListener, IMavenProjectChangedListener, IProjectConfigurationManager

public class ProjectConfigurationManager
extends Object
implements IProjectConfigurationManager, IMavenProjectChangedListener, org.eclipse.core.resources.IResourceChangeListener

import Maven projects update project configuration from Maven enable Maven nature create new project

Author:

igor

Constructor Summary

Constructors

Constructor and Description
ProjectConfigurationManager(IMaven maven, ProjectRegistryManager projectManager, MavenModelManager mavenModelManager, IMavenMarkerManager mavenMarkerManager, IMavenConfiguration mavenConfiguration)

Method Summary

Modifier and Type	Method and Description
boolean	addMavenBuilder(org.eclipse.core.resources.IProject project, org.eclipse.core.resources.IProjectDescription description, org.eclipse.core.runtime.IProgressMonitor monitor) Adds the maven builder to the specified project.
Set<MavenProjectInfo>	collectProjects(Collection<MavenProjectInfo> projects)
void	createArchetypeProject(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IPath location, org.apache.maven.archetype.catalog.Archetype archetype, String groupId, String artifactId, String version, String javaPackage, Properties properties, ProjectImportConfiguration configuration, org.eclipse.core.runtime.IProgressMonitor monitor) Deprecated. use createArchetypeProjects(IPath, Archetype, String, String, String, String, Properties, ProjectImportConfiguration, IProgressMonitor)
List<org.eclipse.core.resources.IProject>	createArchetypeProjects(org.eclipse.core.runtime.IPath location, org.apache.maven.archetype.catalog.Archetype archetype, String groupId, String artifactId, String version, String javaPackage, Properties properties, ProjectImportConfiguration configuration, org.eclipse.core.runtime.IProgressMonitor monitor) Creates project structure using Archetype and then imports created project(s)
List<org.eclipse.core.resources.IProject>	createArchetypeProjects(org.eclipse.core.runtime.IPath location, org.apache.maven.archetype.catalog.Archetype archetype, String groupId, String artifactId, String version, String javaPackage, Properties properties, ProjectImportConfiguration configuration, IProjectCreationListener listener, org.eclipse.core.runtime.IProgressMonitor monitor) Creates project structure using Archetype and then imports created project(s)
static void	createFolder(org.eclipse.core.resources.IFolder folder, boolean derived) Helper method which creates a folder and, recursively, all its parent folders.
void	createSimpleProject(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IPath location, org.apache.maven.model.Model model, String[] directories, ProjectImportConfiguration configuration, org.eclipse.core.runtime.IProgressMonitor monitor)
void	createSimpleProject(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IPath location, org.apache.maven.model.Model model, String[] directories, ProjectImportConfiguration configuration, IProjectCreationListener listener, org.eclipse.core.runtime.IProgressMonitor monitor) Creates simple Maven project
void	disableMavenNature(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IProgressMonitor monitor)
void	enableMavenNature(org.eclipse.core.resources.IProject project, ResolverConfiguration configuration, org.eclipse.core.runtime.IProgressMonitor monitor)
ILifecycleMapping	getLifecycleMapping(IMavenProjectFacade projectFacade)
ResolverConfiguration	getResolverConfiguration(org.eclipse.core.resources.IProject project) PROVISIONAL
org.eclipse.core.runtime.jobs.ISchedulingRule	getRule()
List<IMavenProjectImportResult>	importProjects(Collection<MavenProjectInfo> projectInfos, ProjectImportConfiguration configuration, org.eclipse.core.runtime.IProgressMonitor monitor)
List<IMavenProjectImportResult>	importProjects(Collection<MavenProjectInfo> projectInfos, ProjectImportConfiguration configuration, IProjectCreationListener listener, org.eclipse.core.runtime.IProgressMonitor monitor)
void	mavenProjectChanged(MavenProjectChangedEvent[] events, org.eclipse.core.runtime.IProgressMonitor monitor) This method is called while holding workspace lock.
boolean	removeMavenBuilder(org.eclipse.core.resources.IProject project, org.eclipse.core.resources.IProjectDescription description, org.eclipse.core.runtime.IProgressMonitor monitor) Removes the maven builder from the specified project.
void	resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event)
boolean	setResolverConfiguration(org.eclipse.core.resources.IProject project, ResolverConfiguration configuration) PROVISIONAL
void	sortProjects(List<IMavenProjectFacade> facades, org.eclipse.core.runtime.IProgressMonitor monitor)
void	updateProjectConfiguration(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IProgressMonitor monitor)
Map<String,org.eclipse.core.runtime.IStatus>	updateProjectConfiguration(MavenUpdateRequest request, boolean updateConfiguration, boolean cleanProjects, boolean refreshFromLocal, org.eclipse.core.runtime.IProgressMonitor monitor) Returns project name to update status map.
Map<String,org.eclipse.core.runtime.IStatus>	updateProjectConfiguration(MavenUpdateRequest request, boolean updateConfiguration, boolean cleanProjects, org.eclipse.core.runtime.IProgressMonitor monitor) Returns project name to update status map.
void	updateProjectConfiguration(MavenUpdateRequest request, org.eclipse.core.runtime.IProgressMonitor monitor)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectConfigurationManager

public ProjectConfigurationManager(IMaven maven,
                                   ProjectRegistryManager projectManager,
                                   MavenModelManager mavenModelManager,
                                   IMavenMarkerManager mavenMarkerManager,
                                   IMavenConfiguration mavenConfiguration)

Method Detail

importProjects

public List<IMavenProjectImportResult> importProjects(Collection<MavenProjectInfo> projectInfos,
                                                      ProjectImportConfiguration configuration,
                                                      org.eclipse.core.runtime.IProgressMonitor monitor)
                                               throws org.eclipse.core.runtime.CoreException

Specified by:

importProjects in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

importProjects

public List<IMavenProjectImportResult> importProjects(Collection<MavenProjectInfo> projectInfos,
                                                      ProjectImportConfiguration configuration,
                                                      IProjectCreationListener listener,
                                                      org.eclipse.core.runtime.IProgressMonitor monitor)
                                               throws org.eclipse.core.runtime.CoreException

Specified by:

importProjects in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

sortProjects

public void sortProjects(List<IMavenProjectFacade> facades,
                         org.eclipse.core.runtime.IProgressMonitor monitor)
                  throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

updateProjectConfiguration

public void updateProjectConfiguration(org.eclipse.core.resources.IProject project,
                                       org.eclipse.core.runtime.IProgressMonitor monitor)
                                throws org.eclipse.core.runtime.CoreException

Specified by:

updateProjectConfiguration in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

updateProjectConfiguration

public void updateProjectConfiguration(MavenUpdateRequest request,
                                       org.eclipse.core.runtime.IProgressMonitor monitor)
                                throws org.eclipse.core.runtime.CoreException

Specified by:

updateProjectConfiguration in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

updateProjectConfiguration

public Map<String,org.eclipse.core.runtime.IStatus> updateProjectConfiguration(MavenUpdateRequest request,
                                                                               boolean updateConfiguration,
                                                                               boolean cleanProjects,
                                                                               org.eclipse.core.runtime.IProgressMonitor monitor)

Returns project name to update status map.

TODO promote to API

Since:

1.1

updateProjectConfiguration

public Map<String,org.eclipse.core.runtime.IStatus> updateProjectConfiguration(MavenUpdateRequest request,
                                                                               boolean updateConfiguration,
                                                                               boolean cleanProjects,
                                                                               boolean refreshFromLocal,
                                                                               org.eclipse.core.runtime.IProgressMonitor monitor)

Returns project name to update status map.

TODO promote to API. TODO decide if workspace or other lock is required during execution of this method.

Since:

1.4

enableMavenNature

public void enableMavenNature(org.eclipse.core.resources.IProject project,
                              ResolverConfiguration configuration,
                              org.eclipse.core.runtime.IProgressMonitor monitor)
                       throws org.eclipse.core.runtime.CoreException

Specified by:

enableMavenNature in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

disableMavenNature

public void disableMavenNature(org.eclipse.core.resources.IProject project,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
                        throws org.eclipse.core.runtime.CoreException

Specified by:

disableMavenNature in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

addMavenBuilder

public boolean addMavenBuilder(org.eclipse.core.resources.IProject project,
                               org.eclipse.core.resources.IProjectDescription description,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
                        throws org.eclipse.core.runtime.CoreException

Description copied from interface: IProjectConfigurationManager

Adds the maven builder to the specified project.

Specified by:

addMavenBuilder in interface IProjectConfigurationManager

Returns:

true if the maven builder was added or its position in the list of builders was changed

Throws:

org.eclipse.core.runtime.CoreException

removeMavenBuilder

public boolean removeMavenBuilder(org.eclipse.core.resources.IProject project,
                                  org.eclipse.core.resources.IProjectDescription description,
                                  org.eclipse.core.runtime.IProgressMonitor monitor)
                           throws org.eclipse.core.runtime.CoreException

Description copied from interface: IProjectConfigurationManager

Removes the maven builder from the specified project.

Specified by:

removeMavenBuilder in interface IProjectConfigurationManager

Returns:

true if the maven builder was removed

Throws:

org.eclipse.core.runtime.CoreException

createSimpleProject

public void createSimpleProject(org.eclipse.core.resources.IProject project,
                                org.eclipse.core.runtime.IPath location,
                                org.apache.maven.model.Model model,
                                String[] directories,
                                ProjectImportConfiguration configuration,
                                org.eclipse.core.runtime.IProgressMonitor monitor)
                         throws org.eclipse.core.runtime.CoreException

Specified by:

createSimpleProject in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

createSimpleProject

public void createSimpleProject(org.eclipse.core.resources.IProject project,
                                org.eclipse.core.runtime.IPath location,
                                org.apache.maven.model.Model model,
                                String[] directories,
                                ProjectImportConfiguration configuration,
                                IProjectCreationListener listener,
                                org.eclipse.core.runtime.IProgressMonitor monitor)
                         throws org.eclipse.core.runtime.CoreException

Creates simple Maven project

The following steps are executed in the given order:

• Creates the workspace project
• Adds project to working set
• Creates the required folders
• Creates the POM
• Configures project

Specified by:

createSimpleProject in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

createFolder

public static void createFolder(org.eclipse.core.resources.IFolder folder,
                                boolean derived)
                         throws org.eclipse.core.runtime.CoreException

Helper method which creates a folder and, recursively, all its parent folders.

Parameters:

folder - The folder to create.

derived - true if folder should be marked as derived

Throws:

org.eclipse.core.runtime.CoreException - if creating the given folder or any of its parents fails.

createArchetypeProject

@Deprecated
public void createArchetypeProject(org.eclipse.core.resources.IProject project,
                                               org.eclipse.core.runtime.IPath location,
                                               org.apache.maven.archetype.catalog.Archetype archetype,
                                               String groupId,
                                               String artifactId,
                                               String version,
                                               String javaPackage,
                                               Properties properties,
                                               ProjectImportConfiguration configuration,
                                               org.eclipse.core.runtime.IProgressMonitor monitor)
                                        throws org.eclipse.core.runtime.CoreException

Deprecated. use createArchetypeProjects(IPath, Archetype, String, String, String, String, Properties, ProjectImportConfiguration, IProgressMonitor)

Creates project structure using Archetype and then imports created project(s)

Specified by:

createArchetypeProject in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

createArchetypeProjects

public List<org.eclipse.core.resources.IProject> createArchetypeProjects(org.eclipse.core.runtime.IPath location,
                                                                         org.apache.maven.archetype.catalog.Archetype archetype,
                                                                         String groupId,
                                                                         String artifactId,
                                                                         String version,
                                                                         String javaPackage,
                                                                         Properties properties,
                                                                         ProjectImportConfiguration configuration,
                                                                         org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                  throws org.eclipse.core.runtime.CoreException

Creates project structure using Archetype and then imports created project(s)

Specified by:

createArchetypeProjects in interface IProjectConfigurationManager

Returns:

an unmodifiable list of created projects.

Throws:

org.eclipse.core.runtime.CoreException

Since:

1.1

createArchetypeProjects

public List<org.eclipse.core.resources.IProject> createArchetypeProjects(org.eclipse.core.runtime.IPath location,
                                                                         org.apache.maven.archetype.catalog.Archetype archetype,
                                                                         String groupId,
                                                                         String artifactId,
                                                                         String version,
                                                                         String javaPackage,
                                                                         Properties properties,
                                                                         ProjectImportConfiguration configuration,
                                                                         IProjectCreationListener listener,
                                                                         org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                  throws org.eclipse.core.runtime.CoreException

Creates project structure using Archetype and then imports created project(s)

Specified by:

createArchetypeProjects in interface IProjectConfigurationManager

Returns:

an unmodifiable list of created projects.

Throws:

org.eclipse.core.runtime.CoreException

Since:

1.8

collectProjects

public Set<MavenProjectInfo> collectProjects(Collection<MavenProjectInfo> projects)

Specified by:

collectProjects in interface IProjectConfigurationManager

getRule

public org.eclipse.core.runtime.jobs.ISchedulingRule getRule()

Specified by:

getRule in interface IProjectConfigurationManager

mavenProjectChanged

public void mavenProjectChanged(MavenProjectChangedEvent[] events,
                                org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IMavenProjectChangedListener

This method is called while holding workspace lock.

Specified by:

mavenProjectChanged in interface IMavenProjectChangedListener

getLifecycleMapping

public ILifecycleMapping getLifecycleMapping(IMavenProjectFacade projectFacade)
                                      throws org.eclipse.core.runtime.CoreException

Specified by:

getLifecycleMapping in interface IProjectConfigurationManager

Throws:

org.eclipse.core.runtime.CoreException

resourceChanged

public void resourceChanged(org.eclipse.core.resources.IResourceChangeEvent event)

Specified by:

resourceChanged in interface org.eclipse.core.resources.IResourceChangeListener

getResolverConfiguration

public ResolverConfiguration getResolverConfiguration(org.eclipse.core.resources.IProject project)

Description copied from interface: IProjectConfigurationManager

PROVISIONAL

Specified by:

getResolverConfiguration in interface IProjectConfigurationManager

setResolverConfiguration

public boolean setResolverConfiguration(org.eclipse.core.resources.IProject project,
                                        ResolverConfiguration configuration)

Description copied from interface: IProjectConfigurationManager

PROVISIONAL

Specified by:

setResolverConfiguration in interface IProjectConfigurationManager