package org.apache.maven.archetype.mojos;

 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-archetype-plugin.<br/> Call <pre>  mvn archetype:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details.

  *

  * @version generated on Wed Aug 31 21:38:02 CEST 2011

  * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.8)

  * @goal help

  * @requiresProject false

  * @threadSafe

  */

 @SuppressWarnings( "all" )

 public class HelpMojo

     extends AbstractMojo

 {

     /**

      * If <code>true</code>, 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-archetype-plugin:2.1", 0 );

         append( sb, "", 0 );

         append( sb, "Maven Archetype Plugin", 0 );

         append( sb, "Maven Archetype is a set of tools to deal with archetypes, i.e. an abstract representation of a kind of project that can be instantiated into a concrete customized Maven project. An archetype knows which files will be part of the instantiated project and which properties to fill to properly customize the project.", 1 );

         append( sb, "", 0 );

         if ( goal == null || goal.length() <= 0 )

         {

             append( sb, "This plugin has 8 goals:", 0 );

             append( sb, "", 0 );

         }

         if ( goal == null || goal.length() <= 0 || "crawl".equals( goal ) )

         {

             append( sb, "archetype:crawl", 0 );

             append( sb, "Crawl a Maven repository (filesystem, not HTTP) and creates a catalog file.", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

                 append( sb, "Available parameters:", 1 );

                 append( sb, "", 0 );

                 append( sb, "catalogFile", 2 );

                 append( sb, "The archetype\'s catalog to update.", 3 );

                 append( sb, "Expression: ${catalog}", 3 );

                 append( sb, "", 0 );

                 append( sb, "repository (Default: ${settings.localRepository})", 2 );

                 append( sb, "The repository to crawl.", 3 );

                 append( sb, "Expression: ${repository}", 3 );

                 append( sb, "", 0 );

             }

         }

         if ( goal == null || goal.length() <= 0 || "create".equals( goal ) )

         {

             append( sb, "archetype:create", 0 );

             append( sb, "Deprecated. Please use the generate mojo instead.", 1 );

             if ( detail )

             {

                 append( sb, "", 0 );

                 append( sb, "The archetype creation goal looks for an archetype with a given groupId, artifactId, and version and retrieves it from the remote repository. Once the archetype is retrieved, it is then processed against a set of user parameters to create a working Maven project.", 1 );

             }

             append( sb, "", 0 );

             if ( detail )

             {

                 append( sb, "Available parameters:", 1 );

                 append( sb, "", 0 );

                 append( sb, "archetypeArtifactId (Default: maven-archetype-quickstart)", 2 );

                 append( sb, "The Archetype Artifact Id to be used.", 3 );

                 append( sb, "Required: Yes", 3 );

                 append( sb, "Expression: ${archetypeArtifactId}", 3 );

                 append( sb, "", 0 );

                 append( sb, "archetypeGroupId (Default: org.apache.maven.archetypes)", 2 );

                 append( sb, "The Archetype Group Id to be used.", 3 );

                 append( sb, "Required: Yes", 3 );

                 append( sb, "Expression: ${archetypeGroupId}", 3 );

                 append( sb, "", 0 );

                 append( sb, "archetypeVersion (Default: RELEASE)", 2 );

                 append( sb, "The Archetype Version to be used.", 3 );

                 append( sb, "Required: Yes", 3 );

                 append( sb, "Expression: ${archetypeVersion}", 3 );

                 append( sb, "", 0 );

                 append( sb, "artifactId", 2 );

                 append( sb, "The Artifact Id of the project to be build.", 3 );

                 append( sb, "Expression: ${artifactId}", 3 );

                 append( sb, "", 0 );

                 append( sb, "basedir (Default: ${user.dir})", 2 );

                 append( sb, "(no description available)", 3 );

                 append( sb, "Expression: ${basedir}", 3 );

                 append( sb, "", 0 );

                 append( sb, "groupId", 2 );

                 append( sb, "The Group Id of the project to be build.", 3 );

                 append( sb, "Expression: ${groupId}", 3 );

                 append( sb, "", 0 );

                 append( sb, "localRepository", 2 );

                 append( sb, "Maven\'s local repository.", 3 );

                 append( sb, "Required: Yes", 3 );

                 append( sb, "Expression: ${localRepository}", 3 );

                 append( sb, "", 0 );

                 append( sb, "packageName", 2 );

                 append( sb, "The Package Name of the project to be build.", 3 );

                 append( sb, "Expression: ${packageName}", 3 );

                 append( sb, "", 0 );

                 append( sb, "pomRemoteRepositories", 2 );

                 append( sb, "The remote repositories available for discovering dependencies and extensions as indicated by the POM.", 3 );

                 append( sb, "Required: Yes", 3 );

                 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );

                 append( sb, "", 0 );

                 append( sb, "project", 2 );

                 append( sb, "The project to be created an archetype of.", 3 );

                 append( sb, "Expression: ${project}", 3 );

                 append( sb, "", 0 );

                 append( sb, "remoteRepositories", 2 );

                 append( sb, "Other remote repositories available for discovering dependencies and extensions.", 3 );

                 append( sb, "Expression: ${remoteRepositories}", 3 );

                 append( sb, "", 0 );

                 append( sb, "version (Default: 1.0-SNAPSHOT)", 2 );

                 append( sb, "The Version of the project to be build.", 3 );

                 append( sb, "Required: Yes", 3 );

                 append( sb, "Expression: ${version}", 3 );

                 append( sb, "", 0 );

             }

         }

         if ( goal == null || goal.length() <= 0 || "create-from-project".equals( goal ) )

         {

             append( sb, "archetype:create-from-project", 0 );

             append( sb, "Creates an archetype project from the current project, with a basic integration-test.", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

                 append( sb, "Available parameters:", 1 );

                 append( sb, "", 0 );

                 append( sb, "archetypeFilteredExtentions", 2 );

                 append( sb, "File extensions which are checked for project\'s text files (vs binary files).", 3 );

                 append( sb, "Expression: ${archetype.filteredExtentions}", 3 );

                 append( sb, "", 0 );

                 append( sb, "archetypeLanguages", 2 );

                 append( sb, "Directory names which are checked for project\'s sources main package.", 3 );

                 append( sb, "Expression: ${archetype.languages}", 3 );

                 append( sb, "", 0 );

                 append( sb, "archetypePostPhase (Default: package)", 2 );

                 append( sb, "The property telling which phase to call on the generated archetype. Interesting values are: package, integration-test, install and deploy.", 3 );

                 append( sb, "Expression: ${archetype.postPhase}", 3 );

                 append( sb, "", 0 );

                 append( sb, "archetypeRegistryFile", 2 );

                 append( sb, "The location of the registry file.", 3 );

                 append( sb, "Expression: ${user.home}/.m2/archetype.xml", 3 );

                 append( sb, "", 0 );

                 append( sb, "defaultEncoding (Default: UTF-8)", 2 );

                 append( sb, "Velocity templates encoding.", 3 );

                 append( sb, "Expression: ${archetype.encoding}", 3 );

                 append( sb, "", 0 );

                 append( sb, "interactive (Default: false)", 2 );

                 append( sb, "Enable the interactive mode to define the archetype from the project.", 3 );

                 append( sb, "Expression: ${interactive}", 3 );

                 append( sb, "", 0 );

                 append( sb, "keepParent", 2 );

                 append( sb, "POMs in archetype are created with their initial parent. This property is ignored when preserveCData is true.", 3 );

                 append( sb, "Expression: ${archetype.keepParent}", 3 );

                 append( sb, "", 0 );

                 append( sb, "localRepository", 2 );

                 append( sb, "(no description available)", 3 );

                 append( sb, "Expression: ${localRepository}", 3 );

                 append( sb, "", 0 );

                 append( sb, "outputDirectory", 2 );

                 append( sb, "The directory where the archetype should be created.", 3 );

                 append( sb, "Expression: ${project.build.directory}/generated-sources/archetype", 3 );

                 append( sb, "", 0 );

                 append( sb, "packageName", 2 );

                 append( sb, "(no description available)", 3 );

                 append( sb, "Expression: ${packageName}", 3 );

                 append( sb, "", 0 );

                 append( sb, "partialArchetype", 2 );

                 append( sb, "Create a partial archetype.", 3 );

                 append( sb, "Expression: ${archetype.partialArchetype}", 3 );

                 append( sb, "", 0 );

                 append( sb, "preserveCData", 2 );

                 append( sb, "Create pom\'s velocity templates with CDATA preservation. This uses the String.replaceAll() method and risks to have some overly replacement capabilities (beware of \'1.0\' value).", 3 );

                 append( sb, "Expression: ${archetype.preserveCData}", 3 );

                 append( sb, "", 0 );

                 append( sb, "propertyFile", 2 );

                 append( sb, "The property file that holds the plugin configuration.", 3 );

                 append( sb, "Expression: ${archetype.properties}", 3 );

                 append( sb, "", 0 );

                 append( sb, "testMode", 2 );

                 append( sb, "(no description available)", 3 );

                 append( sb, "Expression: ${testMode}", 3 );

                 append( sb, "", 0 );

             }

         }

         if ( goal == null || goal.length() <= 0 || "generate".equals( goal ) )

         {

             append( sb, "archetype:generate", 0 );

             append( sb, "Generates a new project from an archetype, or updated the actual project if using a partial archetype. If the project is fully generated, it is generated in a directory corresponding to its artifactId. If the project is updated with a partial archetype, it is done in the current directory.", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

                 append( sb, "Available parameters:", 1 );

                 append( sb, "", 0 );

                 append( sb, "archetypeArtifactId", 2 );

                 append( sb, "The archetype\'s artifactId.", 3 );

                 append( sb, "Expression: ${archetypeArtifactId}", 3 );

                 append( sb, "", 0 );

                 append( sb, "archetypeCatalog (Default: remote,local)", 2 );

                 append( sb, "The archetype catalogs to use to build a list and let the user choose from. It is a comma separated list of catalogs. Catalogs use following schemes:\n-\t\'file://...\' with archetype-catalog.xml automatically appended when pointing to a directory\n-\t\'http://...\' or \'https://...\' with archetype-catalog.xml always appended\n-\t\'local\' which is the shortcut for \'file://~/.m2/archetype-catalog.xml\'\n-\t\'remote\' which is the shortcut for Maven Central repository, ie \'http://repo1.maven.org/maven2\'\n-\t\'internal\' which is an internal catalog\nSince 2.0-alpha-5, default value is no longer internal,local but remote,local. If Maven Central repository catalog file is empty, internal catalog is used instead.", 3 );

                 append( sb, "Expression: ${archetypeCatalog}", 3 );

                 append( sb, "", 0 );

                 append( sb, "archetypeGroupId", 2 );

                 append( sb, "The archetype\'s groupId.", 3 );

                 append( sb, "Expression: ${archetypeGroupId}", 3 );

                 append( sb, "", 0 );

                 append( sb, "archetypeRepository", 2 );

                 append( sb, "The archetype\'s repository.", 3 );

                 append( sb, "Expression: ${archetypeRepository}", 3 );

                 append( sb, "", 0 );

                 append( sb, "archetypeVersion", 2 );

                 append( sb, "The archetype\'s version.", 3 );

                 append( sb, "Expression: ${archetypeVersion}", 3 );

                 append( sb, "", 0 );

                 append( sb, "basedir", 2 );

                 append( sb, "(no description available)", 3 );

                 append( sb, "Expression: ${basedir}", 3 );

                 append( sb, "", 0 );

                 append( sb, "filter", 2 );

                 append( sb, "Applying some filter on displayed archetypes list: format is artifactId or groupId:artifactId.\n-\torg.apache: -> displays all archetypes which contain org.apache in groupId\n-\t:jee or jee -> displays all archetypes which contain jee in artifactId\n-\torg.apache:jee -> displays all archetypes which contain org.apache in groupId AND jee in artifactId\n", 3 );

                 append( sb, "Expression: ${filter}", 3 );

                 append( sb, "", 0 );

                 append( sb, "goals", 2 );

                 append( sb, "Additional goals to immediately run on the project created from the archetype.", 3 );

                 append( sb, "Expression: ${goals}", 3 );

                 append( sb, "", 0 );

                 append( sb, "interactiveMode (Default: ${settings.interactiveMode})", 2 );

                 append( sb, "User settings use to check the interactiveMode.", 3 );

                 append( sb, "Required: Yes", 3 );

                 append( sb, "Expression: ${interactiveMode}", 3 );

                 append( sb, "", 0 );

             }

         }

         if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )

         {

             append( sb, "archetype:help", 0 );

             append( sb, "Display help information on maven-archetype-plugin.\nCall\n\u00a0\u00a0mvn\u00a0archetype:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\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, "Expression: ${detail}", 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, "Expression: ${goal}", 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, "Expression: ${indentSize}", 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, "Expression: ${lineLength}", 3 );

                 append( sb, "", 0 );

             }

         }

         if ( goal == null || goal.length() <= 0 || "integration-test".equals( goal ) )

         {

             append( sb, "archetype:integration-test", 0 );

             append( sb, "Execute the archetype integration tests, consisting in generating projects from the current archetype and optionally comparing generated projects with reference copy.\n\nEach IT consists of a sub-directory in src/test/resources/projects containing:\n\n-\ta goal.txt file, containing a list of goals to run against the generated project (can be empty, content ignored before maven-archetype-plugin 2.1),\n-\tan archetype.properties file, containing properties for project generation,\n-\tan optional reference/ directory containing a reference copy of the expected project created from the IT.\nNotice that it is expected to be run as part as of a build after the package phase and not directly as a goal from CLI.", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

                 append( sb, "Available parameters:", 1 );

                 append( sb, "", 0 );

             }

         }

         if ( goal == null || goal.length() <= 0 || "jar".equals( goal ) )

         {

             append( sb, "archetype:jar", 0 );

             append( sb, "Build a JAR from the current Archetype project.", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

                 append( sb, "Available parameters:", 1 );

                 append( sb, "", 0 );

                 append( sb, "archetypeDirectory", 2 );

                 append( sb, "Directory containing the classes.", 3 );

                 append( sb, "Required: Yes", 3 );

                 append( sb, "Expression: ${project.build.outputDirectory}", 3 );

                 append( sb, "", 0 );

                 append( sb, "finalName", 2 );

                 append( sb, "Name of the generated JAR.", 3 );

                 append( sb, "Required: Yes", 3 );

                 append( sb, "Expression: ${project.build.finalName}", 3 );

                 append( sb, "", 0 );

                 append( sb, "outputDirectory", 2 );

                 append( sb, "Directory containing the generated JAR.", 3 );

                 append( sb, "Required: Yes", 3 );

                 append( sb, "Expression: ${project.build.directory}", 3 );

                 append( sb, "", 0 );

             }

         }

         if ( goal == null || goal.length() <= 0 || "update-local-catalog".equals( goal ) )

         {

             append( sb, "archetype:update-local-catalog", 0 );

             append( sb, "Updates the local catalog", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

                 append( sb, "Available parameters:", 1 );

                 append( sb, "", 0 );

             }

         }

         if ( getLog().isInfoEnabled() )

         {

             getLog().info( sb.toString() );

         }

     }

     /**

      * <p>Repeat a String <code>n</code> times to form a new string.</p>

      *

      * @param str String to repeat

      * @param repeat number of times to repeat str

      * @return String with repeated String

      * @throws NegativeArraySizeException if <code>repeat < 0</code>

      * @throws NullPointerException if str is <code>null</code>

      */

     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.

      * <b>Note</b>: The last character is always a new line.

      * 

      * @param sb The buffer to append the description, not <code>null</code>.

      * @param description The description, not <code>null</code>.

      * @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 <code>null</code>.

      * @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 <code>null</code>.

      * @throws NegativeArraySizeException if <code>indent < 0</code>

      */

     private static List toLines( String text, int indent, int indentSize, int lineLength )

     {

         List<String> lines = new ArrayList<String>();

         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 <code>null</code>.

      * @param line The line to add, must not be <code>null</code>.

      * @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<String> 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 <code>null</code>.

      * @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;

     }

 }