Class CLIOption

java.lang.Object

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

org.apache.rat.CLIOption

public final class CLIOption
extends UIOption<CLIOption>

The CLI option definition.

Field Summary

Fields inherited from class UIOption

argumentType, name, option, optionCollection, PATTERN

Constructor Summary

Constructors

Constructor	Description
CLIOption(UIOptionCollection<CLIOption> collection, org.apache.commons.cli.Option option)

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

Methods inherited from class UIOption

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

Methods inherited from class Object

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

Constructor Details

CLIOption

public CLIOption(UIOptionCollection<CLIOption> collection,
 org.apache.commons.cli.Option option)

Method Details

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

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

Parameters:

option - The CLI option

Returns:

the cleaned up option name.

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

Returns:

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