org.geotools.console
Annotation Type Option


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

A command-line option.

Since:
2.5
Version:
$Id: Option.java 30640 2008-06-12 17:34:32Z acuster $
Author:
Martin Desruisseaux

Optional Element Summary
 java.lang.String description
          A description of this option to be printed when the --help option is provided.
 boolean mandatory
          true if this option is mandatory.
 java.lang.String name
          The argument name.
 

name

public abstract java.lang.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 java.lang.String description
A description of this option to be printed when the --help option is provided.

Returns:
The description, or "" for none.
Default:
""


Copyright © 1996-2010 Geotools. All Rights Reserved.