Package org.apache.rat.documentation.options

Class MavenOptionCollection

java.lang.Object

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

org.apache.rat.documentation.options.MavenOptionCollection

public final class MavenOptionCollection
extends UIOptionCollection<MavenOption>

The collection of MavenOptions equivalent to the CLI options with any unsupported options removed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MavenOptionCollection.Builder	The Builder for the MavenOptionCollection.

Constructor Summary

Constructors

Constructor	Description
MavenOptionCollection()	Create an instance.

Method Summary

Modifier and Type	Method	Description
static Map<String,String>	getRenameMap()	Gets the map of renamed Options indexed by original option name.
String	rename(org.apache.commons.cli.Option option)	Extracts the UI based name string for an option.

Methods inherited from class org.apache.rat.ui.UIOptionCollection

additionalOptions, defaultValue, getDescription, getMappedOption, getMappedOptions, getOptionMap, getOptions, getSelected, getUnsupportedOptions, isSelected, resetSelected

Methods inherited from class java.lang.Object

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

Constructor Details

MavenOptionCollection

public MavenOptionCollection()

Create an instance.

Method Details

getRenameMap

public static Map<String,String> getRenameMap()

Gets the map of renamed Options indexed by original option name.

Returns:

the map of renamed Options indexed by original option name.

rename

public String rename(org.apache.commons.cli.Option option)

Description copied from class: UIOptionCollection

Extracts the UI based name string for an option. The default implementation return the string returned by ArgumentTracker.extractKey(Option)

Overrides:

rename in class UIOptionCollection<MavenOption>

Parameters:

option - the option to create the name for.

Returns:

the name for the option in the UICollection name, may be the same as the option name.