Coverage Report - org.apache.maven.plugin.changes.HelpMojo
 
Classes in this File Line Coverage Branch Coverage Complexity
HelpMojo
0%
0/391
0%
0/102
6,333
 
 1   
 package org.apache.maven.plugin.changes;
 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-changes-plugin.<br/> Call <pre>  mvn changes:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details.
 12   
  *
 13   
  * @version generated on Mon Jan 24 23:09:16 CET 2011
 14   
  * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.6)
 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-changes-plugin:2.4", 0 );
 68  0 
         append( sb, "", 0 );
 69   
 
 70  0 
         append( sb, "Maven Changes Report Plugin", 0 );
 71  0 
         append( sb, "Creates a release history for inclusion into the site and assists in generating an announcement mail.", 1 );
 72  0 
         append( sb, "", 0 );
 73   
 
 74  0 
         if ( goal == null || goal.length() <= 0 )
 75   
         {
 76  0 
             append( sb, "This plugin has 8 goals:", 0 );
 77  0 
             append( sb, "", 0 );
 78   
         }
 79   
 
 80  0 
         if ( goal == null || goal.length() <= 0 || "announcement-generate".equals( goal ) )
 81   
         {
 82  0 
             append( sb, "changes:announcement-generate", 0 );
 83  0 
             append( sb, "Goal which generate the template for an announcement.", 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, "announcementFile", 2 );
 91  0 
                 append( sb, "The name of the file which will contain the generated announcement. If no value is specified the plugin will use the name of the template.", 3 );
 92  0 
                 append( sb, "", 0 );
 93   
 
 94  0 
                 append( sb, "announceParameters", 2 );
 95  0 
                 append( sb, "Map of custom parameters for the announcement. This Map will be passed to the template.", 3 );
 96  0 
                 append( sb, "", 0 );
 97   
 
 98  0 
                 append( sb, "basedir", 2 );
 99  0 
                 append( sb, "The current project base directory.", 3 );
 100  0 
                 append( sb, "", 0 );
 101   
 
 102  0 
                 append( sb, "developmentTeam (Default: ${project.name} team)", 2 );
 103  0 
                 append( sb, "Name of the team that develops the artifact. This parameter will be passed to the template.", 3 );
 104  0 
                 append( sb, "", 0 );
 105   
 
 106  0 
                 append( sb, "filter", 2 );
 107  0 
                 append( sb, "Defines the filter parameters to restrict which issues are retrieved from JIRA. The filter parameter uses the same format of url parameters that is used in a JIRA search.", 3 );
 108  0 
                 append( sb, "", 0 );
 109   
 
 110  0 
                 append( sb, "finalName (Default: ${project.build.finalName})", 2 );
 111  0 
                 append( sb, "The name of the artifact to be used in the announcement.", 3 );
 112  0 
                 append( sb, "", 0 );
 113   
 
 114  0 
                 append( sb, "generateJiraAnnouncement (Default: false)", 2 );
 115  0 
                 append( sb, "Deprecated. Since version 2.4 this parameter has been deprecated. Please use the issueManagementSystems parameter instead.", 3 );
 116  0 
                 append( sb, "", 0 );
 117  0 
                 append( sb, "Flag to determine if the plugin will generate a JIRA announcement.", 3 );
 118  0 
                 append( sb, "", 0 );
 119   
 
 120  0 
                 append( sb, "introduction (Default: ${project.description})", 2 );
 121  0 
                 append( sb, "Short description or introduction of the released artifact. This parameter will be passed to the template.", 3 );
 122  0 
                 append( sb, "", 0 );
 123   
 
 124  0 
                 append( sb, "issueManagementSystems", 2 );
 125  0 
                 append( sb, "A list of issue management systems to fetch releases from. This parameter replaces the parameters generateJiraAnnouncement and jiraMerge.\nValid values are: changes.xml and JIRA.\nNote: Only one issue management system that is configured in <project>/<issueManagement> can be used. This currently means that you can combine a changes.xml file with one other issue management system.", 3 );
 126  0 
                 append( sb, "", 0 );
 127   
 
 128  0 
                 append( sb, "jiraMerge (Default: false)", 2 );
 129  0 
                 append( sb, "Deprecated. Since version 2.4 this parameter has been deprecated. Please use the issueManagementSystems parameter instead.", 3 );
 130  0 
                 append( sb, "", 0 );
 131  0 
                 append( sb, "If releases from JIRA should be merged with the releases from a changes.xml file.", 3 );
 132  0 
                 append( sb, "", 0 );
 133   
 
 134  0 
                 append( sb, "jiraPassword", 2 );
 135  0 
                 append( sb, "Defines the JIRA password for authentication into a private JIRA installation.", 3 );
 136  0 
                 append( sb, "", 0 );
 137   
 
 138  0 
                 append( sb, "jiraUser", 2 );
 139  0 
                 append( sb, "Defines the JIRA username for authentication into a private JIRA installation.", 3 );
 140  0 
                 append( sb, "", 0 );
 141   
 
 142  0 
                 append( sb, "maxEntries (Default: 25)", 2 );
 143  0 
                 append( sb, "The maximum number of issues to fetch from JIRA.\nNote: In versions 2.0-beta-3 and earlier this parameter was called \'nbEntries\'.\n", 3 );
 144  0 
                 append( sb, "", 0 );
 145   
 
 146  0 
                 append( sb, "outputDirectory", 2 );
 147  0 
                 append( sb, "Directory where the template file will be generated.", 3 );
 148  0 
                 append( sb, "", 0 );
 149   
 
 150  0 
                 append( sb, "resolutionIds (Default: Fixed)", 2 );
 151  0 
                 append( sb, "Include issues from JIRA with these resolution ids. Multiple resolution ids can be specified as a comma separated list of ids.\nNote: In versions 2.0-beta-3 and earlier this parameter was called \'resolutionId\'.\n", 3 );
 152  0 
                 append( sb, "", 0 );
 153   
 
 154  0 
                 append( sb, "runOnlyAtExecutionRoot (Default: false)", 2 );
 155  0 
                 append( sb, "This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.", 3 );
 156  0 
                 append( sb, "", 0 );
 157   
 
 158  0 
                 append( sb, "statusIds (Default: Closed)", 2 );
 159  0 
                 append( sb, "Include issues from JIRA with these status ids. Multiple status ids can be specified as a comma separated list of ids.\nNote: In versions 2.0-beta-3 and earlier this parameter was called \'statusId\'.\n", 3 );
 160  0 
                 append( sb, "", 0 );
 161   
 
 162  0 
                 append( sb, "template (Default: announcement.vm)", 2 );
 163  0 
                 append( sb, "The Velocity template used to format the announcement.", 3 );
 164  0 
                 append( sb, "", 0 );
 165   
 
 166  0 
                 append( sb, "templateDirectory (Default: org/apache/maven/plugin/announcement)", 2 );
 167  0 
                 append( sb, "Directory that contains the template.\nNote: This directory must be a subdirectory of /src/main/resources/ or current project base directory.\n", 3 );
 168  0 
                 append( sb, "", 0 );
 169   
 
 170  0 
                 append( sb, "templateEncoding (Default: ${project.build.sourceEncoding})", 2 );
 171  0 
                 append( sb, "The template encoding.", 3 );
 172  0 
                 append( sb, "", 0 );
 173   
 
 174  0 
                 append( sb, "tracPassword", 2 );
 175  0 
                 append( sb, "Defines the Trac password for authentication into a private Trac installation.", 3 );
 176  0 
                 append( sb, "", 0 );
 177   
 
 178  0 
                 append( sb, "tracQuery (Default: order=id)", 2 );
 179  0 
                 append( sb, "Defines the Trac query for searching for tickets.", 3 );
 180  0 
                 append( sb, "", 0 );
 181   
 
 182  0 
                 append( sb, "tracUser", 2 );
 183  0 
                 append( sb, "Defines the Trac username for authentication into a private Trac installation.", 3 );
 184  0 
                 append( sb, "", 0 );
 185   
 
 186  0 
                 append( sb, "url", 2 );
 187  0 
                 append( sb, "Distribution URL of the artifact. This parameter will be passed to the template.", 3 );
 188  0 
                 append( sb, "", 0 );
 189   
 
 190  0 
                 append( sb, "urlDownload", 2 );
 191  0 
                 append( sb, "URL where the artifact can be downloaded. If not specified, no URL is used. This parameter will be passed to the template.", 3 );
 192  0 
                 append( sb, "", 0 );
 193   
 
 194  0 
                 append( sb, "version (Default: ${project.version})", 2 );
 195  0 
                 append( sb, "Version of the artifact.", 3 );
 196  0 
                 append( sb, "", 0 );
 197   
 
 198  0 
                 append( sb, "webPassword", 2 );
 199  0 
                 append( sb, "Defines the http password for basic authentication into the JIRA webserver.", 3 );
 200  0 
                 append( sb, "", 0 );
 201   
 
 202  0 
                 append( sb, "webUser", 2 );
 203  0 
                 append( sb, "Defines the http user for basic authentication into the JIRA webserver.", 3 );
 204  0 
                 append( sb, "", 0 );
 205   
 
 206  0 
                 append( sb, "xmlPath", 2 );
 207  0 
                 append( sb, "The path of the changes.xml file.", 3 );
 208  0 
                 append( sb, "", 0 );
 209   
             }
 210   
         }
 211   
 
 212  0 
         if ( goal == null || goal.length() <= 0 || "announcement-mail".equals( goal ) )
 213   
         {
 214  0 
             append( sb, "changes:announcement-mail", 0 );
 215  0 
             append( sb, "Goal which sends an announcement through email.", 1 );
 216  0 
             append( sb, "", 0 );
 217  0 
             if ( detail )
 218   
             {
 219  0 
                 append( sb, "Available parameters:", 1 );
 220  0 
                 append( sb, "", 0 );
 221   
 
 222  0 
                 append( sb, "basedir", 2 );
 223  0 
                 append( sb, "The current project base directory.", 3 );
 224  0 
                 append( sb, "", 0 );
 225   
 
 226  0 
                 append( sb, "fromDeveloperId", 2 );
 227  0 
                 append( sb, "The id of the developer sending the announcement mail. Only used if the mailSender attribute is not set. In this case, this should match the id of one of the developers in the pom. If a matching developer is not found, then the first developer in the pom will be used.", 3 );
 228  0 
                 append( sb, "", 0 );
 229   
 
 230  0 
                 append( sb, "mailContentType (Default: text/plain)", 2 );
 231  0 
                 append( sb, "Mail content type to use.", 3 );
 232  0 
                 append( sb, "", 0 );
 233   
 
 234  0 
                 append( sb, "mailSender", 2 );
 235  0 
                 append( sb, "Defines the sender of the announcement if the list of developer is empty or if the sender is not a member of the development team.", 3 );
 236  0 
                 append( sb, "", 0 );
 237   
 
 238  0 
                 append( sb, "password", 2 );
 239  0 
                 append( sb, "The password used to send the email.", 3 );
 240  0 
                 append( sb, "", 0 );
 241   
 
 242  0 
                 append( sb, "runOnlyAtExecutionRoot (Default: false)", 2 );
 243  0 
                 append( sb, "This will cause the execution to be run only at the top of a given module tree. That is, run in the project contained in the same folder where the mvn execution was launched.", 3 );
 244  0 
                 append( sb, "", 0 );
 245   
 
 246  0 
                 append( sb, "smtpHost", 2 );
 247  0 
                 append( sb, "Smtp Server.", 3 );
 248  0 
                 append( sb, "", 0 );
 249   
 
 250  0 
                 append( sb, "smtpPort (Default: 25)", 2 );
 251  0 
                 append( sb, "Port.", 3 );
 252  0 
                 append( sb, "", 0 );
 253   
 
 254  0 
                 append( sb, "sslMode (Default: false)", 2 );
 255  0 
                 append( sb, "If the email should be sent in SSL mode.", 3 );
 256  0 
                 append( sb, "", 0 );
 257   
 
 258  0 
                 append( sb, "subject (Default: [ANNOUNCEMENT] - ${project.name} ${project.version} released)", 2 );
 259  0 
                 append( sb, "Subject for the email.", 3 );
 260  0 
                 append( sb, "", 0 );
 261   
 
 262  0 
                 append( sb, "template (Default: announcement.vm)", 2 );
 263  0 
                 append( sb, "The Velocity template used to format the announcement.", 3 );
 264  0 
                 append( sb, "", 0 );
 265   
 
 266  0 
                 append( sb, "templateOutputDirectory", 2 );
 267  0 
                 append( sb, "Directory which contains the template for announcement email.", 3 );
 268  0 
                 append( sb, "", 0 );
 269   
 
 270  0 
                 append( sb, "toAddresses", 2 );
 271  0 
                 append( sb, "Recipient email address.", 3 );
 272  0 
                 append( sb, "", 0 );
 273   
 
 274  0 
                 append( sb, "username", 2 );
 275  0 
                 append( sb, "The username used to send the email.", 3 );
 276  0 
                 append( sb, "", 0 );
 277   
             }
 278   
         }
 279   
 
 280  0 
         if ( goal == null || goal.length() <= 0 || "changes-check".equals( goal ) )
 281   
         {
 282  0 
             append( sb, "changes:changes-check", 0 );
 283  0 
             append( sb, "Goal which checks that the changes.xml file has the necessary data to generate an announcement or a report for the current release.", 1 );
 284  0 
             append( sb, "", 0 );
 285  0 
             if ( detail )
 286   
             {
 287  0 
                 append( sb, "Available parameters:", 1 );
 288  0 
                 append( sb, "", 0 );
 289   
 
 290  0 
                 append( sb, "releaseDateFormat (Default: yyyy-MM-dd)", 2 );
 291  0 
                 append( sb, "The format that a correct release date should have. This value will be used as a pattern to try to create a date.", 3 );
 292  0 
                 append( sb, "", 0 );
 293   
 
 294  0 
                 append( sb, "version (Default: ${project.version})", 2 );
 295  0 
                 append( sb, "Version of the artifact.", 3 );
 296  0 
                 append( sb, "", 0 );
 297   
 
 298  0 
                 append( sb, "xmlPath (Default: src/changes/changes.xml)", 2 );
 299  0 
                 append( sb, "The path of the changes.xml file that will be checked.", 3 );
 300  0 
                 append( sb, "", 0 );
 301   
             }
 302   
         }
 303   
 
 304  0 
         if ( goal == null || goal.length() <= 0 || "changes-report".equals( goal ) )
 305   
         {
 306  0 
             append( sb, "changes:changes-report", 0 );
 307  0 
             append( sb, "Goal which creates a nicely formatted Changes Report in html format from a changes.xml file.", 1 );
 308  0 
             append( sb, "", 0 );
 309  0 
             if ( detail )
 310   
             {
 311  0 
                 append( sb, "Available parameters:", 1 );
 312  0 
                 append( sb, "", 0 );
 313   
 
 314  0 
                 append( sb, "addActionDate (Default: false)", 2 );
 315  0 
                 append( sb, "A flag whether the report should also include the dates of individual actions. If set to false, only the dates of releases will be written to the report.", 3 );
 316  0 
                 append( sb, "", 0 );
 317   
 
 318  0 
                 append( sb, "escapeHTML (Default: true)", 2 );
 319  0 
                 append( sb, "Deprecated. using markup inside CDATA sections does not work for all output formats!", 3 );
 320  0 
                 append( sb, "", 0 );
 321  0 
                 append( sb, "Whether HTML code within an action should be escaped. By changing this to false you can restore the behavior that was in version 2.2 of this plugin, allowing you to use HTML code to format the content of an action.\nNote: If you use HTML code in an action you need to place it inside a CDATA section.\nNote: Putting any kind of markup inside a CDATA section might mess up the Changes Report or other generated documents, such as PDFs, that are based on your changes.xml file if you are not careful.", 3 );
 322  0 
                 append( sb, "", 0 );
 323   
 
 324  0 
                 append( sb, "filteringChanges (Default: false)", 2 );
 325  0 
                 append( sb, "applying filtering filtering \'a la\' resources plugin", 3 );
 326  0 
                 append( sb, "", 0 );
 327   
 
 328  0 
                 append( sb, "issueLinkTemplate (Default: %URL%/ViewIssue.jspa?key=%ISSUE%)", 2 );
 329  0 
                 append( sb, "Deprecated. As of 2.1 use issueLinkTemplatePerSystem : this one will be with system default", 3 );
 330  0 
                 append( sb, "", 0 );
 331  0 
                 append( sb, "Template string that is used to discover the URL to use to display an issue report. There are 2 template tokens you can use. %URL%: this is computed by getting the <issueManagement>/<url> value from the POM, and removing the last \'/\' and everything that comes after it. %ISSUE%: this is the issue number.\nNote: In versions of this plugin prior to 2.0-beta-2 this parameter was called link_template.\n", 3 );
 332  0 
                 append( sb, "", 0 );
 333   
 
 334  0 
                 append( sb, "issueLinkTemplatePerSystem", 2 );
 335  0 
                 append( sb, "Template strings per system that is used to discover the URL to use to display an issue report. Each key in this map denotes the (case-insensitive) identifier of the issue tracking system and its value gives the URL template.\nThere are 2 template tokens you can use. %URL%: this is computed by getting the <issueManagement>/<url> value from the POM, and removing the last \'/\' and everything that comes after it. %ISSUE%: this is the issue number.\n\nNote: The deprecated issueLinkTemplate will be used for a system called \'default\'.\n\nNote: Starting with version 2.4 you usually don\'t need to specify this, unless you need to link to an issue management system in your Changes report that isn\'t supported out of the box. See the Usage page for more information.\n", 3 );
 336  0 
                 append( sb, "", 0 );
 337   
 
 338  0 
                 append( sb, "outputDirectory (Default: ${project.reporting.outputDirectory})", 2 );
 339  0 
                 append( sb, "Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.", 3 );
 340  0 
                 append( sb, "", 0 );
 341   
 
 342  0 
                 append( sb, "outputEncoding (Default: ${project.reporting.outputEncoding})", 2 );
 343  0 
                 append( sb, "Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output encoding configured in the Maven Site Plugin is used instead.", 3 );
 344  0 
                 append( sb, "", 0 );
 345   
 
 346  0 
                 append( sb, "publishDateFormat (Default: yyyy-MM-dd)", 2 );
 347  0 
                 append( sb, "Format to use for publishDate. The value will be available with the following expression ${publishDate}", 3 );
 348  0 
                 append( sb, "", 0 );
 349   
 
 350  0 
                 append( sb, "publishDateLocale (Default: en)", 2 );
 351  0 
                 append( sb, "Locale to use for publishDate when formatting", 3 );
 352  0 
                 append( sb, "", 0 );
 353   
 
 354  0 
                 append( sb, "teamlist (Default: team-list.html)", 2 );
 355  0 
                 append( sb, "The URI of a file containing all the team members. If this is set to the special value \'none\', no links will be generated for the team members.", 3 );
 356  0 
                 append( sb, "", 0 );
 357   
 
 358  0 
                 append( sb, "xmlPath (Default: src/changes/changes.xml)", 2 );
 359  0 
                 append( sb, "The path of the changes.xml file that will be converted into an HTML report.", 3 );
 360  0 
                 append( sb, "", 0 );
 361   
             }
 362   
         }
 363   
 
 364  0 
         if ( goal == null || goal.length() <= 0 || "changes-validate".equals( goal ) )
 365   
         {
 366  0 
             append( sb, "changes:changes-validate", 0 );
 367  0 
             append( sb, "Goal which validate the changes.xml file.", 1 );
 368  0 
             append( sb, "", 0 );
 369  0 
             if ( detail )
 370   
             {
 371  0 
                 append( sb, "Available parameters:", 1 );
 372  0 
                 append( sb, "", 0 );
 373   
 
 374  0 
                 append( sb, "changesXsdVersion (Default: 1.0.0)", 2 );
 375  0 
                 append( sb, "The changes xsd version.", 3 );
 376  0 
                 append( sb, "", 0 );
 377   
 
 378  0 
                 append( sb, "failOnError (Default: false)", 2 );
 379  0 
                 append( sb, "Mojo failure if validation failed. If not and validation failed only a warning will be logged.", 3 );
 380  0 
                 append( sb, "", 0 );
 381   
 
 382  0 
                 append( sb, "xmlPath (Default: src/changes/changes.xml)", 2 );
 383  0 
                 append( sb, "The path of the changes.xml file that will be converted into an HTML report.", 3 );
 384  0 
                 append( sb, "", 0 );
 385   
             }
 386   
         }
 387   
 
 388  0 
         if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
 389   
         {
 390  0 
             append( sb, "changes:help", 0 );
 391  0 
             append( sb, "Display help information on maven-changes-plugin.\nCall\n\u00a0\u00a0mvn\u00a0changes:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 1 );
 392  0 
             append( sb, "", 0 );
 393  0 
             if ( detail )
 394   
             {
 395  0 
                 append( sb, "Available parameters:", 1 );
 396  0 
                 append( sb, "", 0 );
 397   
 
 398  0 
                 append( sb, "detail (Default: false)", 2 );
 399  0 
                 append( sb, "If true, display all settable properties for each goal.", 3 );
 400  0 
                 append( sb, "", 0 );
 401   
 
 402  0 
                 append( sb, "goal", 2 );
 403  0 
                 append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
 404  0 
                 append( sb, "", 0 );
 405   
 
 406  0 
                 append( sb, "indentSize (Default: 2)", 2 );
 407  0 
                 append( sb, "The number of spaces per indentation level, should be positive.", 3 );
 408  0 
                 append( sb, "", 0 );
 409   
 
 410  0 
                 append( sb, "lineLength (Default: 80)", 2 );
 411  0 
                 append( sb, "The maximum length of a display line, should be positive.", 3 );
 412  0 
                 append( sb, "", 0 );
 413   
             }
 414   
         }
 415   
 
 416  0 
         if ( goal == null || goal.length() <= 0 || "jira-report".equals( goal ) )
 417   
         {
 418  0 
             append( sb, "changes:jira-report", 0 );
 419  0 
             append( sb, "Goal which downloads issues from the Issue Tracking System and generates a report.", 1 );
 420  0 
             append( sb, "", 0 );
 421  0 
             if ( detail )
 422   
             {
 423  0 
                 append( sb, "Available parameters:", 1 );
 424  0 
                 append( sb, "", 0 );
 425   
 
 426  0 
                 append( sb, "columnNames (Default: Key,Summary,Status,Resolution,Assignee)", 2 );
 427  0 
                 append( sb, "Sets the names of the columns that you want in the report. The columns will appear in the report in the same order as you specify them here. Multiple values can be separated by commas.\nValid columns are: Assignee, Component, Created, Fix Version, Id, Key, Priority, Reporter, Resolution, Status, Summary, Type, Updated and Version.\n", 3 );
 428  0 
                 append( sb, "", 0 );
 429   
 
 430  0 
                 append( sb, "component", 2 );
 431  0 
                 append( sb, "Sets the component(s) that you want to limit your report to include. Multiple values can be separated by commas (such as 10011,10012). If this is set to empty - that means all components will be included.", 3 );
 432  0 
                 append( sb, "", 0 );
 433   
 
 434  0 
                 append( sb, "filter", 2 );
 435  0 
                 append( sb, "Defines the filter parameters to restrict which issues are retrieved from JIRA. The filter parameter uses the same format of url parameters that is used in a JIRA search.", 3 );
 436  0 
                 append( sb, "", 0 );
 437   
 
 438  0 
                 append( sb, "fixVersionIds", 2 );
 439  0 
                 append( sb, "Sets the fix version id(s) that you want to limit your report to include. These are JIRA\'s internal version ids, NOT the human readable display ones. Multiple fix versions can be separated by commas. If this is set to empty - that means all fix versions will be included.", 3 );
 440  0 
                 append( sb, "", 0 );
 441   
 
 442  0 
                 append( sb, "jiraDatePattern (Default: EEE, d MMM yyyy HH:mm:ss Z)", 2 );
 443  0 
                 append( sb, "The pattern used by dates in the JIRA XML-file. This is used to parse the Created and Updated fields.", 3 );
 444  0 
                 append( sb, "", 0 );
 445   
 
 446  0 
                 append( sb, "jiraPassword", 2 );
 447  0 
                 append( sb, "Defines the JIRA password for authentication into a private JIRA installation.", 3 );
 448  0 
                 append( sb, "", 0 );
 449   
 
 450  0 
                 append( sb, "jiraUser", 2 );
 451  0 
                 append( sb, "Defines the JIRA username for authentication into a private JIRA installation.", 3 );
 452  0 
                 append( sb, "", 0 );
 453   
 
 454  0 
                 append( sb, "maxEntries (Default: 100)", 2 );
 455  0 
                 append( sb, "Maximum number of entries to be fetched from JIRA.", 3 );
 456  0 
                 append( sb, "", 0 );
 457   
 
 458  0 
                 append( sb, "onlyCurrentVersion (Default: false)", 2 );
 459  0 
                 append( sb, "If you only want to show issues for the current version in the report. The current version being used is ${project.version} minus any \'-SNAPSHOT\' suffix.", 3 );
 460  0 
                 append( sb, "", 0 );
 461   
 
 462  0 
                 append( sb, "outputDirectory (Default: ${project.reporting.outputDirectory})", 2 );
 463  0 
                 append( sb, "Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.", 3 );
 464  0 
                 append( sb, "", 0 );
 465   
 
 466  0 
                 append( sb, "outputEncoding (Default: ${project.reporting.outputEncoding})", 2 );
 467  0 
                 append( sb, "Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output encoding configured in the Maven Site Plugin is used instead.", 3 );
 468  0 
                 append( sb, "", 0 );
 469   
 
 470  0 
                 append( sb, "priorityIds", 2 );
 471  0 
                 append( sb, "Sets the priority(s) that you want to limit your report to include. Valid statuses are Blocker, Critical, Major, Minor and Trivial. Multiple values can be separated by commas. If this is set to empty - that means all priorities will be included.", 3 );
 472  0 
                 append( sb, "", 0 );
 473   
 
 474  0 
                 append( sb, "resolutionIds (Default: Fixed)", 2 );
 475  0 
                 append( sb, "Sets the resolution(s) that you want to fetch from JIRA. Valid resolutions are: Unresolved, Fixed, Won\'t Fix, Duplicate, Incomplete and Cannot Reproduce. Multiple values can be separated by commas.\nNote: In versions 2.0-beta-3 and earlier this parameter had no default value.\n", 3 );
 476  0 
                 append( sb, "", 0 );
 477   
 
 478  0 
                 append( sb, "sortColumnNames (Default: Priority DESC, Created DESC)", 2 );
 479  0 
                 append( sb, "Sets the column names that you want to sort the report by. Add DESC following the column name to specify descending sequence. For example Fix Version DESC, Type sorts first by the Fix Version in descending order and then by Type in ascending order. By default sorting is done in ascending order, but is possible to specify ASC for consistency. The previous example would then become Fix Version DESC, Type ASC.\nValid columns are: Assignee, Component, Created, Fix Version, Id, Key, Priority, Reporter, Resolution, Status, Summary, Type, Updated and Version.\n\nNote: If you are using JIRA 4 you need to put your sort column names in the reverse order. The handling of this changed between JIRA 3 and JIRA 4. The current default value is suitable for JIRA 3. This may change in the future, so please configure your sort column names in an order that works for your own JIRA version.\n", 3 );
 480  0 
                 append( sb, "", 0 );
 481   
 
 482  0 
                 append( sb, "statusIds (Default: Closed)", 2 );
 483  0 
                 append( sb, "Sets the status(es) that you want to fetch from JIRA. Valid statuses are: Open, In Progress, Reopened, Resolved and Closed. Multiple values can be separated by commas.\nNote: In versions 2.0-beta-3 and earlier this parameter had no default value.\n", 3 );
 484  0 
                 append( sb, "", 0 );
 485   
 
 486  0 
                 append( sb, "typeIds", 2 );
 487  0 
                 append( sb, "Sets the types(s) that you want to limit your report to include. Valid types are: Bug, New Feature, Task, Improvement, Wish, Test and Sub-task. Multiple values can be separated by commas. If this is set to empty - that means all types will be included.", 3 );
 488  0 
                 append( sb, "", 0 );
 489   
 
 490  0 
                 append( sb, "versionPrefix", 2 );
 491  0 
                 append( sb, "The prefix used when naming versions in JIRA.\nIf you have a project in JIRA with several components that have different release cycles, it is an often used pattern to prefix the version with the name of the component, e.g. maven-filtering-1.0 etc. To fetch issues from JIRA for a release of the \'maven-filtering\' component you would need to set this parameter to \'maven-filtering-\'.\n", 3 );
 492  0 
                 append( sb, "", 0 );
 493   
 
 494  0 
                 append( sb, "webPassword", 2 );
 495  0 
                 append( sb, "Defines the http password for basic authentication into the JIRA webserver.", 3 );
 496  0 
                 append( sb, "", 0 );
 497   
 
 498  0 
                 append( sb, "webUser", 2 );
 499  0 
                 append( sb, "Defines the http user for basic authentication into the JIRA webserver.", 3 );
 500  0 
                 append( sb, "", 0 );
 501   
             }
 502   
         }
 503   
 
 504  0 
         if ( goal == null || goal.length() <= 0 || "trac-report".equals( goal ) )
 505   
         {
 506  0 
             append( sb, "changes:trac-report", 0 );
 507  0 
             append( sb, "Goal which downloads issues from the Issue Tracking System and generates a report.", 1 );
 508  0 
             append( sb, "", 0 );
 509  0 
             if ( detail )
 510   
             {
 511  0 
                 append( sb, "Available parameters:", 1 );
 512  0 
                 append( sb, "", 0 );
 513   
 
 514  0 
                 append( sb, "columnNames (Default: Id,Type,Summary,Assignee,Reporter,Priority,Status,Resolution,Created,Updated)", 2 );
 515  0 
                 append( sb, "Sets the column names that you want to show in the report. The columns will appear in the report in the same order as you specify them here. Multiple values can be separated by commas.\nValid columns are: Assignee, Component, Created, Fix Version, Id, Priority, Reporter, Resolution, Status, Summary, Type and Updated.\n", 3 );
 516  0 
                 append( sb, "", 0 );
 517   
 
 518  0 
                 append( sb, "outputDirectory (Default: ${project.reporting.outputDirectory})", 2 );
 519  0 
                 append( sb, "Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.", 3 );
 520  0 
                 append( sb, "", 0 );
 521   
 
 522  0 
                 append( sb, "outputEncoding (Default: ${project.reporting.outputEncoding})", 2 );
 523  0 
                 append( sb, "Report output encoding. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output encoding configured in the Maven Site Plugin is used instead.", 3 );
 524  0 
                 append( sb, "", 0 );
 525   
 
 526  0 
                 append( sb, "query (Default: order=id)", 2 );
 527  0 
                 append( sb, "Defines the Trac query for searching ticket.", 3 );
 528  0 
                 append( sb, "", 0 );
 529   
 
 530  0 
                 append( sb, "tracPassword", 2 );
 531  0 
                 append( sb, "Defines the Trac password for authentication into a private Trac installation.", 3 );
 532  0 
                 append( sb, "", 0 );
 533   
 
 534  0 
                 append( sb, "tracUser", 2 );
 535  0 
                 append( sb, "Defines the Trac username for authentication into a private Trac installation.", 3 );
 536  0 
                 append( sb, "", 0 );
 537   
             }
 538   
         }
 539   
 
 540  0 
         if ( getLog().isInfoEnabled() )
 541   
         {
 542  0 
             getLog().info( sb.toString() );
 543   
         }
 544  0 
     }
 545   
 
 546   
     /**
 547   
      * <p>Repeat a String <code>n</code> times to form a new string.</p>
 548   
      *
 549   
      * @param str String to repeat
 550   
      * @param repeat number of times to repeat str
 551   
      * @return String with repeated String
 552   
      * @throws NegativeArraySizeException if <code>repeat < 0</code>
 553   
      * @throws NullPointerException if str is <code>null</code>
 554   
      */
 555   
     private static String repeat( String str, int repeat )
 556   
     {
 557  0 
         StringBuffer buffer = new StringBuffer( repeat * str.length() );
 558   
 
 559  0 
         for ( int i = 0; i < repeat; i++ )
 560   
         {
 561  0 
             buffer.append( str );
 562   
         }
 563   
 
 564  0 
         return buffer.toString();
 565   
     }
 566   
 
 567   
     /**
 568   
      * Append a description to the buffer by respecting the indentSize and lineLength parameters.
 569   
      * <b>Note</b>: The last character is always a new line.
 570   
      *
 571   
      * @param sb The buffer to append the description, not <code>null</code>.
 572   
      * @param description The description, not <code>null</code>.
 573   
      * @param indent The base indentation level of each line, must not be negative.
 574   
      */
 575   
     private void append( StringBuffer sb, String description, int indent )
 576   
     {
 577  0 
         for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
 578   
         {
 579  0 
             sb.append( it.next().toString() ).append( '\n' );
 580   
         }
 581  0 
     }
 582   
 
 583   
     /**
 584   
      * Splits the specified text into lines of convenient display length.
 585   
      *
 586   
      * @param text The text to split into lines, must not be <code>null</code>.
 587   
      * @param indent The base indentation level of each line, must not be negative.
 588   
      * @param indentSize The size of each indentation, must not be negative.
 589   
      * @param lineLength The length of the line, must not be negative.
 590   
      * @return The sequence of display lines, never <code>null</code>.
 591   
      * @throws NegativeArraySizeException if <code>indent < 0</code>
 592   
      */
 593   
     private static List toLines( String text, int indent, int indentSize, int lineLength )
 594   
     {
 595  0 
         List lines = new ArrayList();
 596   
 
 597  0 
         String ind = repeat( "\t", indent );
 598  0 
         String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
 599  0 
         for ( int i = 0; i < plainLines.length; i++ )
 600   
         {
 601  0 
             toLines( lines, ind + plainLines[i], indentSize, lineLength );
 602   
         }
 603   
 
 604  0 
         return lines;
 605   
     }
 606   
 
 607   
     /**
 608   
      * Adds the specified line to the output sequence, performing line wrapping if necessary.
 609   
      *
 610   
      * @param lines The sequence of display lines, must not be <code>null</code>.
 611   
      * @param line The line to add, must not be <code>null</code>.
 612   
      * @param indentSize The size of each indentation, must not be negative.
 613   
      * @param lineLength The length of the line, must not be negative.
 614   
      */
 615   
     private static void toLines( List lines, String line, int indentSize, int lineLength )
 616   
     {
 617  0 
         int lineIndent = getIndentLevel( line );
 618  0 
         StringBuffer buf = new StringBuffer( 256 );
 619  0 
         String[] tokens = line.split( " +" );
 620  0 
         for ( int i = 0; i < tokens.length; i++ )
 621   
         {
 622  0 
             String token = tokens[i];
 623  0 
             if ( i > 0 )
 624   
             {
 625  0 
                 if ( buf.length() + token.length() >= lineLength )
 626   
                 {
 627  0 
                     lines.add( buf.toString() );
 628  0 
                     buf.setLength( 0 );
 629  0 
                     buf.append( repeat( " ", lineIndent * indentSize ) );
 630   
                 }
 631   
                 else
 632   
                 {
 633  0 
                     buf.append( ' ' );
 634   
                 }
 635   
             }
 636  0 
             for ( int j = 0; j < token.length(); j++ )
 637   
             {
 638  0 
                 char c = token.charAt( j );
 639  0 
                 if ( c == '\t' )
 640   
                 {
 641  0 
                     buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
 642   
                 }
 643  0 
                 else if ( c == '\u00A0' )
 644   
                 {
 645  0 
                     buf.append( ' ' );
 646   
                 }
 647   
                 else
 648   
                 {
 649  0 
                     buf.append( c );
 650   
                 }
 651   
             }
 652   
         }
 653  0 
         lines.add( buf.toString() );
 654  0 
     }
 655   
 
 656   
     /**
 657   
      * Gets the indentation level of the specified line.
 658   
      *
 659   
      * @param line The line whose indentation level should be retrieved, must not be <code>null</code>.
 660   
      * @return The indentation level of the line.
 661   
      */
 662   
     private static int getIndentLevel( String line )
 663   
     {
 664  0 
         int level = 0;
 665  0 
         for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
 666   
         {
 667  0 
             level++;
 668   
         }
 669  0 
         for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
 670   
         {
 671  0 
             if ( line.charAt( i ) == '\t' )
 672   
             {
 673  0 
                 level++;
 674  0 
                 break;
 675   
             }
 676   
         }
 677  0 
         return level;
 678   
     }
 679   
 }
Report generated by Cobertura 1.9 on 2011-01-24 23:10.