org.apache.karaf.tooling.cmdhelp

Class CmdHelpMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.karaf.tooling.cmdhelp.CmdHelpMojo

All Implemented Interfaces:

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

public class CmdHelpMojo
extends org.apache.maven.plugin.AbstractMojo

Generates help (in scalate or docbook format) for Karaf commands

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CmdHelpMojo.HelpPrinter

Field Summary

Fields

Modifier and Type	Field and Description
protected String	classLoader The classloader to use for loading the commands
protected String	format The output format
protected boolean	includeHelpOption Adds the --help option to every commands documentation
protected org.apache.maven.project.MavenProject	project The maven project.
protected File	targetFolder The output folder

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

ROLE

Constructor Summary

Constructors

Constructor and Description
CmdHelpMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()

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

Field Detail

project

protected org.apache.maven.project.MavenProject project

The maven project.

targetFolder

protected File targetFolder

The output folder

format

protected String format

The output format

classLoader

protected String classLoader

The classloader to use for loading the commands

includeHelpOption

protected boolean includeHelpOption

Adds the --help option to every commands documentation

Constructor Detail

CmdHelpMojo

public CmdHelpMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException