org.eclipse.m2e.core.project.configurator

Class AbstractProjectConfigurator

java.lang.Object

org.eclipse.m2e.core.project.configurator.AbstractProjectConfigurator

All Implemented Interfaces:

org.eclipse.core.runtime.IExecutableExtension, IMavenProjectChangedListener

Direct Known Subclasses:

AbstractJavaProjectConfigurator, AbstractJavaProjectConfigurator, AbstractSourcesGenerationProjectConfigurator

public abstract class AbstractProjectConfigurator
extends java.lang.Object
implements org.eclipse.core.runtime.IExecutableExtension, IMavenProjectChangedListener

Used to configure maven projects.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_CLASS
static java.lang.String	ATTR_ID
static java.lang.String	ATTR_NAME
private java.lang.String	id
private static org.slf4j.Logger	log
protected IMavenMarkerManager	markerManager
protected IMaven	maven
protected IMavenConfiguration	mavenConfiguration
private java.lang.String	name
protected IMavenProjectRegistry	projectManager

Constructor Summary

Constructors

Constructor and Description
AbstractProjectConfigurator()

Method Summary

Modifier and Type	Method and Description
static void	addNature(org.eclipse.core.resources.IProject project, java.lang.String natureId, int updateFlags, org.eclipse.core.runtime.IProgressMonitor monitor)
static void	addNature(org.eclipse.core.resources.IProject project, java.lang.String natureId, org.eclipse.core.runtime.IProgressMonitor monitor)
protected void	assertHasNature(org.eclipse.core.resources.IProject project, java.lang.String natureId)
abstract void	configure(ProjectConfigurationRequest request, org.eclipse.core.runtime.IProgressMonitor monitor) Configures Eclipse project passed in ProjectConfigurationRequest, using information from Maven project and other configuration request parameters
boolean	equals(java.lang.Object obj)
AbstractBuildParticipant	getBuildParticipant(IMavenProjectFacade projectFacade, org.apache.maven.plugin.MojoExecution execution, IPluginExecutionMetadata executionMetadata)
static java.util.Map<java.lang.String,java.util.Set<MojoExecutionKey>>	getConfiguratorExecutions(IMavenProjectFacade projectFacade)
java.lang.String	getId()
protected java.util.List<org.apache.maven.plugin.MojoExecution>	getMojoExecutions(ProjectConfigurationRequest request, org.eclipse.core.runtime.IProgressMonitor monitor) Returns list of MojoExecutions this configurator is enabled for.
java.lang.String	getName()
protected <T> T	getParameterValue(org.apache.maven.project.MavenProject project, java.lang.String parameter, java.lang.Class<T> asType, org.apache.maven.plugin.MojoExecution mojoExecution, org.eclipse.core.runtime.IProgressMonitor monitor)
protected <T> T	getParameterValue(java.lang.String parameter, java.lang.Class<T> asType, org.apache.maven.execution.MavenSession session, org.apache.maven.plugin.MojoExecution mojoExecution) Deprecated. this method does not properly join IMavenExecutionContext, use #getMojoParameterValue(String, Class, Plugin, ConfigurationContainer, String) instead.
boolean	hasConfigurationChanged(IMavenProjectFacade newFacade, ILifecycleMappingConfiguration oldProjectConfiguration, MojoExecutionKey key, org.eclipse.core.runtime.IProgressMonitor monitor) Returns true if project configuration has changed and running configure(ProjectConfigurationRequest, IProgressMonitor) is required.
int	hashCode()
void	mavenProjectChanged(MavenProjectChangedEvent[] events, org.eclipse.core.runtime.IProgressMonitor monitor) This method is called while holding workspace lock.
void	mavenProjectChanged(MavenProjectChangedEvent event, org.eclipse.core.runtime.IProgressMonitor monitor) Updates project configuration according project changes.
void	setInitializationData(org.eclipse.core.runtime.IConfigurationElement config, java.lang.String propertyName, java.lang.Object data)
void	setMarkerManager(IMavenMarkerManager markerManager)
void	setMavenConfiguration(IMavenConfiguration mavenConfiguration)
void	setProjectManager(IMavenProjectRegistry projectManager)
java.lang.String	toString()
void	unconfigure(ProjectConfigurationRequest request, org.eclipse.core.runtime.IProgressMonitor monitor) Removes Maven specific configuration from the project passed in ProjectConfigurationRequest

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

log

private static final org.slf4j.Logger log

ATTR_ID

public static final java.lang.String ATTR_ID

See Also:

Constant Field Values

ATTR_NAME

public static final java.lang.String ATTR_NAME

See Also:

Constant Field Values

ATTR_CLASS

public static final java.lang.String ATTR_CLASS

See Also:

Constant Field Values

id

private java.lang.String id

name

private java.lang.String name

