Package org.apache.rat.documentation.options

Class MavenOption

java.lang.Object

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

org.apache.rat.documentation.options.MavenOption

public final class MavenOption
extends UIOption<MavenOption>

A representation of a Maven option based on an option.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MavenOption.MavenOptionBuilder	The builder for the MavenOptions.

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
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	getExample(String... args)	Create example text for the option.
String	getMethodName()	Gets the method name for this option.
String	getMethodSignature(String indent, boolean multiple)	Gets the Maven Mojo method signature for this Option.
String	getParameterAnnotation(String camelName)	Creates the @Parameter annotation for this option.
String	getText()	return a string showing long and short options if they are available.
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

toString

public String toString()

Overrides:

toString in class Object

getMethodName

public String getMethodName()

Gets the method name for this option.

Returns:

the method name for this option.

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

Parameters:

option - The CLI option

Returns:

the cleaned up option name.

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

Returns:

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

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

Returns:

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

getExample

public String getExample(String... args)

Create example text for the option.

Parameters:

args - the example arguments for the option.

Returns:

a formatted option.

getMethodSignature

public String getMethodSignature(String indent,
 boolean multiple)

Gets the Maven Mojo method signature for this Option.

Parameters:

indent - the number of spaces to indent the text.

multiple - true if this option takes multiple arguments.

Returns:

the method signature for this Option.

getParameterAnnotation

public String getParameterAnnotation(String camelName)

Creates the @Parameter annotation for this option.

Parameters:

camelName - the camel cased name for this option.

Returns:

the string that is the parameter annotation.