org.springframework.roo.shell

Annotation Type CliOptionVisibilityIndicator

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

Annotates a method which indicates when a command option is visible depending on other options in the same command.

This annotation must only be applied to a public method which receives a ShellContext parameter and returns primitive boolean.

Since:

2.0

Author:

Sergio Clares

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	command
String	help
String[]	params

Element Detail

command

public abstract String command

Returns:

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

params

public abstract String[] params

Returns:

the list of params (options) which affect the visibility of this command option and thus we have to check.

help

public abstract String help

Returns:

the error message if the command is executed breaking this dependency