org.apache.maven.plugin.eclipse.HelpMojo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-eclipse-plugin Show documentation
Show all versions of maven-eclipse-plugin Show documentation
The Eclipse Plugin is used to generate Eclipse IDE files (.project, .classpath and the .settings folder)
from a POM.
package org.apache.maven.plugin.eclipse;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
/**
* Display help information on maven-eclipse-plugin.
Call mvn eclipse:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details.
*
* @version generated on Mon Feb 22 02:02:56 CET 2010
* @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.4.3)
* @goal help
* @requiresProject false
*/
public class HelpMojo
extends AbstractMojo
{
/**
* If true, display all settable properties for each goal.
*
* @parameter expression="${detail}" default-value="false"
*/
private boolean detail;
/**
* The name of the goal for which to show help. If unspecified, all goals will be displayed.
*
* @parameter expression="${goal}"
*/
private java.lang.String goal;
/**
* The maximum length of a display line, should be positive.
*
* @parameter expression="${lineLength}" default-value="80"
*/
private int lineLength;
/**
* The number of spaces per indentation level, should be positive.
*
* @parameter expression="${indentSize}" default-value="2"
*/
private int indentSize;
/** {@inheritDoc} */
public void execute()
throws MojoExecutionException
{
if ( lineLength <= 0 )
{
getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." );
lineLength = 80;
}
if ( indentSize <= 0 )
{
getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." );
indentSize = 2;
}
StringBuffer sb = new StringBuffer();
append( sb, "org.apache.maven.plugins:maven-eclipse-plugin:2.8", 0 );
append( sb, "", 0 );
append( sb, "Maven Eclipse Plugin 2.8", 0 );
append( sb, "The Eclipse Plugin is used to generate Eclipse IDE files (.project, .classpath and the .settings folder) from a POM.", 1 );
append( sb, "", 0 );
if ( goal == null || goal.length() <= 0 )
{
append( sb, "This plugin has 13 goals:", 0 );
append( sb, "", 0 );
}
if ( goal == null || goal.length() <= 0 || "add-maven-repo".equals( goal ) )
{
append( sb, "eclipse:add-maven-repo", 0 );
append( sb, "Deprecated. Use configure-workspace goal instead.", 1 );
if ( detail )
{
append( sb, "", 0 );
append( sb, "Adds the classpath variable M2_REPO to Eclipse. DEPRECATED. Replaced by eclipse:configure-workspace.", 1 );
}
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "workspace", 2 );
append( sb, "Directory location of the Eclipse workspace.", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "clean".equals( goal ) )
{
append( sb, "eclipse:clean", 0 );
append( sb, "Deletes the .project, .classpath, .wtpmodules files and .settings folder used by Eclipse.", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "additionalConfig", 2 );
append( sb, "additional generic configuration files for eclipse", 3 );
append( sb, "", 0 );
append( sb, "basedir", 2 );
append( sb, "The root directory of the project", 3 );
append( sb, "", 0 );
append( sb, "packaging", 2 );
append( sb, "Packaging for the current project.", 3 );
append( sb, "", 0 );
append( sb, "skip (Default: false)", 2 );
append( sb, "Skip the operation when true.", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "configure-workspace".equals( goal ) )
{
append( sb, "eclipse:configure-workspace", 0 );
append( sb, "Configures The following Eclipse Workspace features:\n-\tAdds the classpath variable MAVEN_REPO to Eclipse.\n-\tOptionally load Eclipse code style file via a URL.\n", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "workspace", 2 );
append( sb, "Directory location of the Eclipse workspace.", 3 );
append( sb, "", 0 );
append( sb, "workspaceActiveCodeStyleProfileName", 2 );
append( sb, "Name of a profile in workspaceCodeStylesURL to activate. Default is the first profile name in the code style file in workspaceCodeStylesURL", 3 );
append( sb, "", 0 );
append( sb, "workspaceCodeStylesURL", 2 );
append( sb, "Point to a URL containing code styles content.", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "eclipse".equals( goal ) )
{
append( sb, "eclipse:eclipse", 0 );
append( sb, "Generates the following eclipse configuration files:\n-\t.project and .classpath files\n-\t.setting/org.eclipse.jdt.core.prefs with project specific compiler settings\n-\tvarious configuration files for WTP (Web Tools Project), if the parameter wtpversion is set to a valid version (WTP configuration is not generated by default)\nIf this goal is run on a multiproject root, dependencies between modules will be configured as direct project dependencies in Eclipse (unless useProjectReferences is set to false).", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "addGroupIdToProjectName (Default: false)", 2 );
append( sb, "If set to true, the groupId of the artifact is appended to the name of the generated Eclipse project. See projectNameTemplate for other options.", 3 );
append( sb, "", 0 );
append( sb, "addVersionToProjectName (Default: false)", 2 );
append( sb, "If set to true, the version number of the artifact is appended to the name of the generated Eclipse project. See projectNameTemplate for other options.", 3 );
append( sb, "", 0 );
append( sb, "additionalBuildcommands", 2 );
append( sb, "List of eclipse build commands to be added to the default ones. Old style:\n\norg.springframework.ide.eclipse.core.springbuilder \n \nNew style:\n\n\norg.ui.externaltools.ExternalToolBuilder \nauto,full,incremental, \n\n<project>./externalToolBuilders/MavenBuilder.launch \n \n \n \nNote the difference between buildcommand and buildCommand. You can mix and match old and new-style configuration entries.", 3 );
append( sb, "", 0 );
append( sb, "additionalConfig", 2 );
append( sb, "Allow to configure additional generic configuration files for eclipse that will be written out to disk when running eclipse:eclipse. FOr each file you can specify the name and the text content.\n\norg.apache.maven.plugins \nmaven-eclipse-plugin \n\n\n\n.checkstyle \n\n\n\n \n \n \n \n \nInstead of the content you can also define (from version 2.5) an url to download the file :\n\norg.apache.maven.plugins \nmaven-eclipse-plugin \n\n\n\n.checkstyle \nhttp://some.place.org/path/to/file \n \n \n \nor a location :\n\norg.apache.maven.plugins \nmaven-eclipse-plugin \n\n\n\n.checkstyle \n/checkstyle-config.xml \n \n \n \n\n\n\neclipsetest \ncheckstyle-config \n1.0 \n \n \n \n", 3 );
append( sb, "", 0 );
append( sb, "additionalProjectFacets", 2 );
append( sb, "List of eclipse project facets to be added to the default ones.\n\n1.1 \n", 3 );
append( sb, "", 0 );
append( sb, "additionalProjectnatures", 2 );
append( sb, "List of eclipse project natures to be added to the default ones.\n\norg.springframework.ide.eclipse.core.springnature \n \n", 3 );
append( sb, "", 0 );
append( sb, "ajdtVersion (Default: none)", 2 );
append( sb, "The version of AJDT for which configuration files will be generated. The default value is \'1.5\', supported versions are \'none\' (AJDT support disabled), \'1.4\', and \'1.5\'.", 3 );
append( sb, "", 0 );
append( sb, "buildOutputDirectory (Default: ${project.build.outputDirectory})", 2 );
append( sb, "The default output directory", 3 );
append( sb, "", 0 );
append( sb, "buildcommands", 2 );
append( sb, "List of eclipse build commands. By default the org.eclipse.jdt.core.javabuilder builder plus the needed WTP builders are added. If you specify any configuration for this parameter, only those buildcommands specified will be used; the defaults won\'t be added. Use the additionalBuildCommands parameter for that. Configuration example: Old style:\n\norg.eclipse.wst.common.modulecore.ComponentStructuralBuilder \norg.eclipse.jdt.core.javabuilder \norg.eclipse.wst.common.modulecore.ComponentStructuralBuilderDependencyResolver \n \nFor new style, see additionalBuildCommands.", 3 );
append( sb, "", 0 );
append( sb, "classpathContainers", 2 );
append( sb, "List of container classpath entries. By default the org.eclipse.jdt.launching.JRE_CONTAINER classpath container is added. Configuration example:\n\norg.eclipse.jdt.launching.JRE_CONTAINER \norg.eclipse.jst.server.core.container/org.eclipse.jst.server.tomcat.runtimeTarget/Apache\u00a0Tomcat\u00a0v5.5 \norg.eclipse.jst.j2ee.internal.web.container/artifact \n \n", 3 );
append( sb, "", 0 );
append( sb, "downloadJavadocs", 2 );
append( sb, "Enables/disables the downloading of javadoc attachments. Defaults to false. When this flag is true remote repositories are checked for javadocs: in order to avoid repeated check for unavailable javadoc archives, a status cache is mantained. With versions 2.6+ of the plugin to reset this cache run mvn eclipse:remove-cache, or use the forceRecheck option with versions. With older versions delete the file mvn-eclipse-cache.properties in the target directory.", 3 );
append( sb, "", 0 );
append( sb, "downloadSources", 2 );
append( sb, "Enables/disables the downloading of source attachments. Defaults to false. When this flag is true remote repositories are checked for sources: in order to avoid repeated check for unavailable source archives, a status cache is mantained. With versions 2.6+ of the plugin to reset this cache run mvn eclipse:remove-cache, or use the forceRecheck option with versions. With older versions delete the file mvn-eclipse-cache.properties in the target directory.", 3 );
append( sb, "", 0 );
append( sb, "eclipseDownloadSources", 2 );
append( sb, "Deprecated. use downloadSources", 3 );
append( sb, "", 0 );
append( sb, "Enables/disables the downloading of source attachments. Defaults to false. DEPRECATED - use downloadSources", 3 );
append( sb, "", 0 );
append( sb, "eclipseProjectDir", 2 );
append( sb, "Eclipse workspace directory.", 3 );
append( sb, "", 0 );
append( sb, "excludes", 2 );
append( sb, "List of artifact to exclude from eclipse classpath, beeing provided by some eclipse classPathContainer [MECLIPSE-79]", 3 );
append( sb, "", 0 );
append( sb, "forceRecheck", 2 );
append( sb, "Enables/disables the rechecking of the remote repository for downloading source/javadoc attachments. Defaults to false. When this flag is true and the source or javadoc attachment has a status cache to indicate that it is not available, then the remote repository will be rechecked for a source or javadoc attachment and the status cache updated to reflect the new state.", 3 );
append( sb, "", 0 );
append( sb, "limitProjectReferencesToWorkspace (Default: false)", 2 );
append( sb, "Limit the use of project references to the current workspace. No project references will be created to projects in the reactor when they are not available in the workspace.", 3 );
append( sb, "", 0 );
append( sb, "linkedResources", 2 );
append( sb, "A list of links to local files in the system. A configuration like this one in the pom : org.apache.maven.plugins maven-eclipse-plugin src/test/resources/oracle-ds.xml 1 C://jboss/server/default/deploy/oracle-ds.xml will produce in the .project : src/test/resources/oracle-ds.xml 1 C://jboss/server/default/deploy/oracle-ds.xml ", 3 );
append( sb, "", 0 );
append( sb, "manifest (Default: ${basedir}/META-INF/MANIFEST.MF)", 2 );
append( sb, "The relative path of the manifest file", 3 );
append( sb, "", 0 );
append( sb, "packaging", 2 );
append( sb, "The project packaging.", 3 );
append( sb, "", 0 );
append( sb, "pde (Default: false)", 2 );
append( sb, "Is it an PDE project? If yes, the plugin adds the necessary natures and build commands to the .project file. Additionally it copies all libraries to a project local directory and references them instead of referencing the files in the local Maven repository. It also ensured that the \'Bundle-Classpath\' in META-INF/MANIFEST.MF is synchronized.", 3 );
append( sb, "", 0 );
append( sb, "projectNameTemplate", 2 );
append( sb, "Allows configuring the name of the eclipse projects. This property if set wins over addVersionToProjectName and addGroupIdToProjectName You can use [groupId], [artifactId] and [version] variables. eg. [groupId].[artifactId]-[version]", 3 );
append( sb, "", 0 );
append( sb, "projectnatures", 2 );
append( sb, "List of eclipse project natures. By default the org.eclipse.jdt.core.javanature nature plus the needed WTP natures are added. Natures added using this property replace the default list.\n\norg.eclipse.jdt.core.javanature \norg.eclipse.wst.common.modulecore.ModuleCoreNature \n \n", 3 );
append( sb, "", 0 );
append( sb, "skip (Default: false)", 2 );
append( sb, "Skip the operation when true.", 3 );
append( sb, "", 0 );
append( sb, "sourceExcludes", 2 );
append( sb, "List of exclusions to add to the source directories on the classpath. Adds excluding=\'\' to the classpathentry of the eclipse .classpath file. [MECLIPSE-104]", 3 );
append( sb, "", 0 );
append( sb, "sourceIncludes", 2 );
append( sb, "List of inclusions to add to the source directories on the classpath. Adds including=\'\' to the classpathentry of the eclipse .classpath file.\nJava projects will always include \'**/*.java\'\n\nAjdt projects will always include \'**/*.aj\'\n\n[MECLIPSE-104]\n", 3 );
append( sb, "", 0 );
append( sb, "useProjectReferences (Default: true)", 2 );
append( sb, "When set to false, the plugin will not create sub-projects and instead reference those sub-projects using the installed package in the local repository", 3 );
append( sb, "", 0 );
append( sb, "workspace", 2 );
append( sb, "This eclipse workspace is read and all artifacts detected there will be connected as eclipse projects and will not be linked to the jars in the local repository. Requirement is that it was created with the similar wtp settings as the reactor projects, but the project name template my differ. The pom\'s in the workspace projects may not contain variables in the artefactId, groupId and version tags. If workspace is not defined, then an attempt to locate it by checking up the directory hierarchy will be made.", 3 );
append( sb, "", 0 );
append( sb, "wtpContextName", 2 );
append( sb, "JEE context name of the WTP module. ( ex. WEB context name ).", 3 );
append( sb, "", 0 );
append( sb, "wtpapplicationxml (Default: false)", 2 );
append( sb, "Must the application files be written for ear projects in a separate directory.", 3 );
append( sb, "", 0 );
append( sb, "wtpdefaultserver", 2 );
append( sb, "What WTP defined server to use for deployment informations.", 3 );
append( sb, "", 0 );
append( sb, "wtpmanifest (Default: false)", 2 );
append( sb, "Must the manifest files be written for java projects so that that the jee classpath for wtp is correct.", 3 );
append( sb, "", 0 );
append( sb, "wtpversion (Default: none)", 2 );
append( sb, "The version of WTP for which configuration files will be generated. The default value is \'none\' (don\'t generate WTP configuration), supported versions are \'R7\', \'1.0\', and \'1.5\'", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
{
append( sb, "eclipse:help", 0 );
append( sb, "Display help information on maven-eclipse-plugin.\nCall\n\u00a0\u00a0mvn\u00a0eclipse:help\u00a0-Ddetail=true\u00a0-Dgoal=\nto display parameter details.", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "detail (Default: false)", 2 );
append( sb, "If true, display all settable properties for each goal.", 3 );
append( sb, "", 0 );
append( sb, "goal", 2 );
append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
append( sb, "", 0 );
append( sb, "lineLength (Default: 80)", 2 );
append( sb, "The maximum length of a display line, should be positive.", 3 );
append( sb, "", 0 );
append( sb, "indentSize (Default: 2)", 2 );
append( sb, "The number of spaces per indentation level, should be positive.", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "install-plugins".equals( goal ) )
{
append( sb, "eclipse:install-plugins", 0 );
append( sb, "Install plugins resolved from the Maven repository system into an Eclipse instance.", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "eclipseDir", 2 );
append( sb, "This is the installed base directory of the Eclipse instance you want to modify.", 3 );
append( sb, "", 0 );
append( sb, "overwrite (Default: false)", 2 );
append( sb, "Determines whether this mojo leaves existing installed plugins as-is, or overwrites them.", 3 );
append( sb, "", 0 );
append( sb, "pluginDependencyTypes (Default: jar)", 2 );
append( sb, "Comma-delimited list of dependency \norg.springframework.ide.eclipse.core.springbuilder \n \nNew style:\n\n\norg.ui.externaltools.ExternalToolBuilder \nauto,full,incremental, \n\n<project>./externalToolBuilders/MavenBuilder.launch \n \n \n \nNote the difference between buildcommand and buildCommand. You can mix and match old and new-style configuration entries.", 3 );
append( sb, "", 0 );
append( sb, "additionalConfig", 2 );
append( sb, "Allow to configure additional generic configuration files for eclipse that will be written out to disk when running eclipse:eclipse. FOr each file you can specify the name and the text content.\n\norg.apache.maven.plugins \nmaven-eclipse-plugin \n\n\n\n.checkstyle \n\n\n\n \n \n \n \n \nInstead of the content you can also define (from version 2.5) an url to download the file :\n\norg.apache.maven.plugins \nmaven-eclipse-plugin \n\n\n\n.checkstyle \nhttp://some.place.org/path/to/file \n \n \n \nor a location :\n\norg.apache.maven.plugins \nmaven-eclipse-plugin \n\n\n\n.checkstyle \n/checkstyle-config.xml \n \n \n \n\n\n\neclipsetest \ncheckstyle-config \n1.0 \n \n \n \n", 3 );
append( sb, "", 0 );
append( sb, "additionalProjectFacets", 2 );
append( sb, "List of eclipse project facets to be added to the default ones.\n\n1.1 \n", 3 );
append( sb, "", 0 );
append( sb, "additionalProjectnatures", 2 );
append( sb, "List of eclipse project natures to be added to the default ones.\n\norg.springframework.ide.eclipse.core.springnature \n \n", 3 );
append( sb, "", 0 );
append( sb, "ajdtVersion (Default: none)", 2 );
append( sb, "The version of AJDT for which configuration files will be generated. The default value is \'1.5\', supported versions are \'none\' (AJDT support disabled), \'1.4\', and \'1.5\'.", 3 );
append( sb, "", 0 );
append( sb, "buildOutputDirectory (Default: ${project.build.outputDirectory})", 2 );
append( sb, "The default output directory", 3 );
append( sb, "", 0 );
append( sb, "buildcommands", 2 );
append( sb, "List of eclipse build commands. By default the org.eclipse.jdt.core.javabuilder builder plus the needed WTP builders are added. If you specify any configuration for this parameter, only those buildcommands specified will be used; the defaults won\'t be added. Use the additionalBuildCommands parameter for that. Configuration example: Old style:\n\norg.eclipse.wst.common.modulecore.ComponentStructuralBuilder \norg.eclipse.jdt.core.javabuilder \norg.eclipse.wst.common.modulecore.ComponentStructuralBuilderDependencyResolver \n \nFor new style, see additionalBuildCommands.", 3 );
append( sb, "", 0 );
append( sb, "classpathContainers", 2 );
append( sb, "List of container classpath entries. By default the org.eclipse.jdt.launching.JRE_CONTAINER classpath container is added. Configuration example:\n\norg.eclipse.jdt.launching.JRE_CONTAINER \norg.eclipse.jst.server.core.container/org.eclipse.jst.server.tomcat.runtimeTarget/Apache\u00a0Tomcat\u00a0v5.5 \norg.eclipse.jst.j2ee.internal.web.container/artifact \n \n", 3 );
append( sb, "", 0 );
append( sb, "downloadJavadocs", 2 );
append( sb, "Enables/disables the downloading of javadoc attachments. Defaults to false. When this flag is true remote repositories are checked for javadocs: in order to avoid repeated check for unavailable javadoc archives, a status cache is mantained. With versions 2.6+ of the plugin to reset this cache run mvn eclipse:remove-cache, or use the forceRecheck option with versions. With older versions delete the file mvn-eclipse-cache.properties in the target directory.", 3 );
append( sb, "", 0 );
append( sb, "downloadSources", 2 );
append( sb, "Enables/disables the downloading of source attachments. Defaults to false. When this flag is true remote repositories are checked for sources: in order to avoid repeated check for unavailable source archives, a status cache is mantained. With versions 2.6+ of the plugin to reset this cache run mvn eclipse:remove-cache, or use the forceRecheck option with versions. With older versions delete the file mvn-eclipse-cache.properties in the target directory.", 3 );
append( sb, "", 0 );
append( sb, "eclipseDownloadSources", 2 );
append( sb, "Deprecated. use downloadSources", 3 );
append( sb, "", 0 );
append( sb, "Enables/disables the downloading of source attachments. Defaults to false. DEPRECATED - use downloadSources", 3 );
append( sb, "", 0 );
append( sb, "eclipseProjectDir", 2 );
append( sb, "Eclipse workspace directory.", 3 );
append( sb, "", 0 );
append( sb, "excludes", 2 );
append( sb, "List of artifact to exclude from eclipse classpath, beeing provided by some eclipse classPathContainer [MECLIPSE-79]", 3 );
append( sb, "", 0 );
append( sb, "forceRecheck", 2 );
append( sb, "Enables/disables the rechecking of the remote repository for downloading source/javadoc attachments. Defaults to false. When this flag is true and the source or javadoc attachment has a status cache to indicate that it is not available, then the remote repository will be rechecked for a source or javadoc attachment and the status cache updated to reflect the new state.", 3 );
append( sb, "", 0 );
append( sb, "hibernate", 2 );
append( sb, "Hibernate configuration placeholder\n>\n\n\nsrc/main/resources/applicationContext-persistence.xml \nmySessionFactory \n \n", 3 );
append( sb, "", 0 );
append( sb, "limitProjectReferencesToWorkspace (Default: false)", 2 );
append( sb, "Limit the use of project references to the current workspace. No project references will be created to projects in the reactor when they are not available in the workspace.", 3 );
append( sb, "", 0 );
append( sb, "linkedResources", 2 );
append( sb, "A list of links to local files in the system. A configuration like this one in the pom : org.apache.maven.plugins maven-eclipse-plugin src/test/resources/oracle-ds.xml 1 C://jboss/server/default/deploy/oracle-ds.xml will produce in the .project : src/test/resources/oracle-ds.xml 1 C://jboss/server/default/deploy/oracle-ds.xml ", 3 );
append( sb, "", 0 );
append( sb, "manifest (Default: ${basedir}/META-INF/MANIFEST.MF)", 2 );
append( sb, "The relative path of the manifest file", 3 );
append( sb, "", 0 );
append( sb, "packaging", 2 );
append( sb, "The project packaging.", 3 );
append( sb, "", 0 );
append( sb, "pde (Default: false)", 2 );
append( sb, "Is it an PDE project? If yes, the plugin adds the necessary natures and build commands to the .project file. Additionally it copies all libraries to a project local directory and references them instead of referencing the files in the local Maven repository. It also ensured that the \'Bundle-Classpath\' in META-INF/MANIFEST.MF is synchronized.", 3 );
append( sb, "", 0 );
append( sb, "projectNameTemplate", 2 );
append( sb, "Allows configuring the name of the eclipse projects. This property if set wins over addVersionToProjectName and addGroupIdToProjectName You can use [groupId], [artifactId] and [version] variables. eg. [groupId].[artifactId]-[version]", 3 );
append( sb, "", 0 );
append( sb, "projectnatures", 2 );
append( sb, "List of eclipse project natures. By default the org.eclipse.jdt.core.javanature nature plus the needed WTP natures are added. Natures added using this property replace the default list.\n\norg.eclipse.jdt.core.javanature \norg.eclipse.wst.common.modulecore.ModuleCoreNature \n \n", 3 );
append( sb, "", 0 );
append( sb, "skip (Default: false)", 2 );
append( sb, "Skip the operation when true.", 3 );
append( sb, "", 0 );
append( sb, "sourceExcludes", 2 );
append( sb, "List of exclusions to add to the source directories on the classpath. Adds excluding=\'\' to the classpathentry of the eclipse .classpath file. [MECLIPSE-104]", 3 );
append( sb, "", 0 );
append( sb, "sourceIncludes", 2 );
append( sb, "List of inclusions to add to the source directories on the classpath. Adds including=\'\' to the classpathentry of the eclipse .classpath file.\nJava projects will always include \'**/*.java\'\n\nAjdt projects will always include \'**/*.aj\'\n\n[MECLIPSE-104]\n", 3 );
append( sb, "", 0 );
append( sb, "spring", 2 );
append( sb, "Spring configuration placeholder\n>\n\n\n1.0/2.0 \napplicationContext-*.xml \nsrc/main/resources \n \n", 3 );
append( sb, "", 0 );
append( sb, "struts", 2 );
append( sb, "Allow declaration of struts properties for MyEclipse\n>\n\n\n1.2.9 \naction \n*.do \n1.2.9 \n \n", 3 );
append( sb, "", 0 );
append( sb, "useProjectReferences (Default: true)", 2 );
append( sb, "When set to false, the plugin will not create sub-projects and instead reference those sub-projects using the installed package in the local repository", 3 );
append( sb, "", 0 );
append( sb, "workspace", 2 );
append( sb, "This eclipse workspace is read and all artifacts detected there will be connected as eclipse projects and will not be linked to the jars in the local repository. Requirement is that it was created with the similar wtp settings as the reactor projects, but the project name template my differ. The pom\'s in the workspace projects may not contain variables in the artefactId, groupId and version tags. If workspace is not defined, then an attempt to locate it by checking up the directory hierarchy will be made.", 3 );
append( sb, "", 0 );
append( sb, "wtpContextName", 2 );
append( sb, "JEE context name of the WTP module. ( ex. WEB context name ).", 3 );
append( sb, "", 0 );
append( sb, "wtpapplicationxml (Default: false)", 2 );
append( sb, "Must the application files be written for ear projects in a separate directory.", 3 );
append( sb, "", 0 );
append( sb, "wtpdefaultserver", 2 );
append( sb, "What WTP defined server to use for deployment informations.", 3 );
append( sb, "", 0 );
append( sb, "wtpmanifest (Default: false)", 2 );
append( sb, "Must the manifest files be written for java projects so that that the jee classpath for wtp is correct.", 3 );
append( sb, "", 0 );
append( sb, "wtpversion (Default: none)", 2 );
append( sb, "The version of WTP for which configuration files will be generated. The default value is \'none\' (don\'t generate WTP configuration), supported versions are \'R7\', \'1.0\', and \'1.5\'", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "myeclipse-clean".equals( goal ) )
{
append( sb, "eclipse:myeclipse-clean", 0 );
append( sb, "Deletes configuration files used by MyEclipse", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "additionalConfig", 2 );
append( sb, "additional generic configuration files for eclipse", 3 );
append( sb, "", 0 );
append( sb, "basedir", 2 );
append( sb, "The root directory of the project", 3 );
append( sb, "", 0 );
append( sb, "packaging", 2 );
append( sb, "Packaging for the current project.", 3 );
append( sb, "", 0 );
append( sb, "skip (Default: false)", 2 );
append( sb, "Skip the operation when true.", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "rad".equals( goal ) )
{
append( sb, "eclipse:rad", 0 );
append( sb, "Generates the rad-6 configuration files.", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "addGroupIdToProjectName (Default: false)", 2 );
append( sb, "If set to true, the groupId of the artifact is appended to the name of the generated Eclipse project. See projectNameTemplate for other options.", 3 );
append( sb, "", 0 );
append( sb, "addVersionToProjectName (Default: false)", 2 );
append( sb, "If set to true, the version number of the artifact is appended to the name of the generated Eclipse project. See projectNameTemplate for other options.", 3 );
append( sb, "", 0 );
append( sb, "additionalBuildcommands", 2 );
append( sb, "List of eclipse build commands to be added to the default ones. Old style:\n\norg.springframework.ide.eclipse.core.springbuilder \n \nNew style:\n\n\norg.ui.externaltools.ExternalToolBuilder \nauto,full,incremental, \n\n<project>./externalToolBuilders/MavenBuilder.launch \n \n \n \nNote the difference between buildcommand and buildCommand. You can mix and match old and new-style configuration entries.", 3 );
append( sb, "", 0 );
append( sb, "additionalConfig", 2 );
append( sb, "Allow to configure additional generic configuration files for eclipse that will be written out to disk when running eclipse:eclipse. FOr each file you can specify the name and the text content.\n\norg.apache.maven.plugins \nmaven-eclipse-plugin \n\n\n\n.checkstyle \n\n\n\n \n \n \n \n \nInstead of the content you can also define (from version 2.5) an url to download the file :\n\norg.apache.maven.plugins \nmaven-eclipse-plugin \n\n\n\n.checkstyle \nhttp://some.place.org/path/to/file \n \n \n \nor a location :\n\norg.apache.maven.plugins \nmaven-eclipse-plugin \n\n\n\n.checkstyle \n/checkstyle-config.xml \n \n \n \n\n\n\neclipsetest \ncheckstyle-config \n1.0 \n \n \n \n", 3 );
append( sb, "", 0 );
append( sb, "additionalProjectFacets", 2 );
append( sb, "List of eclipse project facets to be added to the default ones.\n\n1.1 \n", 3 );
append( sb, "", 0 );
append( sb, "additionalProjectnatures", 2 );
append( sb, "List of eclipse project natures to be added to the default ones.\n\norg.springframework.ide.eclipse.core.springnature \n \n", 3 );
append( sb, "", 0 );
append( sb, "ajdtVersion (Default: none)", 2 );
append( sb, "The version of AJDT for which configuration files will be generated. The default value is \'1.5\', supported versions are \'none\' (AJDT support disabled), \'1.4\', and \'1.5\'.", 3 );
append( sb, "", 0 );
append( sb, "buildOutputDirectory (Default: ${project.build.outputDirectory})", 2 );
append( sb, "The default output directory", 3 );
append( sb, "", 0 );
append( sb, "buildcommands", 2 );
append( sb, "List of eclipse build commands. By default the org.eclipse.jdt.core.javabuilder builder plus the needed WTP builders are added. If you specify any configuration for this parameter, only those buildcommands specified will be used; the defaults won\'t be added. Use the additionalBuildCommands parameter for that. Configuration example: Old style:\n\norg.eclipse.wst.common.modulecore.ComponentStructuralBuilder \norg.eclipse.jdt.core.javabuilder \norg.eclipse.wst.common.modulecore.ComponentStructuralBuilderDependencyResolver \n \nFor new style, see additionalBuildCommands.", 3 );
append( sb, "", 0 );
append( sb, "classpathContainers", 2 );
append( sb, "List of container classpath entries. By default the org.eclipse.jdt.launching.JRE_CONTAINER classpath container is added. Configuration example:\n\norg.eclipse.jdt.launching.JRE_CONTAINER \norg.eclipse.jst.server.core.container/org.eclipse.jst.server.tomcat.runtimeTarget/Apache\u00a0Tomcat\u00a0v5.5 \norg.eclipse.jst.j2ee.internal.web.container/artifact \n \n", 3 );
append( sb, "", 0 );
append( sb, "downloadJavadocs", 2 );
append( sb, "Enables/disables the downloading of javadoc attachments. Defaults to false. When this flag is true remote repositories are checked for javadocs: in order to avoid repeated check for unavailable javadoc archives, a status cache is mantained. With versions 2.6+ of the plugin to reset this cache run mvn eclipse:remove-cache, or use the forceRecheck option with versions. With older versions delete the file mvn-eclipse-cache.properties in the target directory.", 3 );
append( sb, "", 0 );
append( sb, "downloadSources", 2 );
append( sb, "Enables/disables the downloading of source attachments. Defaults to false. When this flag is true remote repositories are checked for sources: in order to avoid repeated check for unavailable source archives, a status cache is mantained. With versions 2.6+ of the plugin to reset this cache run mvn eclipse:remove-cache, or use the forceRecheck option with versions. With older versions delete the file mvn-eclipse-cache.properties in the target directory.", 3 );
append( sb, "", 0 );
append( sb, "eclipseDownloadSources", 2 );
append( sb, "Deprecated. use downloadSources", 3 );
append( sb, "", 0 );
append( sb, "Enables/disables the downloading of source attachments. Defaults to false. DEPRECATED - use downloadSources", 3 );
append( sb, "", 0 );
append( sb, "eclipseProjectDir", 2 );
append( sb, "Eclipse workspace directory.", 3 );
append( sb, "", 0 );
append( sb, "excludes", 2 );
append( sb, "List of artifact to exclude from eclipse classpath, beeing provided by some eclipse classPathContainer [MECLIPSE-79]", 3 );
append( sb, "", 0 );
append( sb, "forceRecheck", 2 );
append( sb, "Enables/disables the rechecking of the remote repository for downloading source/javadoc attachments. Defaults to false. When this flag is true and the source or javadoc attachment has a status cache to indicate that it is not available, then the remote repository will be rechecked for a source or javadoc attachment and the status cache updated to reflect the new state.", 3 );
append( sb, "", 0 );
append( sb, "generatedResourceDirName (Default: target/generated-resources/rad6)", 2 );
append( sb, "Use this to specify a different generated resources folder than target/generated-resources/rad6. Set to \'none\' to skip this folder generation.", 3 );
append( sb, "", 0 );
append( sb, "limitProjectReferencesToWorkspace (Default: false)", 2 );
append( sb, "Limit the use of project references to the current workspace. No project references will be created to projects in the reactor when they are not available in the workspace.", 3 );
append( sb, "", 0 );
append( sb, "linkedResources", 2 );
append( sb, "A list of links to local files in the system. A configuration like this one in the pom : org.apache.maven.plugins maven-eclipse-plugin src/test/resources/oracle-ds.xml 1 C://jboss/server/default/deploy/oracle-ds.xml will produce in the .project : src/test/resources/oracle-ds.xml 1 C://jboss/server/default/deploy/oracle-ds.xml ", 3 );
append( sb, "", 0 );
append( sb, "manifest (Default: ${basedir}/META-INF/MANIFEST.MF)", 2 );
append( sb, "The relative path of the manifest file", 3 );
append( sb, "", 0 );
append( sb, "packaging", 2 );
append( sb, "The project packaging.", 3 );
append( sb, "", 0 );
append( sb, "pde (Default: false)", 2 );
append( sb, "Is it an PDE project? If yes, the plugin adds the necessary natures and build commands to the .project file. Additionally it copies all libraries to a project local directory and references them instead of referencing the files in the local Maven repository. It also ensured that the \'Bundle-Classpath\' in META-INF/MANIFEST.MF is synchronized.", 3 );
append( sb, "", 0 );
append( sb, "projectNameTemplate", 2 );
append( sb, "Allows configuring the name of the eclipse projects. This property if set wins over addVersionToProjectName and addGroupIdToProjectName You can use [groupId], [artifactId] and [version] variables. eg. [groupId].[artifactId]-[version]", 3 );
append( sb, "", 0 );
append( sb, "projectnatures", 2 );
append( sb, "List of eclipse project natures. By default the org.eclipse.jdt.core.javanature nature plus the needed WTP natures are added. Natures added using this property replace the default list.\n\norg.eclipse.jdt.core.javanature \norg.eclipse.wst.common.modulecore.ModuleCoreNature \n \n", 3 );
append( sb, "", 0 );
append( sb, "skip (Default: false)", 2 );
append( sb, "Skip the operation when true.", 3 );
append( sb, "", 0 );
append( sb, "sourceExcludes", 2 );
append( sb, "List of exclusions to add to the source directories on the classpath. Adds excluding=\'\' to the classpathentry of the eclipse .classpath file. [MECLIPSE-104]", 3 );
append( sb, "", 0 );
append( sb, "sourceIncludes", 2 );
append( sb, "List of inclusions to add to the source directories on the classpath. Adds including=\'\' to the classpathentry of the eclipse .classpath file.\nJava projects will always include \'**/*.java\'\n\nAjdt projects will always include \'**/*.aj\'\n\n[MECLIPSE-104]\n", 3 );
append( sb, "", 0 );
append( sb, "useProjectReferences (Default: true)", 2 );
append( sb, "When set to false, the plugin will not create sub-projects and instead reference those sub-projects using the installed package in the local repository", 3 );
append( sb, "", 0 );
append( sb, "warContextRoot", 2 );
append( sb, "The context root of the webapplication. This parameter is only used when the current project is a war project, else it will be ignored.", 3 );
append( sb, "", 0 );
append( sb, "workspace", 2 );
append( sb, "This eclipse workspace is read and all artifacts detected there will be connected as eclipse projects and will not be linked to the jars in the local repository. Requirement is that it was created with the similar wtp settings as the reactor projects, but the project name template my differ. The pom\'s in the workspace projects may not contain variables in the artefactId, groupId and version tags. If workspace is not defined, then an attempt to locate it by checking up the directory hierarchy will be made.", 3 );
append( sb, "", 0 );
append( sb, "wtpContextName", 2 );
append( sb, "JEE context name of the WTP module. ( ex. WEB context name ).", 3 );
append( sb, "", 0 );
append( sb, "wtpapplicationxml (Default: false)", 2 );
append( sb, "Must the application files be written for ear projects in a separate directory.", 3 );
append( sb, "", 0 );
append( sb, "wtpdefaultserver", 2 );
append( sb, "What WTP defined server to use for deployment informations.", 3 );
append( sb, "", 0 );
append( sb, "wtpmanifest (Default: false)", 2 );
append( sb, "Must the manifest files be written for java projects so that that the jee classpath for wtp is correct.", 3 );
append( sb, "", 0 );
append( sb, "wtpversion (Default: none)", 2 );
append( sb, "The version of WTP for which configuration files will be generated. The default value is \'none\' (don\'t generate WTP configuration), supported versions are \'R7\', \'1.0\', and \'1.5\'", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "rad-clean".equals( goal ) )
{
append( sb, "eclipse:rad-clean", 0 );
append( sb, "Deletes the config files used by Rad-6. the files .j2ee and the file .websettings", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "additionalConfig", 2 );
append( sb, "additional generic configuration files for eclipse", 3 );
append( sb, "", 0 );
append( sb, "basedir", 2 );
append( sb, "The root directory of the project", 3 );
append( sb, "", 0 );
append( sb, "packaging", 2 );
append( sb, "Packaging for the current project.", 3 );
append( sb, "", 0 );
append( sb, "skip (Default: false)", 2 );
append( sb, "Skip the operation when true.", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "remove-cache".equals( goal ) )
{
append( sb, "eclipse:remove-cache", 0 );
append( sb, "Removes the not-available marker files from the repository.", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "to-maven".equals( goal ) )
{
append( sb, "eclipse:to-maven", 0 );
append( sb, "Add eclipse artifacts from an eclipse installation to the local repo. This mojo automatically analize the eclipse directory, copy plugins jars to the local maven repo, and generates appropriate poms. This is the official central repository builder for Eclipse plugins, so it has the necessary default values. For customized repositories see MakeArtifactsMojo Typical usage: mvn eclipse:to-maven -DdeployTo=maven.org::default::scpexe://repo1.maven.org/home/maven/repository-staging/to-ibiblio/eclipse-staging -DeclipseDir=.", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "deployTo", 2 );
append( sb, "Specifies a remote repository to which generated artifacts should be deployed to. If this property is specified, artifacts are also deployed to the remote repo. The format for this parameter is id::layout::url", 3 );
append( sb, "", 0 );
append( sb, "eclipseDir", 2 );
append( sb, "Eclipse installation dir. If not set, a value for this parameter will be asked on the command line.", 3 );
append( sb, "", 0 );
append( sb, "stripQualifier (Default: false)", 2 );
append( sb, "Strip qualifier (fourth token) from the plugin version. Qualifiers are for eclipse plugin the equivalent of timestamped snapshot versions for Maven, but the date is maintained also for released version (e.g. a jar for the release 3.2 can be named org.eclipse.core.filesystem_1.0.0.v20060603.jar. It\'s usually handy to not to include this qualifier when generating maven artifacts for major releases, while it\'s needed when working with eclipse integration/nightly builds.", 3 );
append( sb, "", 0 );
}
}
if ( getLog().isInfoEnabled() )
{
getLog().info( sb.toString() );
}
}
/**
* Repeat a String n times to form a new string.
*
* @param str String to repeat
* @param repeat number of times to repeat str
* @return String with repeated String
* @throws NegativeArraySizeException if repeat < 0
* @throws NullPointerException if str is null
*/
private static String repeat( String str, int repeat )
{
StringBuffer buffer = new StringBuffer( repeat * str.length() );
for ( int i = 0; i < repeat; i++ )
{
buffer.append( str );
}
return buffer.toString();
}
/**
* Append a description to the buffer by respecting the indentSize and lineLength parameters.
* Note: The last character is always a new line.
*
* @param sb The buffer to append the description, not null.
* @param description The description, not null.
* @param indent The base indentation level of each line, must not be negative.
*/
private void append( StringBuffer sb, String description, int indent )
{
for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
{
sb.append( it.next().toString() ).append( '\n' );
}
}
/**
* Splits the specified text into lines of convenient display length.
*
* @param text The text to split into lines, must not be null.
* @param indent The base indentation level of each line, must not be negative.
* @param indentSize The size of each indentation, must not be negative.
* @param lineLength The length of the line, must not be negative.
* @return The sequence of display lines, never null.
* @throws NegativeArraySizeException if indent < 0
*/
private static List toLines( String text, int indent, int indentSize, int lineLength )
{
List lines = new ArrayList();
String ind = repeat( "\t", indent );
String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
for ( int i = 0; i < plainLines.length; i++ )
{
toLines( lines, ind + plainLines[i], indentSize, lineLength );
}
return lines;
}
/**
* Adds the specified line to the output sequence, performing line wrapping if necessary.
*
* @param lines The sequence of display lines, must not be null.
* @param line The line to add, must not be null.
* @param indentSize The size of each indentation, must not be negative.
* @param lineLength The length of the line, must not be negative.
*/
private static void toLines( List lines, String line, int indentSize, int lineLength )
{
int lineIndent = getIndentLevel( line );
StringBuffer buf = new StringBuffer( 256 );
String[] tokens = line.split( " +" );
for ( int i = 0; i < tokens.length; i++ )
{
String token = tokens[i];
if ( i > 0 )
{
if ( buf.length() + token.length() >= lineLength )
{
lines.add( buf.toString() );
buf.setLength( 0 );
buf.append( repeat( " ", lineIndent * indentSize ) );
}
else
{
buf.append( ' ' );
}
}
for ( int j = 0; j < token.length(); j++ )
{
char c = token.charAt( j );
if ( c == '\t' )
{
buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
}
else if ( c == '\u00A0' )
{
buf.append( ' ' );
}
else
{
buf.append( c );
}
}
}
lines.add( buf.toString() );
}
/**
* Gets the indentation level of the specified line.
*
* @param line The line whose indentation level should be retrieved, must not be null.
* @return The indentation level of the line.
*/
private static int getIndentLevel( String line )
{
int level = 0;
for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
{
level++;
}
for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
{
if ( line.charAt( i ) == '\t' )
{
level++;
break;
}
}
return level;
}
}