Coverage Report - org.apache.maven.plugin.ant.HelpMojo
 
Classes in this File Line Coverage Branch Coverage Complexity
HelpMojo
0%
0/99
0%
0/62
6,167
 
 1   
 package org.apache.maven.plugin.ant;
 2   
 
 3   
 import java.util.ArrayList;
 4   
 import java.util.Iterator;
 5   
 import java.util.List;
 6   
 
 7   
 import org.apache.maven.plugin.AbstractMojo;
 8   
 import org.apache.maven.plugin.MojoExecutionException;
 9   
 
 10   
 /**
 11   
  * Display help information on maven-ant-plugin.<br/> Call <pre>  mvn ant:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details.
 12   
  *
 13   
  * @version generated on Sat Nov 07 15:37:38 CET 2009
 14   
  * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.5.1)
 15   
  * @goal help
 16   
  * @requiresProject false
 17   
  */
 18  0 
 public class HelpMojo
 19   
     extends AbstractMojo
 20   
 {
 21   
     /**
 22   
      * If <code>true</code>, display all settable properties for each goal.
 23   
      *
 24   
      * @parameter expression="${detail}" default-value="false"
 25   
      */
 26   
     private boolean detail;
 27   
 
 28   
     /**
 29   
      * The name of the goal for which to show help. If unspecified, all goals will be displayed.
 30   
      *
 31   
      * @parameter expression="${goal}"
 32   
      */
 33   
     private java.lang.String goal;
 34   
 
 35   
     /**
 36   
      * The maximum length of a display line, should be positive.
 37   
      *
 38   
      * @parameter expression="${lineLength}" default-value="80"
 39   
      */
 40   
     private int lineLength;
 41   
 
 42   
     /**
 43   
      * The number of spaces per indentation level, should be positive.
 44   
      *
 45   
      * @parameter expression="${indentSize}" default-value="2"
 46   
      */
 47   
     private int indentSize;
 48   
 
 49   
 
 50   
     /** {@inheritDoc} */
 51   
     public void execute()
 52   
         throws MojoExecutionException
 53   
     {
 54  0 
         if ( lineLength <= 0 )
 55   
         {
 56  0 
             getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." );
 57  0 
             lineLength = 80;
 58   
         }
 59  0 
         if ( indentSize <= 0 )
 60   
         {
 61  0 
             getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." );
 62  0 
             indentSize = 2;
 63   
         }
 64   
 
 65  0 
         StringBuffer sb = new StringBuffer();
 66   
 
 67  0 
         append( sb, "org.apache.maven.plugins:maven-ant-plugin:2.3", 0 );
 68  0 
         append( sb, "", 0 );
 69   
 
 70  0 
         append( sb, "Maven Ant Plugin", 0 );
 71  0 
         append( sb, "Generates an Ant build file from a POM.", 1 );
 72  0 
         append( sb, "", 0 );
 73   
 
 74  0 
         if ( goal == null || goal.length() <= 0 )
 75   
         {
 76  0 
             append( sb, "This plugin has 3 goals:", 0 );
 77  0 
             append( sb, "", 0 );
 78   
         }
 79   
 
 80  0 
         if ( goal == null || goal.length() <= 0 || "ant".equals( goal ) )
 81   
         {
 82  0 
             append( sb, "ant:ant", 0 );
 83  0 
             append( sb, "Generate Ant build files.", 1 );
 84  0 
             append( sb, "", 0 );
 85  0 
             if ( detail )
 86   
             {
 87  0 
                 append( sb, "Available parameters:", 1 );
 88  0 
                 append( sb, "", 0 );
 89   
 
 90  0 
                 append( sb, "overwrite (Default: false)", 2 );
 91  0 
                 append( sb, "Whether or not to overwrite the build.xml file.", 3 );
 92  0 
                 append( sb, "", 0 );
 93   
             }
 94   
         }
 95   
 
 96  0 
         if ( goal == null || goal.length() <= 0 || "clean".equals( goal ) )
 97   
         {
 98  0 
             append( sb, "ant:clean", 0 );
 99  0 
             append( sb, "Clean all Ant build files.", 1 );
 100  0 
             append( sb, "", 0 );
 101  0 
             if ( detail )
 102   
             {
 103  0 
                 append( sb, "Available parameters:", 1 );
 104  0 
                 append( sb, "", 0 );
 105   
 
 106  0 
                 append( sb, "deleteCustomFiles (Default: false)", 2 );
 107  0 
                 append( sb, "Forcing the deletion of the custom build.xml.", 3 );
 108  0 
                 append( sb, "", 0 );
 109   
             }
 110   
         }
 111   
 
 112  0 
         if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
 113   
         {
 114  0 
             append( sb, "ant:help", 0 );
 115  0 
             append( sb, "Display help information on maven-ant-plugin.\nCall\n\u00a0\u00a0mvn\u00a0ant:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 1 );
 116  0 
             append( sb, "", 0 );
 117  0 
             if ( detail )
 118   
             {
 119  0 
                 append( sb, "Available parameters:", 1 );
 120  0 
                 append( sb, "", 0 );
 121   
 
 122  0 
                 append( sb, "detail (Default: false)", 2 );
 123  0 
                 append( sb, "If true, display all settable properties for each goal.", 3 );
 124  0 
                 append( sb, "", 0 );
 125   
 
 126  0 
                 append( sb, "goal", 2 );
 127  0 
                 append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
 128  0 
                 append( sb, "", 0 );
 129   
 
 130  0 
                 append( sb, "indentSize (Default: 2)", 2 );
 131  0 
                 append( sb, "The number of spaces per indentation level, should be positive.", 3 );
 132  0 
                 append( sb, "", 0 );
 133   
 
 134  0 
                 append( sb, "lineLength (Default: 80)", 2 );
 135  0 
                 append( sb, "The maximum length of a display line, should be positive.", 3 );
 136  0 
                 append( sb, "", 0 );
 137   
             }
 138   
         }
 139   
 
 140  0 
         if ( getLog().isInfoEnabled() )
 141   
         {
 142  0 
             getLog().info( sb.toString() );
 143   
         }
 144  0 
     }
 145   
 
 146   
     /**
 147   
      * <p>Repeat a String <code>n</code> times to form a new string.</p>
 148   
      *
 149   
      * @param str String to repeat
 150   
      * @param repeat number of times to repeat str
 151   
      * @return String with repeated String
 152   
      * @throws NegativeArraySizeException if <code>repeat < 0</code>
 153   
      * @throws NullPointerException if str is <code>null</code>
 154   
      */
 155   
     private static String repeat( String str, int repeat )
 156   
     {
 157  0 
         StringBuffer buffer = new StringBuffer( repeat * str.length() );
 158   
 
 159  0 
         for ( int i = 0; i < repeat; i++ )
 160   
         {
 161  0 
             buffer.append( str );
 162   
         }
 163   
 
 164  0 
         return buffer.toString();
 165   
     }
 166   
 
 167   
     /**
 168   
      * Append a description to the buffer by respecting the indentSize and lineLength parameters.
 169   
      * <b>Note</b>: The last character is always a new line.
 170   
      *
 171   
      * @param sb The buffer to append the description, not <code>null</code>.
 172   
      * @param description The description, not <code>null</code>.
 173   
      * @param indent The base indentation level of each line, must not be negative.
 174   
      */
 175   
     private void append( StringBuffer sb, String description, int indent )
 176   
     {
 177  0 
         for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
 178   
         {
 179  0 
             sb.append( it.next().toString() ).append( '\n' );
 180   
         }
 181  0 
     }
 182   
 
 183   
     /**
 184   
      * Splits the specified text into lines of convenient display length.
 185   
      *
 186   
      * @param text The text to split into lines, must not be <code>null</code>.
 187   
      * @param indent The base indentation level of each line, must not be negative.
 188   
      * @param indentSize The size of each indentation, must not be negative.
 189   
      * @param lineLength The length of the line, must not be negative.
 190   
      * @return The sequence of display lines, never <code>null</code>.
 191   
      * @throws NegativeArraySizeException if <code>indent < 0</code>
 192   
      */
 193   
     private static List toLines( String text, int indent, int indentSize, int lineLength )
 194   
     {
 195  0 
         List lines = new ArrayList();
 196   
 
 197  0 
         String ind = repeat( "\t", indent );
 198  0 
         String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
 199  0 
         for ( int i = 0; i < plainLines.length; i++ )
 200   
         {
 201  0 
             toLines( lines, ind + plainLines[i], indentSize, lineLength );
 202   
         }
 203   
 
 204  0 
         return lines;
 205   
     }
 206   
 
 207   
     /**
 208   
      * Adds the specified line to the output sequence, performing line wrapping if necessary.
 209   
      *
 210   
      * @param lines The sequence of display lines, must not be <code>null</code>.
 211   
      * @param line The line to add, must not be <code>null</code>.
 212   
      * @param indentSize The size of each indentation, must not be negative.
 213   
      * @param lineLength The length of the line, must not be negative.
 214   
      */
 215   
     private static void toLines( List lines, String line, int indentSize, int lineLength )
 216   
     {
 217  0 
         int lineIndent = getIndentLevel( line );
 218  0 
         StringBuffer buf = new StringBuffer( 256 );
 219  0 
         String[] tokens = line.split( " +" );
 220  0 
         for ( int i = 0; i < tokens.length; i++ )
 221   
         {
 222  0 
             String token = tokens[i];
 223  0 
             if ( i > 0 )
 224   
             {
 225  0 
                 if ( buf.length() + token.length() >= lineLength )
 226   
                 {
 227  0 
                     lines.add( buf.toString() );
 228  0 
                     buf.setLength( 0 );
 229  0 
                     buf.append( repeat( " ", lineIndent * indentSize ) );
 230   
                 }
 231   
                 else
 232   
                 {
 233  0 
                     buf.append( ' ' );
 234   
                 }
 235   
             }
 236  0 
             for ( int j = 0; j < token.length(); j++ )
 237   
             {
 238  0 
                 char c = token.charAt( j );
 239  0 
                 if ( c == '\t' )
 240   
                 {
 241  0 
                     buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
 242   
                 }
 243  0 
                 else if ( c == '\u00A0' )
 244   
                 {
 245  0 
                     buf.append( ' ' );
 246   
                 }
 247   
                 else
 248   
                 {
 249  0 
                     buf.append( c );
 250   
                 }
 251   
             }
 252   
         }
 253  0 
         lines.add( buf.toString() );
 254  0 
     }
 255   
 
 256   
     /**
 257   
      * Gets the indentation level of the specified line.
 258   
      *
 259   
      * @param line The line whose indentation level should be retrieved, must not be <code>null</code>.
 260   
      * @return The indentation level of the line.
 261   
      */
 262   
     private static int getIndentLevel( String line )
 263   
     {
 264  0 
         int level = 0;
 265  0 
         for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
 266   
         {
 267  0 
             level++;
 268   
         }
 269  0 
         for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
 270   
         {
 271  0 
             if ( line.charAt( i ) == '\t' )
 272   
             {
 273  0 
                 level++;
 274  0 
                 break;
 275   
             }
 276   
         }
 277  0 
         return level;
 278   
     }
 279   
 }
Report generated by Cobertura 1.9.2 on 07.11.09 15:38.