org.apache.maven.tools.plugin.generator

Class PluginHelpGenerator

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.tools.plugin.generator.PluginHelpGenerator

All Implemented Interfaces:

Generator, org.codehaus.plexus.logging.LogEnabled

public class PluginHelpGenerator
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements Generator

Generates an HelpMojo class.

Since:

2.4

Version:

$Id: PluginHelpGenerator.java 1067539 2011-02-05 22:11:34Z dennisl $

Author:

Vincent Siveton

Constructor Summary

Constructors

Constructor and Description
PluginHelpGenerator() Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(File destinationDirectory, org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor) Execute the generation for a given plugin descriptor.
void	execute(File destinationDirectory, PluginToolsRequest request) Execute the generation for a given plugin descriptor.
PluginHelpGenerator	setHelpPackageName(String helpPackageName)
PluginHelpGenerator	setUseJava5(boolean useJava5)
protected static String	toText(String html) Deprecated. since 2.4.3, using PluginUtils.toText(String) instead of.

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginHelpGenerator

public PluginHelpGenerator()

Default constructor

Method Detail

execute

public void execute(File destinationDirectory,
           org.apache.maven.plugin.descriptor.PluginDescriptor pluginDescriptor)
             throws IOException

Execute the generation for a given plugin descriptor.

Specified by:

execute in interface Generator

Parameters:

destinationDirectory - required

pluginDescriptor - required

Throws:

IOException - if any

execute

public void execute(File destinationDirectory,
           PluginToolsRequest request)
             throws IOException

Execute the generation for a given plugin descriptor.

Specified by:

execute in interface Generator

Parameters:

destinationDirectory - required

request - required

Throws:

IOException - if any

setHelpPackageName

public PluginHelpGenerator setHelpPackageName(String helpPackageName)

setUseJava5

public PluginHelpGenerator setUseJava5(boolean useJava5)

toText

protected static String toText(String html)

Deprecated. since 2.4.3, using PluginUtils.toText(String) instead of.

Converts a HTML fragment as extracted from a javadoc comment to a plain text string. This method tries to retain as much of the text formatting as possible by means of the following transformations:

• List items are converted to leading tabs (U+0009), followed by the item number/bullet, another tab and finally the item contents. Each tab denotes an increase of indentation.
• Flow breaking elements as well as literal line terminators in preformatted text are converted to a newline (U+000A) to denote a mandatory line break.
• Consecutive spaces and line terminators from character data outside of preformatted text will be normalized to a single space. The resulting space denotes a possible point for line wrapping.
• Each space in preformatted text will be converted to a non-breaking space (U+00A0).

Parameters:

html - The HTML fragment to convert to plain text, may be null.

Returns:

A string with HTML tags converted into pure text, never null.