Coverage Report - org.apache.maven.plugins.jarsigner.HelpMojo
 
Classes in this File Line Coverage Branch Coverage Complexity
HelpMojo
0%
0/159
0%
0/62
4,667
 
 1  
 package org.apache.maven.plugins.jarsigner;
 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-jarsigner-plugin.<br/> Call <pre>  mvn jarsigner:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details.
 12  
  *
 13  
  * @version generated on Sun Jul 19 18:59:39 CEST 2009
 14  
  * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.4.3)
 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-jarsigner-plugin:1.0", 0 );
 68  0
         append( sb, "", 0 );
 69  
 
 70  0
         append( sb, "Maven Jarsigner Plugin 1.0", 0 );
 71  0
         append( sb, "Signs or verifies a project artifact and attachments using jarsigner.", 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 || "help".equals( goal ) )
 81  
         {
 82  0
             append( sb, "jarsigner:help", 0 );
 83  0
             append( sb, "Display help information on maven-jarsigner-plugin.\nCall\n\u00a0\u00a0mvn\u00a0jarsigner:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 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, "detail (Default: false)", 2 );
 91  0
                 append( sb, "If true, display all settable properties for each goal.", 3 );
 92  0
                 append( sb, "", 0 );
 93  
 
 94  0
                 append( sb, "goal", 2 );
 95  0
                 append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
 96  0
                 append( sb, "", 0 );
 97  
 
 98  0
                 append( sb, "lineLength (Default: 80)", 2 );
 99  0
                 append( sb, "The maximum length of a display line, should be positive.", 3 );
 100  0
                 append( sb, "", 0 );
 101  
 
 102  0
                 append( sb, "indentSize (Default: 2)", 2 );
 103  0
                 append( sb, "The number of spaces per indentation level, should be positive.", 3 );
 104  0
                 append( sb, "", 0 );
 105  
             }
 106  
         }
 107  
 
 108  0
         if ( goal == null || goal.length() <= 0 || "sign".equals( goal ) )
 109  
         {
 110  0
             append( sb, "jarsigner:sign", 0 );
 111  0
             append( sb, "Signs a project artifact and attachments using jarsigner.", 1 );
 112  0
             append( sb, "", 0 );
 113  0
             if ( detail )
 114  
             {
 115  0
                 append( sb, "Available parameters:", 1 );
 116  0
                 append( sb, "", 0 );
 117  
 
 118  0
                 append( sb, "alias", 2 );
 119  0
                 append( sb, "See options.", 3 );
 120  0
                 append( sb, "", 0 );
 121  
 
 122  0
                 append( sb, "archive", 2 );
 123  0
                 append( sb, "Archive to process. If set, neither the project artifact nor any attachments are processed.", 3 );
 124  0
                 append( sb, "", 0 );
 125  
 
 126  0
                 append( sb, "arguments", 2 );
 127  0
                 append( sb, "List of additional arguments to append to the jarsigner command line.", 3 );
 128  0
                 append( sb, "", 0 );
 129  
 
 130  0
                 append( sb, "attachments (Default: true)", 2 );
 131  0
                 append( sb, "Controls processing of project attachments.", 3 );
 132  0
                 append( sb, "", 0 );
 133  
 
 134  0
                 append( sb, "keypass", 2 );
 135  0
                 append( sb, "See options.", 3 );
 136  0
                 append( sb, "", 0 );
 137  
 
 138  0
                 append( sb, "keystore", 2 );
 139  0
                 append( sb, "See options.", 3 );
 140  0
                 append( sb, "", 0 );
 141  
 
 142  0
                 append( sb, "maxMemory", 2 );
 143  0
                 append( sb, "The maximum memory available to the JAR signer, e.g. 256M. See -Xmx for more details.", 3 );
 144  0
                 append( sb, "", 0 );
 145  
 
 146  0
                 append( sb, "providerArg", 2 );
 147  0
                 append( sb, "See options.", 3 );
 148  0
                 append( sb, "", 0 );
 149  
 
 150  0
                 append( sb, "providerClass", 2 );
 151  0
                 append( sb, "See options.", 3 );
 152  0
                 append( sb, "", 0 );
 153  
 
 154  0
                 append( sb, "providerName", 2 );
 155  0
                 append( sb, "See options.", 3 );
 156  0
                 append( sb, "", 0 );
 157  
 
 158  0
                 append( sb, "sigfile", 2 );
 159  0
                 append( sb, "See options.", 3 );
 160  0
                 append( sb, "", 0 );
 161  
 
 162  0
                 append( sb, "skip (Default: false)", 2 );
 163  0
                 append( sb, "Set to true to disable the plugin.", 3 );
 164  0
                 append( sb, "", 0 );
 165  
 
 166  0
                 append( sb, "storepass", 2 );
 167  0
                 append( sb, "See options.", 3 );
 168  0
                 append( sb, "", 0 );
 169  
 
 170  0
                 append( sb, "storetype", 2 );
 171  0
                 append( sb, "See options.", 3 );
 172  0
                 append( sb, "", 0 );
 173  
 
 174  0
                 append( sb, "verbose (Default: false)", 2 );
 175  0
                 append( sb, "See options.", 3 );
 176  0
                 append( sb, "", 0 );
 177  
             }
 178  
         }
 179  
 
 180  0
         if ( goal == null || goal.length() <= 0 || "verify".equals( goal ) )
 181  
         {
 182  0
             append( sb, "jarsigner:verify", 0 );
 183  0
             append( sb, "Checks the signatures of a project artifact and attachments using jarsigner.", 1 );
 184  0
             append( sb, "", 0 );
 185  0
             if ( detail )
 186  
             {
 187  0
                 append( sb, "Available parameters:", 1 );
 188  0
                 append( sb, "", 0 );
 189  
 
 190  0
                 append( sb, "archive", 2 );
 191  0
                 append( sb, "Archive to process. If set, neither the project artifact nor any attachments are processed.", 3 );
 192  0
                 append( sb, "", 0 );
 193  
 
 194  0
                 append( sb, "arguments", 2 );
 195  0
                 append( sb, "List of additional arguments to append to the jarsigner command line.", 3 );
 196  0
                 append( sb, "", 0 );
 197  
 
 198  0
                 append( sb, "attachments (Default: true)", 2 );
 199  0
                 append( sb, "Controls processing of project attachments.", 3 );
 200  0
                 append( sb, "", 0 );
 201  
 
 202  0
                 append( sb, "certs (Default: false)", 2 );
 203  0
                 append( sb, "See options.", 3 );
 204  0
                 append( sb, "", 0 );
 205  
 
 206  0
                 append( sb, "maxMemory", 2 );
 207  0
                 append( sb, "The maximum memory available to the JAR signer, e.g. 256M. See -Xmx for more details.", 3 );
 208  0
                 append( sb, "", 0 );
 209  
 
 210  0
                 append( sb, "skip (Default: false)", 2 );
 211  0
                 append( sb, "Set to true to disable the plugin.", 3 );
 212  0
                 append( sb, "", 0 );
 213  
 
 214  0
                 append( sb, "verbose (Default: false)", 2 );
 215  0
                 append( sb, "See options.", 3 );
 216  0
                 append( sb, "", 0 );
 217  
             }
 218  
         }
 219  
 
 220  0
         if ( getLog().isInfoEnabled() )
 221  
         {
 222  0
             getLog().info( sb.toString() );
 223  
         }
 224  0
     }
 225  
 
 226  
     /**
 227  
      * <p>Repeat a String <code>n</code> times to form a new string.</p>
 228  
      *
 229  
      * @param str String to repeat
 230  
      * @param repeat number of times to repeat str
 231  
      * @return String with repeated String
 232  
      * @throws NegativeArraySizeException if <code>repeat < 0</code>
 233  
      * @throws NullPointerException if str is <code>null</code>
 234  
      */
 235  
     private static String repeat( String str, int repeat )
 236  
     {
 237  0
         StringBuffer buffer = new StringBuffer( repeat * str.length() );
 238  
 
 239  0
         for ( int i = 0; i < repeat; i++ )
 240  
         {
 241  0
             buffer.append( str );
 242  
         }
 243  
 
 244  0
         return buffer.toString();
 245  
     }
 246  
 
 247  
     /** 
 248  
      * Append a description to the buffer by respecting the indentSize and lineLength parameters.
 249  
      * <b>Note</b>: The last character is always a new line.
 250  
      * 
 251  
      * @param sb The buffer to append the description, not <code>null</code>.
 252  
      * @param description The description, not <code>null</code>.
 253  
      * @param indent The base indentation level of each line, must not be negative.
 254  
      */
 255  
     private void append( StringBuffer sb, String description, int indent )
 256  
     {
 257  0
         for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
 258  
         {
 259  0
             sb.append( it.next().toString() ).append( '\n' );
 260  
         }
 261  0
     }
 262  
 
 263  
     /** 
 264  
      * Splits the specified text into lines of convenient display length.
 265  
      * 
 266  
      * @param text The text to split into lines, must not be <code>null</code>.
 267  
      * @param indent The base indentation level of each line, must not be negative.
 268  
      * @param indentSize The size of each indentation, must not be negative.
 269  
      * @param lineLength The length of the line, must not be negative.
 270  
      * @return The sequence of display lines, never <code>null</code>.
 271  
      * @throws NegativeArraySizeException if <code>indent < 0</code>
 272  
      */
 273  
     private static List toLines( String text, int indent, int indentSize, int lineLength )
 274  
     {
 275  0
         List lines = new ArrayList();
 276  
 
 277  0
         String ind = repeat( "\t", indent );
 278  0
         String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
 279  0
         for ( int i = 0; i < plainLines.length; i++ )
 280  
         {
 281  0
             toLines( lines, ind + plainLines[i], indentSize, lineLength );
 282  
         }
 283  
 
 284  0
         return lines;
 285  
     }
 286  
 
 287  
     /** 
 288  
      * Adds the specified line to the output sequence, performing line wrapping if necessary.
 289  
      * 
 290  
      * @param lines The sequence of display lines, must not be <code>null</code>.
 291  
      * @param line The line to add, must not be <code>null</code>.
 292  
      * @param indentSize The size of each indentation, must not be negative.
 293  
      * @param lineLength The length of the line, must not be negative.
 294  
      */
 295  
     private static void toLines( List lines, String line, int indentSize, int lineLength )
 296  
     {
 297  0
         int lineIndent = getIndentLevel( line );
 298  0
         StringBuffer buf = new StringBuffer( 256 );
 299  0
         String[] tokens = line.split( " +" );
 300  0
         for ( int i = 0; i < tokens.length; i++ )
 301  
         {
 302  0
             String token = tokens[i];
 303  0
             if ( i > 0 )
 304  
             {
 305  0
                 if ( buf.length() + token.length() >= lineLength )
 306  
                 {
 307  0
                     lines.add( buf.toString() );
 308  0
                     buf.setLength( 0 );
 309  0
                     buf.append( repeat( " ", lineIndent * indentSize ) );
 310  
                 }
 311  
                 else
 312  
                 {
 313  0
                     buf.append( ' ' );
 314  
                 }
 315  
             }
 316  0
             for ( int j = 0; j < token.length(); j++ )
 317  
             {
 318  0
                 char c = token.charAt( j );
 319  0
                 if ( c == '\t' )
 320  
                 {
 321  0
                     buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
 322  
                 }
 323  0
                 else if ( c == '\u00A0' )
 324  
                 {
 325  0
                     buf.append( ' ' );
 326  
                 }
 327  
                 else
 328  
                 {
 329  0
                     buf.append( c );
 330  
                 }
 331  
             }
 332  
         }
 333  0
         lines.add( buf.toString() );
 334  0
     }
 335  
 
 336  
     /** 
 337  
      * Gets the indentation level of the specified line.
 338  
      * 
 339  
      * @param line The line whose indentation level should be retrieved, must not be <code>null</code>.
 340  
      * @return The indentation level of the line.
 341  
      */
 342  
     private static int getIndentLevel( String line )
 343  
     {
 344  0
         int level = 0;
 345  0
         for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
 346  
         {
 347  0
             level++;
 348  
         }
 349  0
         for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
 350  
         {
 351  0
             if ( line.charAt( i ) == '\t' )
 352  
             {
 353  0
                 level++;
 354  0
                 break;
 355  
             }
 356  
         }
 357  0
         return level;
 358  
     }
 359  
 }