package org.apache.maven.plugin.resources;

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

  *

  * @version generated on Wed Sep 30 13:27:10 EDT 2009

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

  * @goal help

  * @requiresProject false

  */

 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-resources-plugin:2.4.1", 0 );

         append( sb, "", 0 );

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

         append( sb, "The Resources Plugin handles the copying of project resources to the output directory. There are two different kinds of resources: main resources and test resources. The difference is that the main resources are the resources associated to the main source code while the test resources are associated to the test source code. Thus, this allows the separation of resources for the main source code and its unit tests.", 1 );

         append( sb, "", 0 );

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

         {

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

             append( sb, "", 0 );

         }

         if ( goal == null || goal.length() <= 0 || "copy-resources".equals( goal ) )

         {

             append( sb, "resources:copy-resources", 0 );

             append( sb, "Copy resources of the configured plugin attribute resources", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

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

                 append( sb, "", 0 );

                 append( sb, "delimiters", 2 );

                 append( sb, "Set of delimiters for expressions to filter within the resources. These delimiters are specified in the form \'beginToken*endToken\'. If no \'*\' is given, the delimiter is assumed to be the same for start and end.\n\nSo, the default filtering delimiters might be specified as:\n\n<delimiters>\n<delimiter>${*}</delimiter>\n<delimiter>@</delimiter>\n</delimiters>\n\nSince the \'@\' delimiter is the same on both ends, we don\'t need to specify \'@*@\' (though we can).\n", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "The character encoding scheme to be applied when filtering resources.", 3 );

                 append( sb, "", 0 );

                 append( sb, "escapeString (Default: ${maven.resources.escapeString})", 2 );

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

                 append( sb, "", 0 );

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

                 append( sb, "Whether to escape backslashes and colons in windows-style paths.", 3 );

                 append( sb, "", 0 );

                 append( sb, "filters", 2 );

                 append( sb, "The list of extra filter properties files to be used along with System properties, project properties, and filter properties files specified in the POM build/filters section, which should be used for the filtering during the current mojo execution.\nNormally, these will be configured from a plugin\'s execution section, to provide a different set of filters for a particular execution. For instance, starting in Maven 2.2.0, you have the option of configuring executions with the id\'s default-resources and default-testResources to supply different configurations for the two different types of resources. By supplying extraFilters configurations, you can separate which filters are used for which type of resource.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "Copy any empty directories included in the Ressources.", 3 );

                 append( sb, "", 0 );

                 append( sb, "nonFilteredFileExtensions", 2 );

                 append( sb, "Additionnal file extensions to not apply filtering (already defined are : jpg, jpeg, gif, bmp, png)", 3 );

                 append( sb, "", 0 );

                 append( sb, "outputDirectory", 2 );

                 append( sb, "The output directory into which to copy the resources.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "Overwrite existing files even if the destination files are newer.", 3 );

                 append( sb, "", 0 );

                 append( sb, "resources", 2 );

                 append( sb, "The list of resources we want to transfer.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "If false, don\'t use the filters specified in the build/filters section of the POM when processing resources in this mojo execution.\nSee also: ResourcesMojo.buildFilters and ResourcesMojo.filters", 3 );

                 append( sb, "", 0 );

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

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

                 append( sb, "", 0 );

             }

         }

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

         {

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

             append( sb, "Display help information on maven-resources-plugin.\nCall\n\u00a0\u00a0mvn\u00a0resources: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, "", 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, "indentSize (Default: 2)", 2 );

                 append( sb, "The number of spaces per indentation level, should be positive.", 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 );

             }

         }

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

         {

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

             append( sb, "Copy resources for the main source code to the main output directory.", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

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

                 append( sb, "", 0 );

                 append( sb, "delimiters", 2 );

                 append( sb, "Set of delimiters for expressions to filter within the resources. These delimiters are specified in the form \'beginToken*endToken\'. If no \'*\' is given, the delimiter is assumed to be the same for start and end.\n\nSo, the default filtering delimiters might be specified as:\n\n<delimiters>\n<delimiter>${*}</delimiter>\n<delimiter>@</delimiter>\n</delimiters>\n\nSince the \'@\' delimiter is the same on both ends, we don\'t need to specify \'@*@\' (though we can).\n", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "The character encoding scheme to be applied when filtering resources.", 3 );

                 append( sb, "", 0 );

                 append( sb, "escapeString (Default: ${maven.resources.escapeString})", 2 );

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

                 append( sb, "", 0 );

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

                 append( sb, "Whether to escape backslashes and colons in windows-style paths.", 3 );

                 append( sb, "", 0 );

                 append( sb, "filters", 2 );

                 append( sb, "The list of extra filter properties files to be used along with System properties, project properties, and filter properties files specified in the POM build/filters section, which should be used for the filtering during the current mojo execution.\nNormally, these will be configured from a plugin\'s execution section, to provide a different set of filters for a particular execution. For instance, starting in Maven 2.2.0, you have the option of configuring executions with the id\'s default-resources and default-testResources to supply different configurations for the two different types of resources. By supplying extraFilters configurations, you can separate which filters are used for which type of resource.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "Copy any empty directories included in the Ressources.", 3 );

                 append( sb, "", 0 );

                 append( sb, "nonFilteredFileExtensions", 2 );

                 append( sb, "Additionnal file extensions to not apply filtering (already defined are : jpg, jpeg, gif, bmp, png)", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "The output directory into which to copy the resources.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "Overwrite existing files even if the destination files are newer.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "If false, don\'t use the filters specified in the build/filters section of the POM when processing resources in this mojo execution.\nSee also: ResourcesMojo.buildFilters and ResourcesMojo.filters", 3 );

                 append( sb, "", 0 );

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

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

                 append( sb, "", 0 );

             }

         }

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

         {

             append( sb, "resources:testResources", 0 );

             append( sb, "Copy resources for the test source code to the test output directory.", 1 );

             append( sb, "", 0 );

             if ( detail )

             {

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

                 append( sb, "", 0 );

                 append( sb, "delimiters", 2 );

                 append( sb, "Set of delimiters for expressions to filter within the resources. These delimiters are specified in the form \'beginToken*endToken\'. If no \'*\' is given, the delimiter is assumed to be the same for start and end.\n\nSo, the default filtering delimiters might be specified as:\n\n<delimiters>\n<delimiter>${*}</delimiter>\n<delimiter>@</delimiter>\n</delimiters>\n\nSince the \'@\' delimiter is the same on both ends, we don\'t need to specify \'@*@\' (though we can).\n", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "The character encoding scheme to be applied when filtering resources.", 3 );

                 append( sb, "", 0 );

                 append( sb, "escapeString (Default: ${maven.resources.escapeString})", 2 );

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

                 append( sb, "", 0 );

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

                 append( sb, "Whether to escape backslashes and colons in windows-style paths.", 3 );

                 append( sb, "", 0 );

                 append( sb, "filters", 2 );

                 append( sb, "The list of extra filter properties files to be used along with System properties, project properties, and filter properties files specified in the POM build/filters section, which should be used for the filtering during the current mojo execution.\nNormally, these will be configured from a plugin\'s execution section, to provide a different set of filters for a particular execution. For instance, starting in Maven 2.2.0, you have the option of configuring executions with the id\'s default-resources and default-testResources to supply different configurations for the two different types of resources. By supplying extraFilters configurations, you can separate which filters are used for which type of resource.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "Copy any empty directories included in the Ressources.", 3 );

                 append( sb, "", 0 );

                 append( sb, "nonFilteredFileExtensions", 2 );

                 append( sb, "Additionnal file extensions to not apply filtering (already defined are : jpg, jpeg, gif, bmp, png)", 3 );

                 append( sb, "", 0 );

                 append( sb, "outputDirectory", 2 );

                 append( sb, "The output directory into which to copy the resources.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "Overwrite existing files even if the destination files are newer.", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "If false, don\'t use the filters specified in the build/filters section of the POM when processing resources in this mojo execution.\nSee also: ResourcesMojo.buildFilters and ResourcesMojo.filters", 3 );

                 append( sb, "", 0 );

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

                 append( sb, "(no description available)", 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;

     }

 }