org.springframework.roo.shell
Annotation Type CliOption

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

Required Element Summary

String[]

key

Optional Element Summary

String	help
boolean	mandatory
String	optionContext
String	specifiedDefaultValue
boolean	systemProvided
String	unspecifiedDefaultValue

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)

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

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

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__"

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__"

optionContext

public abstract String optionContext

Returns:

the name of a context which will be available to the PropertyEditor and Completor when being asked to process the option (defaults to an empty String, meaning no option context is set)

Default:

""

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:

""