org.eclipse.m2e.jdt

Class AbstractSourcesGenerationProjectConfigurator

java.lang.Object

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

org.eclipse.m2e.jdt.AbstractSourcesGenerationProjectConfigurator

All Implemented Interfaces:

org.eclipse.core.runtime.IExecutableExtension, IMavenProjectChangedListener, IJavaProjectConfigurator

public abstract class AbstractSourcesGenerationProjectConfigurator
extends AbstractProjectConfigurator
implements IJavaProjectConfigurator

Convenience abstract baseclass for project configurators that "wrap" code generation maven plugins, like modello and similar. Adds generated sources folders to project raw classpath and provides hooks to customise location of generated sources directories. Implementation assumes mojos that use BuildContext API to participate in workspace build. For mojos that do not use BuildContext API, subclasses MUST check for input model changes before executing the mojo and MUST refresh output folders from local filesystem after executing the mojo. BuildContext API is the recommending way to implement both check for model changes and refresh output folders from local filesystem.

Since:

1.4

See Also:

AbstractBuildParticipant#getBuildContext()}

Field Summary

Fields inherited from class org.eclipse.m2e.core.project.configurator.AbstractProjectConfigurator

ATTR_CLASS, ATTR_ID, ATTR_NAME, markerManager, maven, mavenConfiguration, projectManager

Constructor Summary

Constructors

Constructor and Description
AbstractSourcesGenerationProjectConfigurator()

Method Summary

Modifier and Type	Method and Description
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
void	configureClasspath(IMavenProjectFacade facade, IClasspathDescriptor classpath, org.eclipse.core.runtime.IProgressMonitor monitor) Configures *Maven* project classpath, i.e.
void	configureRawClasspath(ProjectConfigurationRequest request, IClasspathDescriptor classpath, org.eclipse.core.runtime.IProgressMonitor monitor) Configures *JDT* project classpath, i.e.
protected org.eclipse.core.runtime.IPath	getFullPath(IMavenProjectFacade facade, File file)
protected String	getOutputFolderParameterName()
protected File[]	getSourceFolders(ProjectConfigurationRequest request, org.apache.maven.plugin.MojoExecution mojoExecution, org.eclipse.core.runtime.IProgressMonitor monitor)

Methods inherited from class org.eclipse.m2e.core.project.configurator.AbstractProjectConfigurator

addNature, addNature, assertHasNature, equals, getBuildParticipant, getConfiguratorExecutions, getId, getMojoExecutions, getName, getParameterValue, getParameterValue, hasConfigurationChanged, hashCode, mavenProjectChanged, mavenProjectChanged, setInitializationData, setMarkerManager, setMavenConfiguration, setProjectManager, toString, unconfigure

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSourcesGenerationProjectConfigurator

public AbstractSourcesGenerationProjectConfigurator()

Method Detail

configure

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

Description copied from class: AbstractProjectConfigurator

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

Should be implemented by subclass

Specified by:

configure in class AbstractProjectConfigurator

Parameters:

request - a project configuration request

monitor - a progress monitor

Throws:

org.eclipse.core.runtime.CoreException

configureClasspath

public void configureClasspath(IMavenProjectFacade facade,
                               IClasspathDescriptor classpath,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
                        throws org.eclipse.core.runtime.CoreException

Description copied from interface: IJavaProjectConfigurator

Configures *Maven* project classpath, i.e. content of Maven Dependencies classpath container.

Specified by:

configureClasspath in interface IJavaProjectConfigurator

Throws:

org.eclipse.core.runtime.CoreException

configureRawClasspath

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

Description copied from interface: IJavaProjectConfigurator

Configures *JDT* project classpath, i.e. project-level entries like source folders, JRE and Maven Dependencies classpath container.

Specified by:

configureRawClasspath in interface IJavaProjectConfigurator

Throws:

org.eclipse.core.runtime.CoreException

getFullPath

protected org.eclipse.core.runtime.IPath getFullPath(IMavenProjectFacade facade,
                                                     File file)

getSourceFolders

protected File[] getSourceFolders(ProjectConfigurationRequest request,
                                  org.apache.maven.plugin.MojoExecution mojoExecution,
                                  org.eclipse.core.runtime.IProgressMonitor monitor)
                           throws org.eclipse.core.runtime.CoreException

Throws:

org.eclipse.core.runtime.CoreException

getOutputFolderParameterName

protected String getOutputFolderParameterName()