org.springframework.roo.shell

Annotation Type CliOption

@Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface CliOption

Field Summary

Fields

Modifier and Type	Fields and Description
static String	EMPTY
static String	NULL

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	key

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	help
boolean	mandatory
String	optionContext Returns a string providing context-specific information (e.g. a comma-delimited set of keywords) to the Converter that handles the annotated parameter's type.
String	specifiedDefaultValue
boolean	systemProvided
String	unspecifiedDefaultValue

Field Detail

NULL

public static final String NULL

EMPTY

public static final String EMPTY

Element Detail

key

public abstract String[] key

Returns:

the name of the option, which must be unique within this CliCommand (an empty String may be given, which would denote this option is the default for the command)

help

public abstract String help

Returns:

a help message for this option (the default is a blank String, which means there is no help)

Default:

""

mandatory

public abstract boolean mandatory

Returns:

true if this option must be specified one way or the other by the user (defaults to false)

Default:

false

optionContext

public abstract String optionContext

Returns a string providing context-specific information (e.g. a comma-delimited set of keywords) to the Converter that handles the annotated parameter's type.

For example, if a method parameter "thing" of type "Thing" is annotated as follows:

Returns:

a non-null string (can be empty)

Default:

""

specifiedDefaultValue

public abstract String specifiedDefaultValue

Returns:

the default value to use if this option is included by the user, but they didn't specify an actual value (most commonly used for flags; defaults to __NULL__, which causes null to be presented to any non-primitive parameter)

Default:

"__NULL__"

systemProvided

public abstract boolean systemProvided

Returns:

if true, the user cannot specify this option and it is provided by the shell infrastructure (defaults to false)

Default:

false

unspecifiedDefaultValue

public abstract String unspecifiedDefaultValue

Returns:

the default value to use if this option is unspecified by the user (defaults to __NULL__, which causes null to be presented to any non-primitive parameter)

Default:

"__NULL__"