Package org.apache.rat.documentation.options

Class AntOption

java.lang.Object

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

org.apache.rat.documentation.options.AntOption

public final class AntOption
extends UIOption<AntOption>

A class that wraps the CLI option and provides Ant specific values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AntOption.AntOptionBuilder	The Builder for AntOptions.
class	AntOption.ExampleGenerator	An example code generator for this AntOption.

Nested classes/interfaces inherited from class org.apache.rat.ui.UIOption

UIOption.Builder<T extends UIOption<T>,B extends UIOption.Builder<T,B>>

Field Summary

Fields inherited from class org.apache.rat.ui.UIOption

argumentType, name, option, optionCollection, PATTERN

Method Summary

Modifier and Type	Method	Description
AntOptionCollection.BuildType	buildType()	Gets the Ant build type for this option.
String	cleanupName()	Cleans up the name of this AntOption.
protected String	cleanupName(org.apache.commons.cli.Option option)	Provide means to wrap the given option depending on the UI-specific option implementation.
Set<AntOption>	convertedFrom()	Gets the set of options that are mapped to this option.
AntOption	getActualAntOption()	If this option is converted to another option return that option otherwise return this option.
String	getExample()	Gets an example of how to use this option in the native UI.
String	getText()	return a string showing long and short options if they are available.
boolean	isAttribute()	Returns true if the option should be an attribute of the <rat:report> element.
boolean	isElement()	Returns true if the option should be a child element of the <rat:report> element.
String	toString()

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

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

isAttribute

public boolean isAttribute()

Returns true if the option should be an attribute of the <rat:report> element.

Returns:

true if the option should be an attribute of the <rat:report> element.

toString

public String toString()

Overrides:

toString in class Object

isElement

public boolean isElement()

Returns true if the option should be a child element of the <rat:report> element.

Returns:

true if the option should be a child element of the <rat:report> element.

getActualAntOption

public AntOption getActualAntOption()

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

Returns:

the converted option.

convertedFrom

public Set<AntOption> convertedFrom()

Gets the set of options that are mapped to this option. This is used to allow one implementation to answer for multiple options.

Returns:

the set of options that are mapped to this option.

getText

public String getText()

Description copied from class: UIOption

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

Specified by:

getText in class UIOption<AntOption>

Returns:

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

cleanupName

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

Description copied from class: UIOption

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

Specified by:

cleanupName in class UIOption<AntOption>

Parameters:

option - The CLI option

Returns:

the cleaned up option name.

cleanupName

public String cleanupName()

Cleans up the name of this AntOption. Used in documentation. Returns either <name> or name attribute.

Returns:

the cleaned up name.

buildType

public AntOptionCollection.BuildType buildType()

Gets the Ant build type for this option.

Returns:

the Ant build type for this option.

getExample

public String getExample()

Description copied from class: UIOption

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

Specified by:

getExample in class UIOption<AntOption>

Returns:

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