Package org.apache.rat.documentation.options

Class AntOptionCollection

java.lang.Object

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

org.apache.rat.documentation.options.AntOptionCollection

public final class AntOptionCollection
extends UIOptionCollection<AntOption>

The collection of AntOptions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AntOptionCollection.Builder	The Builder for the AntOptionCollection.
static class	AntOptionCollection.BuildType	A mapping of data type of XML format.

Constructor Summary

Constructors

Constructor	Description
AntOptionCollection()	Creates an instance of the AntOption Collection.

Method Summary

Modifier and Type	Method	Description
Set<AntOption>	convertedFrom(AntOption antOption)	Returns the set of AntOptions that the argument was converted from.
AntOption	getActualAntOption(AntOption antOption)	If this option is converted to another option return that option otherwise return this option.
static Map<String,String>	getRenameMap()	Gets the map of standard Option names that are renamed to fit the Ant naming process.
Map<String,String>	getRequiredAttributes(String name)	Gets a map of attributes that are required for the example data.
boolean	isAttribute(AntOption antOption)	Returns true if this argument is an attribute to the Ant RAT call.
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

AntOptionCollection

public AntOptionCollection()

Creates an instance of the AntOption Collection.

Method Details

getRenameMap

public static Map<String,String> getRenameMap()

Gets the map of standard Option names that are renamed to fit the Ant naming process.

Returns:

the map of renamed Options.

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<AntOption>

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.

convertedFrom

public Set<AntOption> convertedFrom(AntOption antOption)

Returns the set of AntOptions that the argument was converted from.

Parameters:

antOption - the AntOption to check.

Returns:

returns a Set of AntOptions that were converted to the argument. May be an empty set.

getActualAntOption

public AntOption getActualAntOption(AntOption antOption)

If this option is converted to another option return that option otherwise return this option.

Returns:

the converted option.

isAttribute

public boolean isAttribute(AntOption antOption)

Returns true if this argument is an attribute to the Ant RAT call.

Parameters:

antOption - the AntOption to check.

Returns:

true if this argument is an attribute to the Ant RAT call.

getRequiredAttributes

public Map<String,String> getRequiredAttributes(String name)

Gets a map of attributes that are required for the example data.

Parameters:

name - the attribute name to lookup.

Returns:

the map of attributes that are required for the example data.