org.springframework.roo.shell

Annotation Type CliOptionAutocompleteIndicator

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface CliOptionAutocompleteIndicator

Annotates a method which returns possible values for an option, replacing other Converters. These possible values could depend on other options in the same command.

This annotation must only be applied to a public method which receives ShellContext and String parameters and returns a String List.

Since:

2.0

Author:

Sergio Clares

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	command
String	help
String	param

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	includeSpaceOnFinish
boolean	validate

Element Detail

command

public abstract String command

Returns:

the name of the command that contains the option to check values.

param

public abstract String param

Returns:

the param (option) which needs to return its possible values.

help

public abstract String help

Returns:

the error message if the command is executed breaking this dependency

includeSpaceOnFinish

public abstract boolean includeSpaceOnFinish

Returns:

true if autocomplete operation should include an space on finish when only one result has been returned.

Default:

true

validate

public abstract boolean validate

Returns:

true if values introduced should be validated on command execution.

Default:

true