org.conqat.lib.commons.options

Annotation Type Option

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

Annotation for exposing methods as command line options. This should only be used with methods taking zero or one parameters.

Author:

Benjamin Hummel

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	description The description of this option used for usage messages.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	greedy If this is set to true, all non-option arguments following the annotated option are used for this option.
java.lang.String	longName The optional long (i.e.
char	shortName The optional short (i.e.

Element Detail

description

public abstract java.lang.String description

The description of this option used for usage messages.

shortName

public abstract char shortName

The optional short (i.e. single character) name of the option.

Default:

0

longName

public abstract java.lang.String longName

The optional long (i.e. multi-character) name of the option.

Default:

""

greedy

public abstract boolean greedy

If this is set to true, all non-option arguments following the annotated option are used for this option. This results in multiple calls to this options setter method.

Default:

false