Package org.apache.rat.documentation.options

Class MavenOption

java.lang.Object

org.apache.rat.documentation.options.AbstractOption

org.apache.rat.documentation.options.MavenOption

public class MavenOption
extends AbstractOption

A representation of a CLI option as a Maven option

Field Summary

Fields inherited from class org.apache.rat.documentation.options.AbstractOption

argumentType, name, option, PATTERN

Constructor Summary

Constructors

Constructor	Description
MavenOption(org.apache.commons.cli.Option option)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected String	cleanupName(org.apache.commons.cli.Option option)	Provide means to wrap the given option depending on the UI-specific option implementation.
String	getDefaultValue()	Return default value.
String	getExample()	Gets an example of how to use this option in the native UI.
static Set<org.apache.commons.cli.Option>	getFilteredOptions()	Gets the set of options that are not supported by Maven.
static List<MavenOption>	getMavenOptions()
String	getMethodSignature(String indent, boolean multiple)
String	getPropertyAnnotation(String fname)
static Map<String,String>	getRenameMap()
String	getText()	return a string showing long and short options if they are available.

Methods inherited from class org.apache.rat.documentation.options.AbstractOption

argCount, cleanup, cleanupName, getArgName, getArgType, getDeprecated, getDescription, getName, getOption, getType, hasArg, hasArgs, isDeprecated, isRequired, keyValue

Methods inherited from class java.lang.Object

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

Constructor Details

MavenOption

public MavenOption(org.apache.commons.cli.Option option)

Constructor.

Parameters:

option - The CLI option

Method Details

getMavenOptions

public static List<MavenOption> getMavenOptions()

getRenameMap

public static Map<String,String> getRenameMap()

getFilteredOptions

public static Set<org.apache.commons.cli.Option> getFilteredOptions()

Gets the set of options that are not supported by Maven.

Returns:

The set of options that are not supported by Maven.

cleanupName

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

Description copied from class: AbstractOption

Provide means to wrap the given option depending on the UI-specific option implementation.

Specified by:

cleanupName in class AbstractOption

Parameters:

option - The CLI option

Returns:

the cleaned up option name.

getText

public String getText()

Description copied from class: AbstractOption

return a string showing long and short options if they are available. Will return a string.

Specified by:

getText in class AbstractOption

Returns:

A string showing long and short options if they are available. Never null.

getDefaultValue

public String getDefaultValue()

Description copied from class: AbstractOption

Return default value.

Overrides:

getDefaultValue in class AbstractOption

Returns:

default value or null if no argument given.

getPropertyAnnotation

public String getPropertyAnnotation(String fname)

getMethodSignature

public String getMethodSignature(String indent,
 boolean multiple)

getExample

public String getExample()

Description copied from class: AbstractOption

Gets an example of how to use this option in the native UI.

Specified by:

getExample in class AbstractOption

Returns:

An example of how to use this option in the native UI.