org.apache.maven.plugins.help

Class AbstractHelpMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.help.AbstractHelpMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AbstractEffectiveMojo, ActiveProfilesMojo, AllProfilesMojo, DescribeMojo, ExpressionsMojo, SystemMojo

public abstract class AbstractHelpMojo
extends org.apache.maven.plugin.AbstractMojo

Base class with some Help Mojo functionalities.

Since:

2.1

Version:

$Id: AbstractHelpMojo.java 1384337 2012-09-13 13:53:19Z olamy $

Author:

Vincent Siveton

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	LINE_LENGTH The maximum length of a display line.
protected File	output Optional parameter to write the output of this help in a given file, instead of writing to the console.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractHelpMojo()

Method Summary

Modifier and Type	Method and Description
protected static void	writeFile(File output, String content) Utility method to write a content in a given file.
protected static void	writeFile(File output, StringBuilder content) Utility method to write a content in a given file.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

LINE_LENGTH

protected static final int LINE_LENGTH

The maximum length of a display line.

See Also:

Constant Field Values

output

@Parameter(property="output")
protected File output

Optional parameter to write the output of this help in a given file, instead of writing to the console.
Note: Could be a relative path.

Constructor Detail

AbstractHelpMojo

public AbstractHelpMojo()

Method Detail

writeFile

protected static void writeFile(File output,
                                StringBuilder content)
                         throws IOException

Utility method to write a content in a given file.

Parameters:

output - is the wanted output file.

content - contains the content to be written to the file.

Throws:

IOException - if any

See Also:

writeFile(File, String)

writeFile

protected static void writeFile(File output,
                                String content)
                         throws IOException

Utility method to write a content in a given file.

Parameters:

output - is the wanted output file.

content - contains the content to be written to the file.

Throws:

IOException - if any