Class MavenOption

java.lang.Object

org.apache.rat.ui.UIOption<MavenOption>

org.apache.rat.documentation.options.MavenOption

public final class MavenOption
extends UIOption<MavenOption>

A representation of a Maven option based on a CLI option.

Field Summary

Fields inherited from class UIOption

argumentType, name, option, optionCollection, PATTERN

Method Summary

Modifier and Type	Method	Description
protected String	cleanupName(org.apache.commons.cli.Option option)
String	getExample()
String	getExample(String... args)	Create example text for the option.
String	getMethodName()	Gets the method name for this option.
String	getMethodSignature(String indent, boolean multiple)
String	getPropertyAnnotation(String fname)
String	getText()
String	toString()

Methods inherited from class UIOption

cleanup, getArgName, getArgType, getCasedName, getDefaultValue, getDeprecated, getDescription, getName, getOption, getOptionCollection, getType, hasArg, hasArgs, isDeprecated, isRequired, keyValue

Methods inherited from class Object

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

Method Details

toString

public String toString()

Overrides:

toString in class Object

getMethodName

public String getMethodName()

Gets the method name for this option.

Returns:

the method name for this option.

cleanupName

protected String cleanupName(org.apache.commons.cli.Option option)

Specified by:

cleanupName in class UIOption<MavenOption>

getText

public String getText()

Specified by:

getText in class UIOption<MavenOption>

getExample

public String getExample()

Specified by:

getExample in class UIOption<MavenOption>

getExample

public String getExample(String... args)

Create example text for the option.

Parameters:

args - the example arguments for the option.

Returns:

a formatted option.

getMethodSignature

public String getMethodSignature(String indent,
 boolean multiple)

getPropertyAnnotation

public String getPropertyAnnotation(String fname)