projectManager

protected IMavenProjectRegistry projectManager

mavenConfiguration

protected IMavenConfiguration mavenConfiguration

markerManager

protected IMavenMarkerManager markerManager

maven

protected IMaven maven

Constructor Detail

AbstractProjectConfigurator

public AbstractProjectConfigurator()

Method Detail

setProjectManager

public void setProjectManager(IMavenProjectRegistry projectManager)

setMavenConfiguration

public void setMavenConfiguration(IMavenConfiguration mavenConfiguration)

setMarkerManager

public void setMarkerManager(IMavenMarkerManager markerManager)

configure

public abstract void configure(ProjectConfigurationRequest request,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
                        throws org.eclipse.core.runtime.CoreException

Configures Eclipse project passed in ProjectConfigurationRequest, using information from Maven project and other configuration request parameters

Should be implemented by subclass

Parameters:

request - a project configuration request

monitor - a progress monitor

Throws:

org.eclipse.core.runtime.CoreException

unconfigure

public void unconfigure(ProjectConfigurationRequest request,
                        org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws org.eclipse.core.runtime.CoreException

Removes Maven specific configuration from the project passed in ProjectConfigurationRequest

Parameters:

request - a project un-configuration request

monitor - a progress monitor

Throws:

org.eclipse.core.runtime.CoreException

mavenProjectChanged

public void mavenProjectChanged(MavenProjectChangedEvent event,
                                org.eclipse.core.runtime.IProgressMonitor monitor)
                         throws org.eclipse.core.runtime.CoreException

Updates project configuration according project changes.

Can be overwritten by subclass

Parameters:

event - a project change event

monitor - a progress monitor

Throws:

org.eclipse.core.runtime.CoreException

mavenProjectChanged

public final 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

getId

public java.lang.String getId()

getName

public java.lang.String getName()

setInitializationData

public void setInitializationData(org.eclipse.core.runtime.IConfigurationElement config,
                                  java.lang.String propertyName,
                                  java.lang.Object data)

Specified by:

setInitializationData in interface org.eclipse.core.runtime.IExecutableExtension

addNature

public static void addNature(org.eclipse.core.resources.IProject project,
                             java.lang.String natureId,
                             org.eclipse.core.runtime.IProgressMonitor monitor)
                      throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

addNature

public static void addNature(org.eclipse.core.resources.IProject project,
                             java.lang.String natureId,
                             int updateFlags,
                             org.eclipse.core.runtime.IProgressMonitor monitor)
                      throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

Since:

1.3

getParameterValue

protected <T> T getParameterValue(java.lang.String parameter,
                                  java.lang.Class<T> asType,
                                  org.apache.maven.execution.MavenSession session,
                                  org.apache.maven.plugin.MojoExecution mojoExecution)
                           throws org.eclipse.core.runtime.CoreException

Deprecated. this method does not properly join IMavenExecutionContext, use #getMojoParameterValue(String, Class, Plugin, ConfigurationContainer, String) instead.

Throws:

org.eclipse.core.runtime.CoreException

getParameterValue

protected <T> T getParameterValue(org.apache.maven.project.MavenProject project,
                                  java.lang.String parameter,
                                  java.lang.Class<T> asType,
                                  org.apache.maven.plugin.MojoExecution mojoExecution,
                                  org.eclipse.core.runtime.IProgressMonitor monitor)
                           throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

Since:

1.4

assertHasNature

protected void assertHasNature(org.eclipse.core.resources.IProject project,
                               java.lang.String natureId)
                        throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getBuildParticipant

public AbstractBuildParticipant getBuildParticipant(IMavenProjectFacade projectFacade,
                                                    org.apache.maven.plugin.MojoExecution execution,
                                                    IPluginExecutionMetadata executionMetadata)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getMojoExecutions

protected java.util.List<org.apache.maven.plugin.MojoExecution> getMojoExecutions(ProjectConfigurationRequest request,
                                                                                  org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                           throws org.eclipse.core.runtime.CoreException

Returns list of MojoExecutions this configurator is enabled for.

Throws:

org.eclipse.core.runtime.CoreException

getConfiguratorExecutions

public static java.util.Map<java.lang.String,java.util.Set<MojoExecutionKey>> getConfiguratorExecutions(IMavenProjectFacade projectFacade)

hasConfigurationChanged

public boolean hasConfigurationChanged(IMavenProjectFacade newFacade,
                                       ILifecycleMappingConfiguration oldProjectConfiguration,
                                       MojoExecutionKey key,
                                       org.eclipse.core.runtime.IProgressMonitor monitor)

Returns true if project configuration has changed and running configure(ProjectConfigurationRequest, IProgressMonitor) is required. Default implementation uses Xpp3Dom.equals(Object) to compare before/after mojo configuration.