Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorIgor Fedorenko2013-02-17 11:28:39 -0500
committerIgor Fedorenko2013-02-17 11:28:39 -0500
commit03390fbd48f201fbc6e6d191f7dc2455539abc1d (patch)
tree41822556c0f5ee77e66819d92713d89f4a0b2a34
parentc893da5d6544f99199ef4b43f04e42fbf52251ad (diff)
downloadm2e-core-03390fbd48f201fbc6e6d191f7dc2455539abc1d.tar.gz
m2e-core-03390fbd48f201fbc6e6d191f7dc2455539abc1d.tar.xz
m2e-core-03390fbd48f201fbc6e6d191f7dc2455539abc1d.zip
wrote AbstractSourcesGenerationProjectConfigurator javadoc
Signed-off-by: Igor Fedorenko <igor@ifedorenko.com>
-rw-r--r--org.eclipse.m2e.jdt/src/org/eclipse/m2e/jdt/AbstractSourcesGenerationProjectConfigurator.java13
1 files changed, 13 insertions, 0 deletions
diff --git a/org.eclipse.m2e.jdt/src/org/eclipse/m2e/jdt/AbstractSourcesGenerationProjectConfigurator.java b/org.eclipse.m2e.jdt/src/org/eclipse/m2e/jdt/AbstractSourcesGenerationProjectConfigurator.java
index 6893986f..c42df74a 100644
--- a/org.eclipse.m2e.jdt/src/org/eclipse/m2e/jdt/AbstractSourcesGenerationProjectConfigurator.java
+++ b/org.eclipse.m2e.jdt/src/org/eclipse/m2e/jdt/AbstractSourcesGenerationProjectConfigurator.java
@@ -20,10 +20,23 @@ import org.apache.maven.plugin.MojoExecution;
import org.eclipse.m2e.core.project.IMavenProjectFacade;
import org.eclipse.m2e.core.project.MavenProjectUtils;
+import org.eclipse.m2e.core.project.configurator.AbstractBuildParticipant;
import org.eclipse.m2e.core.project.configurator.AbstractProjectConfigurator;
import org.eclipse.m2e.core.project.configurator.ProjectConfigurationRequest;
+/**
+ * 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 <strong>MUST</strong> check for input model changes
+ * before executing the mojo and <strong>MUST</strong> 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.
+ *
+ * @see {@link AbstractBuildParticipant#getBuildContext()}
+ * @since 1.4
+ */
public abstract class AbstractSourcesGenerationProjectConfigurator extends AbstractProjectConfigurator implements
IJavaProjectConfigurator {
@Override

Back to the top