Package org.apache.rat.testhelpers

Class BaseOption

java.lang.Object

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

org.apache.rat.testhelpers.BaseOption

public final class BaseOption
extends UIOption<BaseOption>

An implementation of UIOption to use in general (non-UI limited or adjusted) testing.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseOption.BaseOptionBuilder	The BaseOptionBuilder implementation.

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
BaseOption.BaseOptionBuilder	builder()	Creates a builder for the BaseOption.
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 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, toString, wait, wait, wait

Method Details

builder

public BaseOption.BaseOptionBuilder builder()

Creates a builder for the BaseOption.

Returns:

the BaseOptionBuilder.

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

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

Returns:

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

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

Returns:

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