• Home
• org.nuiton
• maven-license-plugin
• 3.0
• source code
• HelpMojo.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.nuiton.license.plugin.HelpMojo Maven / Gradle / Ivy

package org.nuiton.license.plugin;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;

/**
 * Display help information on maven-license-plugin.
 Call 
  mvn license:help -Ddetail=true -Dgoal=<goal-name>
 to display parameter details.
 *
 * @version generated on Thu Nov 18 22:21:37 CET 2010
 * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.5.1)
 * @goal help
 * @requiresProject false
 */
public class HelpMojo
    extends AbstractMojo
{
    /**
     * If true, display all settable properties for each goal.
     * 
     * @parameter expression="${detail}" default-value="false"
     */
    private boolean detail;

    /**
     * The name of the goal for which to show help. If unspecified, all goals will be displayed.
     * 
     * @parameter expression="${goal}"
     */
    private java.lang.String goal;

    /**
     * The maximum length of a display line, should be positive.
     * 
     * @parameter expression="${lineLength}" default-value="80"
     */
    private int lineLength;

    /**
     * The number of spaces per indentation level, should be positive.
     * 
     * @parameter expression="${indentSize}" default-value="2"
     */
    private int indentSize;


    /** {@inheritDoc} */
    public void execute()
        throws MojoExecutionException
    {
        if ( lineLength <= 0 )
        {
            getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." );
            lineLength = 80;
        }
        if ( indentSize <= 0 )
        {
            getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." );
            indentSize = 2;
        }

        StringBuffer sb = new StringBuffer();

        append( sb, "org.nuiton:maven-license-plugin:3.0", 0 );
        append( sb, "", 0 );

        append( sb, "Maven License Plugin", 0 );
        append( sb, "Plugin de gestion des licenses (et en-t\u00eates) dans un project maven 2.", 1 );
        append( sb, "", 0 );

        if ( goal == null || goal.length() <= 0 )
        {
            append( sb, "This plugin has 7 goals:", 0 );
            append( sb, "", 0 );
        }

        if ( goal == null || goal.length() <= 0 || "add-third-party".equals( goal ) )
        {
            append( sb, "license:add-third-party", 0 );
            append( sb, "The gola to generate the third-party file. This file contains for all dependencies of the project a line giving the license used by the dependency. It will also copy it in the class-path (says add the generated directory as a resource of the build).", 1 );
            append( sb, "", 0 );
            if ( detail )
            {
                append( sb, "Available parameters:", 1 );
                append( sb, "", 0 );

                append( sb, "bundleThirdPartyPath (Default: META-INF/${project.artifactId}-THIRD-PARTY.txt)", 2 );
                append( sb, "The path of the bundled third party file to produce when generateBundle is on.\nNote: This option is not available for pom module types.\n", 3 );
                append( sb, "", 0 );

                append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
                append( sb, "Encoding used to read and writes files.\nNote: If nothing is filled here, we will use the system property file.encoding.\n", 3 );
                append( sb, "", 0 );

                append( sb, "excludedArtifacts", 2 );
                append( sb, "A filter to exclude some ArtifactsIds", 3 );
                append( sb, "", 0 );

                append( sb, "excludedGroups", 2 );
                append( sb, "A filter to exclude some GroupIds", 3 );
                append( sb, "", 0 );

                append( sb, "failIfWarning (Default: false)", 2 );
                append( sb, "A flag to fail the build if at least one dependency was detected without a license.", 3 );
                append( sb, "", 0 );

                append( sb, "force (Default: false)", 2 );
                append( sb, "To force generation of the third-party file even if every thing is up to date.", 3 );
                append( sb, "", 0 );

                append( sb, "generateBundle (Default: false)", 2 );
                append( sb, "A flag to copy a bundled version of the third-party file. This is usefull to avoid for a final application collision name of third party file. The file will be copied at the bundleThirdPartyPath location.", 3 );
                append( sb, "", 0 );

                append( sb, "groupByLicense (Default: false)", 2 );
                append( sb, "A flag to change the grouping of the generated THIRD-PARTY file.\nBy default, group by dependecies.\n\nIf sets to true, the it will group by license type.\n", 3 );
                append( sb, "", 0 );

                append( sb, "includedArtifacts", 2 );
                append( sb, "A filter to include only some ArtifactsIds", 3 );
                append( sb, "", 0 );

                append( sb, "includedGroups", 2 );
                append( sb, "A filter to include only some GroupIds", 3 );
                append( sb, "", 0 );

                append( sb, "licenseMerges", 2 );
                append( sb, "To merge licenses in final file.\nEach entry represents a merge (first license is main license to keep), licenses are separated by |.\n\nExample :\n\n\n\nThe\u00a0Apache\u00a0Software\u00a0License|Version\u00a02.0,Apache\u00a0License,\u00a0Version\u00a02.0\n\n