org.apache.maven.plugins.linkcheck.HelpMojo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-linkcheck-plugin Show documentation
Show all versions of maven-linkcheck-plugin Show documentation
This plugin allows you to generate a linkcheck report of your project's documentation.
package org.apache.maven.plugins.linkcheck;
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-linkcheck-plugin.
Call mvn linkcheck:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details.
*
* @version generated on Thu Aug 05 00:26:49 CEST 2010
* @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.6)
* @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.apache.maven.plugins:maven-linkcheck-plugin:1.0", 0 );
append( sb, "", 0 );
append( sb, "Maven Linkcheck Plugin", 0 );
append( sb, "This plugin allows you to generate a linkcheck report of your project\'s documentation.", 1 );
append( sb, "", 0 );
if ( goal == null || goal.length() <= 0 )
{
append( sb, "This plugin has 2 goals:", 0 );
append( sb, "", 0 );
}
if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
{
append( sb, "linkcheck:help", 0 );
append( sb, "Display help information on maven-linkcheck-plugin.\nCall\n\u00a0\u00a0mvn\u00a0linkcheck: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 || "linkcheck".equals( goal ) )
{
append( sb, "linkcheck:linkcheck", 0 );
append( sb, "Generates a Linkcheck report.", 1 );
append( sb, "", 0 );
if ( detail )
{
append( sb, "Available parameters:", 1 );
append( sb, "", 0 );
append( sb, "baseURL (Default: ${project.url})", 2 );
append( sb, "The base URL to use for absolute links (eg /index.html) in the site.", 3 );
append( sb, "", 0 );
append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
append( sb, "The file encoding to use when Linkcheck reads the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.", 3 );
append( sb, "", 0 );
append( sb, "excludedHttpStatusErrors", 2 );
append( sb, "The list of HTTP errors to ignored, like 404.", 3 );
append( sb, "", 0 );
append( sb, "excludedHttpStatusWarnings", 2 );
append( sb, "The list of HTTP warnings to ignored, like 301.", 3 );
append( sb, "", 0 );
append( sb, "excludedLinks", 2 );
append( sb, "The list of links to exclude.\nNote: Patterns like **/dummy/* are allowed for excludedLink.", 3 );
append( sb, "", 0 );
append( sb, "excludedPages", 2 );
append( sb, "The list of site pages to exclude. By default, this report, i.e. linkcheck.html, will be excluded.\nNote: No pattern is allowed for excludedPage, only specific file names.", 3 );
append( sb, "", 0 );
append( sb, "forceSite (Default: true)", 2 );
append( sb, "true to force the site generation, false otherwise. Using this parameter ensures that all documents have been correctly generated.", 3 );
append( sb, "", 0 );
append( sb, "httpClientParameters", 2 );
append( sb, "The extra HttpClient parameters to be used when fetching links. For instance:\n\n\u00a0\n\u00a0\u00a0http.protocol.max-redirects \n\u00a0\u00a010 \n\u00a0 \n \nSee HttpClient preference page", 3 );
append( sb, "", 0 );
append( sb, "httpFollowRedirect (Default: true)", 2 );
append( sb, "If online, the HTTP method should automatically follow HTTP redirects, false otherwise.", 3 );
append( sb, "", 0 );
append( sb, "httpMethod (Default: head)", 2 );
append( sb, "The HTTP method to use. Currently supported are \'GET\' and \'HEAD\'.\nHTTP GET\n\tThe HTTP GET method is defined in section 9.3 of RFC2616: The GET method means retrieve whatever information (in the form of an entity) is identified by the Request-URI.\nHTTP HEAD\n\tThe HTTP HEAD method is defined in section 9.4 of RFC2616: The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response.\n", 3 );
append( sb, "", 0 );
append( sb, "linkcheckCache (Default: ${project.build.directory}/linkcheck/linkcheck.cache)", 2 );
append( sb, "The location of the Linkcheck cache file.", 3 );
append( sb, "", 0 );
append( sb, "linkcheckOutput (Default: ${project.build.directory}/linkcheck/linkcheck.xml)", 2 );
append( sb, "The location of the Linkcheck report file.", 3 );
append( sb, "", 0 );
append( sb, "offline (Default: ${settings.offline})", 2 );
append( sb, "Whether we are offline or not.", 3 );
append( sb, "", 0 );
append( sb, "outputDirectory", 2 );
append( sb, "Report output directory.", 3 );
append( sb, "", 0 );
append( sb, "skip (Default: false)", 2 );
append( sb, "true to skip the report execution, false otherwise. The purpose is to prevent infinite call when forceSite is enable.", 3 );
append( sb, "", 0 );
append( sb, "timeout (Default: 2000)", 2 );
append( sb, "Set the timeout to be used when fetching links. A value of zero means the timeout is not used.", 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;
}
}