Package org.apache.rat.documentation.options

Class CLIOption

java.lang.Object

org.apache.rat.documentation.options.AbstractOption

org.apache.rat.documentation.options.CLIOption

public class CLIOption
extends AbstractOption

Field Summary

Fields inherited from class org.apache.rat.documentation.options.AbstractOption

argumentType, name, option, PATTERN

Constructor Summary

Constructors

Constructor	Description
CLIOption(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.
static String	createName(org.apache.commons.cli.Option 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.

Methods inherited from class org.apache.rat.documentation.options.AbstractOption

argCount, cleanup, cleanupName, getArgName, getArgType, getDefaultValue, getDeprecated, getDescription, getName, getOption, getType, hasArg, hasArgs, isDeprecated, isRequired, keyValue

Methods inherited from class java.lang.Object

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

Constructor Details

CLIOption

public CLIOption(org.apache.commons.cli.Option option)

Method Details

createName

public static String createName(org.apache.commons.cli.Option option)

getText

public String getText()

Description copied from class: AbstractOption

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

Specified by:

getText in class AbstractOption

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: AbstractOption

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

Specified by:

cleanupName in class AbstractOption

Parameters:

option - The CLI option

Returns:

the cleaned up option name.

getExample

public String getExample()

Description copied from class: AbstractOption

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

Specified by:

getExample in class AbstractOption

Returns:

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