org.geotoolkit.console
Annotation Type Action

@Documented
@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface Action

Annotates a method to be invoked when the first argument which is not an option matches the name. This annotation contains non-localized informations like the name. This annotation does not contain the description to be printed when the user ask for help because such description is local-dependent. The description must be provided in a properties file under the following rules:

• The properties filename is the name of the class that contains the annotated method, and is located in the same package. It may contain a language suffix as described in the ResourceBundle class.
• The key is the value returned by name(), or the method name if no name is explicitly given.

Since:

3.00

Version:

3.00

Author:

Martin Desruisseaux (Geomatys)

Module:

utility/geotk-utility (download)

View source code for this class

Optional Element Summary

String[]	examples Examples of usage of this action.
int	maximalArgumentCount The maximal number of arguments expected after the action name.
int	minimalArgumentCount The minimal number of arguments expected after the action name.
String	name The action name.

name

public abstract String name

The action name. The default is the same name than the method.

Returns:

The action name, or "" for the default.

Default:

""

examples

public abstract String[] examples

Examples of usage of this action.

Returns:

Examples of usage of this action, or an empty array for none.

Default:

{}

minimalArgumentCount

public abstract int minimalArgumentCount

The minimal number of arguments expected after the action name. The default value is 0, which means that there is no minimum.

Returns:

The minimum number of arguments.

Default:

0

maximalArgumentCount

public abstract int maximalArgumentCount

The maximal number of arguments expected after the action name. The default value is Integer.MAX_VALUE, which means that there is no maximum.

Returns:

The maximum number of arguments.

Default:

2147483647