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 equivalent to the CLI options with any unsupported options removed.

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final AntOptionCollection	INSTANCE	The instance of the AntOptionCollection

Method Summary

Modifier and Type	Method	Description
static AntOptionCollection.Builder	builder()
Set<AntOption>	convertedFrom(AntOption antOption)
AntOption	getActualAntOption(AntOption antOption)	If this option is converted to another option return that option otherwise return this option.
static Map<String,String>	getRenameMap()
Map<String,String>	getRequiredAttributes(String name)
boolean	isAttribute(AntOption antOption)

Methods inherited from class UIOptionCollection

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

Methods inherited from class Object

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

Field Details

INSTANCE

public static final AntOptionCollection INSTANCE

The instance of the AntOptionCollection

Method Details

getRenameMap

public static Map<String,String> getRenameMap()

convertedFrom

public Set<AntOption> convertedFrom(AntOption antOption)

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)

getRequiredAttributes

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

builder

public static AntOptionCollection.Builder builder()