org.geotools.console

Annotation Type Option

@Documented
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface Option

A command-line option.

Since:

2.5

Author:

Martin Desruisseaux

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A description of this option to be printed when the --help option is provided.
boolean	mandatory true if this option is mandatory.
String	name The argument name.

Element Detail

name

public abstract String name

The argument name. The default is the same name than the field.

Returns:

The argument name, or "" for the default.

Default:

""

mandatory

public abstract boolean mandatory

true if this option is mandatory. Options are optional by default.

Returns:

Whatever this option is mandatory or optional.

Default:

false

description

public abstract String description

A description of this option to be printed when the --help option is provided.

Returns:

The description, or "" for none.

Default:

""