org.codehaus.mojo.truezip.HelpMojo Maven / Gradle / Ivy
package org.codehaus.mojo.truezip;
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 truezip-maven-plugin.
Call mvn truezip:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details.
*
* @version generated on Sat Feb 20 10:08:25 PST 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.codehaus.mojo:truezip-maven-plugin:1.0-beta-5", 0 );
append( sb, "", 0 );
append( sb, "Maven Plugin for TrueZIP", 0 );
append( sb, "Use this plugin create new or manipulate existing archives", 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 || "copy".equals( goal ) )
{
append( sb, "truezip:copy", 0 );
append( sb, "Copy a set of files in and out of an existing archive", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "files", 2 );
append( sb, "The list of FileItem to to manipulate the archive. Use this configuration when you have a need to do copying with option to change file name.", 3 );
append( sb, "", 0 );
append( sb, "fileset", 2 );
append( sb, "A single FileSet to manipulate the archive.", 3 );
append( sb, "", 0 );
append( sb, "filesets", 2 );
append( sb, "The list of FileSet to manipulate the archive.", 3 );
append( sb, "", 0 );
append( sb, "immediateUpdate (Default: true)", 2 );
append( sb, "Enable automatic file update after each MOJO execution. If set to false, immediate update is not performed. Then, the updated files are flushed at undefined time (when the VM finalizes objects). Otherwise, a forced file update can be triggered by using update goal in an separate execution.", 3 );
append( sb, "", 0 );
append( sb, "verbose (Default: false)", 2 );
append( sb, "Enable verbose mode", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "cp".equals( goal ) )
{
append( sb, "truezip:cp", 0 );
append( sb, "Copy an archive/directory to another archive/directory. Mainly used from command line to unpack/pack any known archive type.\nExample:\n\n-\tmvn truezip:cp -Dfrom=a.zip -Dto=b\n-\tmvn truezip:cp -Dfrom=b -Dto=b.zip\n\n\n", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "from", 2 );
append( sb, "Path to an archive to be unpacked", 3 );
append( sb, "", 0 );
append( sb, "immediateUpdate (Default: true)", 2 );
append( sb, "Enable automatic file update after each MOJO execution. If set to false, immediate update is not performed. Then, the updated files are flushed at undefined time (when the VM finalizes objects). Otherwise, a forced file update can be triggered by using update goal in an separate execution.", 3 );
append( sb, "", 0 );
append( sb, "to", 2 );
append( sb, "Path to an archive or directory unpack to", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
{
append( sb, "truezip:help", 0 );
append( sb, "Display help information on truezip-maven-plugin.\nCall\n\u00a0\u00a0mvn\u00a0truezip:help\u00a0-Ddetail=true\u00a0-Dgoal=\nto display parameter details.", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "detail (Default: false)", 2 );
append( sb, "If true, display all settable properties for each goal.", 3 );
append( sb, "", 0 );
append( sb, "goal", 2 );
append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
append( sb, "", 0 );
append( sb, "indentSize (Default: 2)", 2 );
append( sb, "The number of spaces per indentation level, should be positive.", 3 );
append( sb, "", 0 );
append( sb, "lineLength (Default: 80)", 2 );
append( sb, "The maximum length of a display line, should be positive.", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "list".equals( goal ) )
{
append( sb, "truezip:list", 0 );
append( sb, "List all files in the archive.", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "fileset", 2 );
append( sb, "A single FileSet to manipulate the archive.", 3 );
append( sb, "", 0 );
append( sb, "filesets", 2 );
append( sb, "The list of FileSet to manipulate the archive.", 3 );
append( sb, "", 0 );
append( sb, "immediateUpdate (Default: true)", 2 );
append( sb, "Enable automatic file update after each MOJO execution. If set to false, immediate update is not performed. Then, the updated files are flushed at undefined time (when the VM finalizes objects). Otherwise, a forced file update can be triggered by using update goal in an separate execution.", 3 );
append( sb, "", 0 );
append( sb, "outputFile", 2 );
append( sb, "Write list output to a file if needed", 3 );
append( sb, "", 0 );
append( sb, "verbose (Default: false)", 2 );
append( sb, "Enable verbose mode", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "ls".equals( goal ) )
{
append( sb, "truezip:ls", 0 );
append( sb, "Display an archive\'s list to console. Note: inner archive file length always show 0 byte long. See TrueZip java doc for details.\nExample:\n\n-\tmvn truezip:ls -Dfrom=a.zip\n\n\n", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "followSubArchive (Default: false)", 2 );
append( sb, "Drill beyond sub archive", 3 );
append( sb, "", 0 );
append( sb, "from", 2 );
append( sb, "Path to an archive file to display", 3 );
append( sb, "", 0 );
append( sb, "immediateUpdate (Default: true)", 2 );
append( sb, "Enable automatic file update after each MOJO execution. If set to false, immediate update is not performed. Then, the updated files are flushed at undefined time (when the VM finalizes objects). Otherwise, a forced file update can be triggered by using update goal in an separate execution.", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "move".equals( goal ) )
{
append( sb, "truezip:move", 0 );
append( sb, "Use this goal to move single file or multiple files(via FileSet) between archives or directories", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "fileset", 2 );
append( sb, "A single FileSet to manipulate the archive.", 3 );
append( sb, "", 0 );
append( sb, "filesets", 2 );
append( sb, "The list of FileSet to manipulate the archive.", 3 );
append( sb, "", 0 );
append( sb, "from", 2 );
append( sb, "Path of original file", 3 );
append( sb, "", 0 );
append( sb, "immediateUpdate (Default: true)", 2 );
append( sb, "Enable automatic file update after each MOJO execution. If set to false, immediate update is not performed. Then, the updated files are flushed at undefined time (when the VM finalizes objects). Otherwise, a forced file update can be triggered by using update goal in an separate execution.", 3 );
append( sb, "", 0 );
append( sb, "to", 2 );
append( sb, "Path of destination file", 3 );
append( sb, "", 0 );
append( sb, "verbose (Default: false)", 2 );
append( sb, "Enable verbose mode", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "remove".equals( goal ) )
{
append( sb, "truezip:remove", 0 );
append( sb, "Remove a set of files from an existing archive", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "fileset", 2 );
append( sb, "A single FileSet to manipulate the archive.", 3 );
append( sb, "", 0 );
append( sb, "filesets", 2 );
append( sb, "The list of FileSet to manipulate the archive.", 3 );
append( sb, "", 0 );
append( sb, "immediateUpdate (Default: true)", 2 );
append( sb, "Enable automatic file update after each MOJO execution. If set to false, immediate update is not performed. Then, the updated files are flushed at undefined time (when the VM finalizes objects). Otherwise, a forced file update can be triggered by using update goal in an separate execution.", 3 );
append( sb, "", 0 );
append( sb, "verbose (Default: false)", 2 );
append( sb, "Enable verbose mode", 3 );
append( sb, "", 0 );
}
}
if ( goal == null || goal.length() <= 0 || "update".equals( goal ) )
{
append( sb, "truezip:update", 0 );
append( sb, "Update open archives immediately, flush cached data to disk.", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "immediateUpdate (Default: true)", 2 );
append( sb, "Enable automatic file update after each MOJO execution. If set to false, immediate update is not performed. Then, the updated files are flushed at undefined time (when the VM finalizes objects). Otherwise, a forced file update can be triggered by using update goal in an separate execution.", 3 );
append( sb, "", 0 );
}
}
if ( getLog().isInfoEnabled() )
{
getLog().info( sb.toString() );
}
}
/**
* Repeat a String n times to form a new string.
*
* @param str String to repeat
* @param repeat number of times to repeat str
* @return String with repeated String
* @throws NegativeArraySizeException if 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;
}
}