Coverage Report - org.apache.maven.plugin.toolchain.HelpMojo
 
Classes in this File Line Coverage Branch Coverage Complexity
HelpMojo
0%
0/89
0%
0/54
4.333
 
 1   
 package org.apache.maven.plugin.toolchain;
 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-toolchains-plugin.<br/> Call <pre>  mvn toolchains:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details.
 12   
  *
 13   
  * @version generated on Thu Oct 29 15:03:00 GMT 2009
 14   
  * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.5)
 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-toolchains-plugin:1.0", 0 );
 68  0 
         append( sb, "", 0 );
 69   
 
 70  0 
         append( sb, "Maven Toolchains Plugin", 0 );
 71  0 
         append( sb, "Maven Plugins", 1 );
 72  0 
         append( sb, "", 0 );
 73   
 
 74  0 
         if ( goal == null || goal.length() <= 0 )
 75   
         {
 76  0 
             append( sb, "This plugin has 2 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, "toolchains:help", 0 );
 83  0 
             append( sb, "Display help information on maven-toolchains-plugin.\nCall\n\u00a0\u00a0mvn\u00a0toolchains: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, "indentSize (Default: 2)", 2 );
 99  0 
                 append( sb, "The number of spaces per indentation level, should be positive.", 3 );
 100  0 
                 append( sb, "", 0 );
 101   
 
 102  0 
                 append( sb, "lineLength (Default: 80)", 2 );
 103  0 
                 append( sb, "The maximum length of a display line, should be positive.", 3 );
 104  0 
                 append( sb, "", 0 );
 105   
             }
 106   
         }
 107   
 
 108  0 
         if ( goal == null || goal.length() <= 0 || "toolchain".equals( goal ) )
 109   
         {
 110  0 
             append( sb, "toolchains:toolchain", 0 );
 111  0 
             append( sb, "(no description available)", 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, "toolchains", 2 );
 119  0 
                 append( sb, "(no description available)", 3 );
 120  0 
                 append( sb, "", 0 );
 121   
             }
 122   
         }
 123   
 
 124  0 
         if ( getLog().isInfoEnabled() )
 125   
         {
 126  0 
             getLog().info( sb.toString() );
 127   
         }
 128  0 
     }
 129   
 
 130   
     /**
 131   
      * <p>Repeat a String <code>n</code> times to form a new string.</p>
 132   
      *
 133   
      * @param str String to repeat
 134   
      * @param repeat number of times to repeat str
 135   
      * @return String with repeated String
 136   
      * @throws NegativeArraySizeException if <code>repeat < 0</code>
 137   
      * @throws NullPointerException if str is <code>null</code>
 138   
      */
 139   
     private static String repeat( String str, int repeat )
 140   
     {
 141  0 
         StringBuffer buffer = new StringBuffer( repeat * str.length() );
 142   
 
 143  0 
         for ( int i = 0; i < repeat; i++ )
 144   
         {
 145  0 
             buffer.append( str );
 146   
         }
 147   
 
 148  0 
         return buffer.toString();
 149   
     }
 150   
 
 151   
     /**
 152   
      * Append a description to the buffer by respecting the indentSize and lineLength parameters.
 153   
      * <b>Note</b>: The last character is always a new line.
 154   
      *
 155   
      * @param sb The buffer to append the description, not <code>null</code>.
 156   
      * @param description The description, not <code>null</code>.
 157   
      * @param indent The base indentation level of each line, must not be negative.
 158   
      */
 159   
     private void append( StringBuffer sb, String description, int indent )
 160   
     {
 161  0 
         for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
 162   
         {
 163  0 
             sb.append( it.next().toString() ).append( '\n' );
 164   
         }
 165  0 
     }
 166   
 
 167   
     /**
 168   
      * Splits the specified text into lines of convenient display length.
 169   
      *
 170   
      * @param text The text to split into lines, must not be <code>null</code>.
 171   
      * @param indent The base indentation level of each line, must not be negative.
 172   
      * @param indentSize The size of each indentation, must not be negative.
 173   
      * @param lineLength The length of the line, must not be negative.
 174   
      * @return The sequence of display lines, never <code>null</code>.
 175   
      * @throws NegativeArraySizeException if <code>indent < 0</code>
 176   
      */
 177   
     private static List toLines( String text, int indent, int indentSize, int lineLength )
 178   
     {
 179  0 
         List lines = new ArrayList();
 180   
 
 181  0 
         String ind = repeat( "\t", indent );
 182  0 
         String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
 183  0 
         for ( int i = 0; i < plainLines.length; i++ )
 184   
         {
 185  0 
             toLines( lines, ind + plainLines[i], indentSize, lineLength );
 186   
         }
 187   
 
 188  0 
         return lines;
 189   
     }
 190   
 
 191   
     /**
 192   
      * Adds the specified line to the output sequence, performing line wrapping if necessary.
 193   
      *
 194   
      * @param lines The sequence of display lines, must not be <code>null</code>.
 195   
      * @param line The line to add, must not be <code>null</code>.
 196   
      * @param indentSize The size of each indentation, must not be negative.
 197   
      * @param lineLength The length of the line, must not be negative.
 198   
      */
 199   
     private static void toLines( List lines, String line, int indentSize, int lineLength )
 200   
     {
 201  0 
         int lineIndent = getIndentLevel( line );
 202  0 
         StringBuffer buf = new StringBuffer( 256 );
 203  0 
         String[] tokens = line.split( " +" );
 204  0 
         for ( int i = 0; i < tokens.length; i++ )
 205   
         {
 206  0 
             String token = tokens[i];
 207  0 
             if ( i > 0 )
 208   
             {
 209  0 
                 if ( buf.length() + token.length() >= lineLength )
 210   
                 {
 211  0 
                     lines.add( buf.toString() );
 212  0 
                     buf.setLength( 0 );
 213  0 
                     buf.append( repeat( " ", lineIndent * indentSize ) );
 214   
                 }
 215   
                 else
 216   
                 {
 217  0 
                     buf.append( ' ' );
 218   
                 }
 219   
             }
 220  0 
             for ( int j = 0; j < token.length(); j++ )
 221   
             {
 222  0 
                 char c = token.charAt( j );
 223  0 
                 if ( c == '\t' )
 224   
                 {
 225  0 
                     buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
 226   
                 }
 227  0 
                 else if ( c == '\u00A0' )
 228   
                 {
 229  0 
                     buf.append( ' ' );
 230   
                 }
 231   
                 else
 232   
                 {
 233  0 
                     buf.append( c );
 234   
                 }
 235   
             }
 236   
         }
 237  0 
         lines.add( buf.toString() );
 238  0 
     }
 239   
 
 240   
     /**
 241   
      * Gets the indentation level of the specified line.
 242   
      *
 243   
      * @param line The line whose indentation level should be retrieved, must not be <code>null</code>.
 244   
      * @return The indentation level of the line.
 245   
      */
 246   
     private static int getIndentLevel( String line )
 247   
     {
 248  0 
         int level = 0;
 249  0 
         for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
 250   
         {
 251  0 
             level++;
 252   
         }
 253  0 
         for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
 254   
         {
 255  0 
             if ( line.charAt( i ) == '\t' )
 256   
             {
 257  0 
                 level++;
 258  0 
                 break;
 259   
             }
 260   
         }
 261  0 
         return level;
 262   
     }
 263   
 }
Report generated by Cobertura 1.9 on 29/10/09 15:04.