org.codehaus.mojo.license.HelpMojo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of license-maven-plugin Show documentation
Show all versions of license-maven-plugin Show documentation
Maven plugin to download and collect license files from project dependencies.
package org.codehaus.mojo.license;
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 license-maven-plugin.
Call mvn license:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details.
*
* @version generated on Wed Jan 18 21:39:05 UTC 2012
* @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.7)
* @goal help
* @requiresProject false
* @threadSafe
*/
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.kuali.maven.plugins:license-maven-plugin:1.4-kuali", 0 );
append( sb, "", 0 );
append( sb, "License Maven Plugin", 0 );
append( sb, "Maven plugin to download and collect license files from project dependencies.", 1 );
append( sb, "", 0 );
if ( goal == null || goal.length() <= 0 )
{
append( sb, "This plugin has 8 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, "Goal to generate the third-party license file.\nThis file contains a list of the dependencies and their licenses. Each dependency and it\'s license is displayed on a single line in the format\n\n\n\u00a0\u00a0()\u00a0\u00a0::\u00a0-\u00a0\nIt 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, "artifactLicenseMapping (Default: THIRD-PARTY.properties)", 2 );
append( sb, "Location of a properties file mapping artifacts that are published with no license to the license that should be used for them. This supports classpath notation and any other type of URL Spring 3.1 resource loading can understand.", 3 );
append( sb, "Expression: ${license.artifactLicenseMapping}", 3 );
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, "Expression: ${license.bundleThirdPartyPath}", 3 );
append( sb, "", 0 );
append( sb, "deployMissingFile (Default: true)", 2 );
append( sb, "Deploy the third party missing file in maven repository.", 3 );
append( sb, "Expression: ${license.deployMissingFile}", 3 );
append( sb, "", 0 );
append( sb, "doGenerateMissing (Default: false)", 2 );
append( sb, "Controls if THIRD-PARTY.properties gets created or not", 3 );
append( sb, "Expression: ${license.doGenerateMissing}", 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, "Expression: ${license.encoding}", 3 );
append( sb, "", 0 );
append( sb, "excludedArtifacts", 2 );
append( sb, "A filter to exclude some ArtifactsIds", 3 );
append( sb, "Expression: ${license.excludedArtifacts}", 3 );
append( sb, "", 0 );
append( sb, "excludedGroups", 2 );
append( sb, "A filter to exclude some GroupIds", 3 );
append( sb, "Expression: ${license.excludedGroups}", 3 );
append( sb, "", 0 );
append( sb, "excludedScopes (Default: system)", 2 );
append( sb, "A filter to exclude some scopes.", 3 );
append( sb, "Expression: ${license.excludedScopes}", 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, "Expression: ${license.failIfWarning}", 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, "Expression: ${license.force}", 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.\nThe file will be copied at the bundleThirdPartyPath location.\n", 3 );
append( sb, "Expression: ${license.generateBundle}", 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, "Expression: ${license.groupByLicense}", 3 );
append( sb, "", 0 );
append( sb, "includedArtifacts", 2 );
append( sb, "A filter to include only some ArtifactsIds", 3 );
append( sb, "Expression: ${license.includedArtifacts}", 3 );
append( sb, "", 0 );
append( sb, "includedGroups", 2 );
append( sb, "A filter to include only some GroupIds", 3 );
append( sb, "Expression: ${license.includedGroups}", 3 );
append( sb, "", 0 );
append( sb, "includedScopes", 2 );
append( sb, "A filter to include only some scopes, if let empty then all scopes will be used (no filter).", 3 );
append( sb, "Expression: ${license.includedScopes}", 3 );
append( sb, "", 0 );
append( sb, "includeTransitiveDependencies (Default: true)", 2 );
append( sb, "Include transitive dependencies when downloading license files.", 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 Repeat a String n times to form a new string.
repeat < 0
* @throws NullPointerException if str is null
*/
private static String repeat( String str, int repeat )
{
StringBuffer buffer = new StringBuffer( repeat * str.length() );
for ( int i = 0; i < repeat; i++ )
{
buffer.append( str );
}
return buffer.toString();
}
/**
* Append a description to the buffer by respecting the indentSize and lineLength parameters.
* Note: The last character is always a new line.
*
* @param sb The buffer to append the description, not null.
* @param description The description, not null.
* @param indent The base indentation level of each line, must not be negative.
*/
private void append( StringBuffer sb, String description, int indent )
{
for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
{
sb.append( it.next().toString() ).append( '\n' );
}
}
/**
* Splits the specified text into lines of convenient display length.
*
* @param text The text to split into lines, must not be null.
* @param indent The base indentation level of each line, must not be negative.
* @param indentSize The size of each indentation, must not be negative.
* @param lineLength The length of the line, must not be negative.
* @return The sequence of display lines, never null.
* @throws NegativeArraySizeException if indent < 0
*/
private static List toLines( String text, int indent, int indentSize, int lineLength )
{
List lines = new ArrayList();
String ind = repeat( "\t", indent );
String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
for ( int i = 0; i < plainLines.length; i++ )
{
toLines( lines, ind + plainLines[i], indentSize, lineLength );
}
return lines;
}
/**
* Adds the specified line to the output sequence, performing line wrapping if necessary.
*
* @param lines The sequence of display lines, must not be null.
* @param line The line to add, must not be null.
* @param indentSize The size of each indentation, must not be negative.
* @param lineLength The length of the line, must not be negative.
*/
private static void toLines( List lines, String line, int indentSize, int lineLength )
{
int lineIndent = getIndentLevel( line );
StringBuffer buf = new StringBuffer( 256 );
String[] tokens = line.split( " +" );
for ( int i = 0; i < tokens.length; i++ )
{
String token = tokens[i];
if ( i > 0 )
{
if ( buf.length() + token.length() >= lineLength )
{
lines.add( buf.toString() );
buf.setLength( 0 );
buf.append( repeat( " ", lineIndent * indentSize ) );
}
else
{
buf.append( ' ' );
}
}
for ( int j = 0; j < token.length(); j++ )
{
char c = token.charAt( j );
if ( c == '\t' )
{
buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
}
else if ( c == '\u00A0' )
{
buf.append( ' ' );
}
else
{
buf.append( c );
}
}
}
lines.add( buf.toString() );
}
/**
* Gets the indentation level of the specified line.
*
* @param line The line whose indentation level should be retrieved, must not be null.
* @return The indentation level of the line.
*/
private static int getIndentLevel( String line )
{
int level = 0;
for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
{
level++;
}
for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
{
if ( line.charAt( i ) == '\t' )
{
level++;
break;
}
}
return level;
}
}