Coverage Report - org.boretti.drools.integration.drools4.HelpMojo
 
Classes in this File Line Coverage Branch Coverage Complexity
HelpMojo
0 %
0/149
0 %
0/78
7.5
 
 1  
 package org.boretti.drools.integration.drools4;
 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 drools4-integration-helper-maven-plugin.<br/> Call <pre>  mvn drools4:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details.
 12  
  *
 13  
  * @version generated on Sun Oct 25 10:54:07 CET 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.boretti.drools.integration:drools4-integration-helper-maven-plugin:1.0.1", 0 );
 68  0
         append( sb, "", 0 );
 69  
 
 70  0
         append( sb, "Drools 4 Integration Helper Maven Plugin 1.0.1", 0 );
 71  0
         append( sb, "Helper Plugin for drools in maven", 1 );
 72  0
         append( sb, "", 0 );
 73  
 
 74  0
         if ( goal == null || goal.length() <= 0 )
 75  
         {
 76  0
             append( sb, "This plugin has 5 goals:", 0 );
 77  0
             append( sb, "", 0 );
 78  
         }
 79  
 
 80  0
         if ( goal == null || goal.length() <= 0 || "drools-compile".equals( goal ) )
 81  
         {
 82  0
             append( sb, "drools4:drools-compile", 0 );
 83  0
             append( sb, "This goal compile drools", 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, "compiledExtension", 2 );
 91  0
                 append( sb, "The default extension for compiled drools file", 3 );
 92  0
                 append( sb, "", 0 );
 93  
 
 94  0
                 append( sb, "extension", 2 );
 95  0
                 append( sb, "The default extension for drools file", 3 );
 96  0
                 append( sb, "", 0 );
 97  
 
 98  0
                 append( sb, "inputDirectory", 2 );
 99  0
                 append( sb, "The input directory from where to copy the rules.", 3 );
 100  0
                 append( sb, "", 0 );
 101  
 
 102  0
                 append( sb, "outputDirectory", 2 );
 103  0
                 append( sb, "The output directory into which to copy the rules.", 3 );
 104  0
                 append( sb, "", 0 );
 105  
             }
 106  
         }
 107  
 
 108  0
         if ( goal == null || goal.length() <= 0 || "drools-compile-test".equals( goal ) )
 109  
         {
 110  0
             append( sb, "drools4:drools-compile-test", 0 );
 111  0
             append( sb, "This goal compile drools for test", 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, "compiledExtension", 2 );
 119  0
                 append( sb, "The default extension for compiled drools file", 3 );
 120  0
                 append( sb, "", 0 );
 121  
 
 122  0
                 append( sb, "extension", 2 );
 123  0
                 append( sb, "The default extension for drools file", 3 );
 124  0
                 append( sb, "", 0 );
 125  
 
 126  0
                 append( sb, "inputDirectory", 2 );
 127  0
                 append( sb, "The input directory from where to copy the rules.", 3 );
 128  0
                 append( sb, "", 0 );
 129  
 
 130  0
                 append( sb, "outputDirectory", 2 );
 131  0
                 append( sb, "The output directory into which to copy the rules.", 3 );
 132  0
                 append( sb, "", 0 );
 133  
             }
 134  
         }
 135  
 
 136  0
         if ( goal == null || goal.length() <= 0 || "drools-copy-validate".equals( goal ) )
 137  
         {
 138  0
             append( sb, "drools4:drools-copy-validate", 0 );
 139  0
             append( sb, "This goal copy drools file and validate them", 1 );
 140  0
             append( sb, "", 0 );
 141  0
             if ( detail )
 142  
             {
 143  0
                 append( sb, "Available parameters:", 1 );
 144  0
                 append( sb, "", 0 );
 145  
 
 146  0
                 append( sb, "extension", 2 );
 147  0
                 append( sb, "The default extension for drools file", 3 );
 148  0
                 append( sb, "", 0 );
 149  
 
 150  0
                 append( sb, "inputDirectory", 2 );
 151  0
                 append( sb, "The input directory from where to copy the rules.", 3 );
 152  0
                 append( sb, "", 0 );
 153  
 
 154  0
                 append( sb, "outputDirectory", 2 );
 155  0
                 append( sb, "The output directory into which to copy the rules.", 3 );
 156  0
                 append( sb, "", 0 );
 157  
             }
 158  
         }
 159  
 
 160  0
         if ( goal == null || goal.length() <= 0 || "drools-copy-validate-test".equals( goal ) )
 161  
         {
 162  0
             append( sb, "drools4:drools-copy-validate-test", 0 );
 163  0
             append( sb, "This goal copy drools file and validate them for test", 1 );
 164  0
             append( sb, "", 0 );
 165  0
             if ( detail )
 166  
             {
 167  0
                 append( sb, "Available parameters:", 1 );
 168  0
                 append( sb, "", 0 );
 169  
 
 170  0
                 append( sb, "extension", 2 );
 171  0
                 append( sb, "The default extension for drools file", 3 );
 172  0
                 append( sb, "", 0 );
 173  
 
 174  0
                 append( sb, "inputDirectory", 2 );
 175  0
                 append( sb, "The input directory from where to copy the rules.", 3 );
 176  0
                 append( sb, "", 0 );
 177  
 
 178  0
                 append( sb, "outputDirectory", 2 );
 179  0
                 append( sb, "The output directory into which to copy the rules.", 3 );
 180  0
                 append( sb, "", 0 );
 181  
             }
 182  
         }
 183  
 
 184  0
         if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
 185  
         {
 186  0
             append( sb, "drools4:help", 0 );
 187  0
             append( sb, "Display help information on drools4-integration-helper-maven-plugin.\nCall\n\u00a0\u00a0mvn\u00a0drools4:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 1 );
 188  0
             append( sb, "", 0 );
 189  0
             if ( detail )
 190  
             {
 191  0
                 append( sb, "Available parameters:", 1 );
 192  0
                 append( sb, "", 0 );
 193  
 
 194  0
                 append( sb, "detail (Default: false)", 2 );
 195  0
                 append( sb, "If true, display all settable properties for each goal.", 3 );
 196  0
                 append( sb, "", 0 );
 197  
 
 198  0
                 append( sb, "goal", 2 );
 199  0
                 append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
 200  0
                 append( sb, "", 0 );
 201  
 
 202  0
                 append( sb, "lineLength (Default: 80)", 2 );
 203  0
                 append( sb, "The maximum length of a display line, should be positive.", 3 );
 204  0
                 append( sb, "", 0 );
 205  
 
 206  0
                 append( sb, "indentSize (Default: 2)", 2 );
 207  0
                 append( sb, "The number of spaces per indentation level, should be positive.", 3 );
 208  0
                 append( sb, "", 0 );
 209  
             }
 210  
         }
 211  
 
 212  0
         if ( getLog().isInfoEnabled() )
 213  
         {
 214  0
             getLog().info( sb.toString() );
 215  
         }
 216  0
     }
 217  
 
 218  
     /**
 219  
      * <p>Repeat a String <code>n</code> times to form a new string.</p>
 220  
      *
 221  
      * @param str String to repeat
 222  
      * @param repeat number of times to repeat str
 223  
      * @return String with repeated String
 224  
      * @throws NegativeArraySizeException if <code>repeat < 0</code>
 225  
      * @throws NullPointerException if str is <code>null</code>
 226  
      */
 227  
     private static String repeat( String str, int repeat )
 228  
     {
 229  0
         StringBuffer buffer = new StringBuffer( repeat * str.length() );
 230  
 
 231  0
         for ( int i = 0; i < repeat; i++ )
 232  
         {
 233  0
             buffer.append( str );
 234  
         }
 235  
 
 236  0
         return buffer.toString();
 237  
     }
 238  
 
 239  
     /** 
 240  
      * Append a description to the buffer by respecting the indentSize and lineLength parameters.
 241  
      * <b>Note</b>: The last character is always a new line.
 242  
      * 
 243  
      * @param sb The buffer to append the description, not <code>null</code>.
 244  
      * @param description The description, not <code>null</code>.
 245  
      * @param indent The base indentation level of each line, must not be negative.
 246  
      */
 247  
     private void append( StringBuffer sb, String description, int indent )
 248  
     {
 249  0
         for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
 250  
         {
 251  0
             sb.append( it.next().toString() ).append( '\n' );
 252  
         }
 253  0
     }
 254  
 
 255  
     /** 
 256  
      * Splits the specified text into lines of convenient display length.
 257  
      * 
 258  
      * @param text The text to split into lines, must not be <code>null</code>.
 259  
      * @param indent The base indentation level of each line, must not be negative.
 260  
      * @param indentSize The size of each indentation, must not be negative.
 261  
      * @param lineLength The length of the line, must not be negative.
 262  
      * @return The sequence of display lines, never <code>null</code>.
 263  
      * @throws NegativeArraySizeException if <code>indent < 0</code>
 264  
      */
 265  
     private static List toLines( String text, int indent, int indentSize, int lineLength )
 266  
     {
 267  0
         List lines = new ArrayList();
 268  
 
 269  0
         String ind = repeat( "\t", indent );
 270  0
         String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
 271  0
         for ( int i = 0; i < plainLines.length; i++ )
 272  
         {
 273  0
             toLines( lines, ind + plainLines[i], indentSize, lineLength );
 274  
         }
 275  
 
 276  0
         return lines;
 277  
     }
 278  
 
 279  
     /** 
 280  
      * Adds the specified line to the output sequence, performing line wrapping if necessary.
 281  
      * 
 282  
      * @param lines The sequence of display lines, must not be <code>null</code>.
 283  
      * @param line The line to add, must not be <code>null</code>.
 284  
      * @param indentSize The size of each indentation, must not be negative.
 285  
      * @param lineLength The length of the line, must not be negative.
 286  
      */
 287  
     private static void toLines( List lines, String line, int indentSize, int lineLength )
 288  
     {
 289  0
         int lineIndent = getIndentLevel( line );
 290  0
         StringBuffer buf = new StringBuffer( 256 );
 291  0
         String[] tokens = line.split( " +" );
 292  0
         for ( int i = 0; i < tokens.length; i++ )
 293  
         {
 294  0
             String token = tokens[i];
 295  0
             if ( i > 0 )
 296  
             {
 297  0
                 if ( buf.length() + token.length() >= lineLength )
 298  
                 {
 299  0
                     lines.add( buf.toString() );
 300  0
                     buf.setLength( 0 );
 301  0
                     buf.append( repeat( " ", lineIndent * indentSize ) );
 302  
                 }
 303  
                 else
 304  
                 {
 305  0
                     buf.append( ' ' );
 306  
                 }
 307  
             }
 308  0
             for ( int j = 0; j < token.length(); j++ )
 309  
             {
 310  0
                 char c = token.charAt( j );
 311  0
                 if ( c == '\t' )
 312  
                 {
 313  0
                     buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
 314  
                 }
 315  0
                 else if ( c == '\u00A0' )
 316  
                 {
 317  0
                     buf.append( ' ' );
 318  
                 }
 319  
                 else
 320  
                 {
 321  0
                     buf.append( c );
 322  
                 }
 323  
             }
 324  
         }
 325  0
         lines.add( buf.toString() );
 326  0
     }
 327  
 
 328  
     /** 
 329  
      * Gets the indentation level of the specified line.
 330  
      * 
 331  
      * @param line The line whose indentation level should be retrieved, must not be <code>null</code>.
 332  
      * @return The indentation level of the line.
 333  
      */
 334  
     private static int getIndentLevel( String line )
 335  
     {
 336  0
         int level = 0;
 337  0
         for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
 338  
         {
 339  0
             level++;
 340  
         }
 341  0
         for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
 342  
         {
 343  0
             if ( line.charAt( i ) == '\t' )
 344  
             {
 345  0
                 level++;
 346  0
                 break;
 347  
             }
 348  
         }
 349  0
         return level;
 350  
     }
 351  
 }