package org.apache.maven.plugin.ear;

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

  *

  * @version generated on Mon Jun 06 10:03:22 CEST 2011

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

  * @goal help

  * @requiresProject false

  * @threadSafe

  */

 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-ear-plugin:2.6", 0 );

         append( sb, "", 0 );

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

         append( sb, "Generates a J2EE Enterprise Archive (EAR) file.", 1 );

         append( sb, "", 0 );

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

         {

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

             append( sb, "", 0 );

         }

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

         {

             append( sb, "ear:ear", 0 );

             append( sb, "Builds J2EE Enterprise Archive (EAR) files.", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

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

                 append( sb, "", 0 );

                 append( sb, "applicationXml", 2 );

                 append( sb, "The location of a custom application.xml file to be used within the ear file.", 3 );

                 append( sb, "", 0 );

                 append( sb, "archive", 2 );

                 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );

                 append( sb, "", 0 );

                 append( sb, "artifactTypeMappings", 2 );

                 append( sb, "The artifact type mappings.", 3 );

                 append( sb, "", 0 );

                 append( sb, "classifier", 2 );

                 append( sb, "Classifier to add to the artifact generated. If given, the artifact will be an attachment instead.", 3 );

                 append( sb, "", 0 );

                 append( sb, "defaultLibBundleDir", 2 );

                 append( sb, "The default bundle dir for libraries.", 3 );

                 append( sb, "", 0 );

                 append( sb, "earSourceDirectory (Default: ${basedir}/src/main/application)", 2 );

                 append( sb, "Single directory for extra files to include in the EAR.", 3 );

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

                 append( sb, "", 0 );

                 append( sb, "earSourceExcludes", 2 );

                 append( sb, "The comma separated list of tokens to exclude from the EAR.", 3 );

                 append( sb, "", 0 );

                 append( sb, "earSourceIncludes (Default: **)", 2 );

                 append( sb, "The comma separated list of tokens to include in the EAR.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "Character encoding for the auto-generated deployment file(s).", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "To escape interpolated value with windows path c:\\foo\\bar will be replaced with c:\\\\foo\\\\bar", 3 );

                 append( sb, "Expression: ${maven.ear.escapedBackslashesInFilePath}", 3 );

                 append( sb, "", 0 );

                 append( sb, "escapeString", 2 );

                 append( sb, "Expression preceded with the String won\'t be interpolated \\${foo} will be replaced with ${foo}", 3 );

                 append( sb, "Expression: ${maven.ear.escapeString}", 3 );

                 append( sb, "", 0 );

                 append( sb, "fileNameMapping", 2 );

                 append( sb, "The file name mapping to use for all dependencies included in the EAR file.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "Specify that the ear sources should be filtered.", 3 );

                 append( sb, "", 0 );

                 append( sb, "filters", 2 );

                 append( sb, "Filters (property files) to include during the interpolation of the pom.xml.", 3 );

                 append( sb, "", 0 );

                 append( sb, "finalName (Default: ${project.build.finalName})", 2 );

                 append( sb, "The name of the EAR file to generate.", 3 );

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

                 append( sb, "", 0 );

                 append( sb, "generatedDescriptorLocation (Default: ${project.build.directory})", 2 );

                 append( sb, "Directory where the deployment descriptor file(s) will be auto-generated.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "Should libraries be added in application.xml", 3 );

                 append( sb, "", 0 );

                 append( sb, "jboss", 2 );

                 append( sb, "The JBoss specific configuration.", 3 );

                 append( sb, "", 0 );

                 append( sb, "mainArtifactId", 2 );

                 append( sb, "The id to use to define the main artifact (e.g. the artifact without a classifier) when there is multiple candidates.", 3 );

                 append( sb, "", 0 );

                 append( sb, "manifestFile", 2 );

                 append( sb, "The location of the manifest file to be used within the ear file. If not value if specified, the default location in the workDirectory is taken. If the file does not exist, a manifest will be generated automatically.", 3 );

                 append( sb, "", 0 );

                 append( sb, "modules", 2 );

                 append( sb, "The ear modules configuration.", 3 );

                 append( sb, "", 0 );

                 append( sb, "nonFilteredFileExtensions", 2 );

                 append( sb, "A list of file extensions that should not be filtered if filtering is enabled.", 3 );

                 append( sb, "", 0 );

                 append( sb, "outputDirectory (Default: ${project.build.directory})", 2 );

                 append( sb, "The directory for the generated EAR.", 3 );

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

                 append( sb, "", 0 );

                 append( sb, "resourcesDir", 2 );

                 append( sb, "Deprecated. please use earSourceDirectory instead", 3 );

                 append( sb, "", 0 );

                 append( sb, "The directory to get the resources from.", 3 );

                 append( sb, "", 0 );

                 append( sb, "unpackTypes", 2 );

                 append( sb, "The comma separated list of artifact\'s type(s) to unpack by default.", 3 );

                 append( sb, "", 0 );

                 append( sb, "version (Default: 1.3)", 2 );

                 append( sb, "The version of the application.xml to generate. Valid values are 1.3, 1.4, 5 and 6.", 3 );

                 append( sb, "", 0 );

                 append( sb, "workDirectory (Default: ${project.build.directory}/${project.build.finalName})", 2 );

                 append( sb, "Directory that resources are copied to during the build.", 3 );

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

                 append( sb, "", 0 );

             }

         }

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

         {

             append( sb, "ear:generate-application-xml", 0 );

             append( sb, "A Mojo that generates the EAR deployment descriptor file(s).", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

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

                 append( sb, "", 0 );

                 append( sb, "applicationName", 2 );

                 append( sb, "Application name of the application to be used when the application.xml file is auto-generated. Since JavaEE6.", 3 );

                 append( sb, "", 0 );

                 append( sb, "artifactTypeMappings", 2 );

                 append( sb, "The artifact type mappings.", 3 );

                 append( sb, "", 0 );

                 append( sb, "defaultLibBundleDir", 2 );

                 append( sb, "The default bundle dir for libraries.", 3 );

                 append( sb, "", 0 );

                 append( sb, "description (Default: ${project.description})", 2 );

                 append( sb, "Description of the application to be used when the application.xml file is auto-generated.", 3 );

                 append( sb, "", 0 );

                 append( sb, "displayName (Default: ${project.artifactId})", 2 );

                 append( sb, "Display name of the application to be used when the application.xml file is auto-generated.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "Character encoding for the auto-generated deployment file(s).", 3 );

                 append( sb, "", 0 );

                 append( sb, "fileNameMapping", 2 );

                 append( sb, "The file name mapping to use for all dependencies included in the EAR file.", 3 );

                 append( sb, "", 0 );

                 append( sb, "generateApplicationXml (Default: true)", 2 );

                 append( sb, "Whether the application.xml should be generated or not.", 3 );

                 append( sb, "", 0 );

                 append( sb, "generatedDescriptorLocation (Default: ${project.build.directory})", 2 );

                 append( sb, "Directory where the deployment descriptor file(s) will be auto-generated.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "Whether a module ID should be generated if none is specified.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "Should libraries be added in application.xml", 3 );

                 append( sb, "", 0 );

                 append( sb, "initializeInOrder", 2 );

                 append( sb, "Defines the value of the initialize in order element to be used when the application.xml file is auto-generated. When set to true, modules must be initialized in the order they\'re listed in this deployment descriptor, with the exception of application client modules, which can be initialized in any order. If initialize-in-order is not set or set to false, the order of initialization is unspecified and may be product-dependent. Since JavaEE6.", 3 );

                 append( sb, "", 0 );

                 append( sb, "jboss", 2 );

                 append( sb, "The JBoss specific configuration.", 3 );

                 append( sb, "", 0 );

                 append( sb, "mainArtifactId", 2 );

                 append( sb, "The id to use to define the main artifact (e.g. the artifact without a classifier) when there is multiple candidates.", 3 );

                 append( sb, "", 0 );

                 append( sb, "modules", 2 );

                 append( sb, "The ear modules configuration.", 3 );

                 append( sb, "", 0 );

                 append( sb, "security", 2 );

                 append( sb, "The security-roles to be added to the auto-generated application.xml file.", 3 );

                 append( sb, "", 0 );

                 append( sb, "version (Default: 1.3)", 2 );

                 append( sb, "The version of the application.xml to generate. Valid values are 1.3, 1.4, 5 and 6.", 3 );

                 append( sb, "", 0 );

                 append( sb, "workDirectory (Default: ${project.build.directory}/${project.build.finalName})", 2 );

                 append( sb, "Directory that resources are copied to during the build.", 3 );

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

                 append( sb, "", 0 );

             }

         }

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

         {

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

             append( sb, "Display help information on maven-ear-plugin.\nCall\n\u00a0\u00a0mvn\u00a0ear: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 ( 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 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 <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 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;

     }

 }