com.logicbig.cli.annotation

Annotation Type Option

@Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface Option

Method parameter annotated with Option defines an option argument. The method must be annotated with Command annotation. Option is specified with double hyphen. e.g. --myoption=<option-value> Created by Joe on 11/14/2015.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	desc The description of the option.
String	name The name of the option

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	mandatory Specifies if this option is mandatory.
String[]	valuesAllowed Values allowed for this option.

Element Detail

name

public abstract String name

The name of the option

Returns:

desc

public abstract String desc

The description of the option.

Returns:

valuesAllowed

public abstract String[] valuesAllowed

Values allowed for this option.

Returns:

Default:

{}

mandatory

public abstract boolean mandatory

Specifies if this option is mandatory. If yes user must have to enter the value for it.

Returns:

Default:

false