io.devcon5.cli

Annotation Type CliOption

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface CliOption

Annotation for declaring fields as CLI paramter. The parameter field gets populated by the CLI client

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The short name of the option, i.e.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	defaultValue The default value of this parameter.
String	desc The textual description of the option
boolean	hasArg True, if the paramter has an argument, default is false.
String	longOpt The long name of the option, i.e.
boolean	required True, if the parameter is required, default is false;

Element Detail

value

public abstract String value

The short name of the option, i.e. -i (without dash)

Returns:

longOpt

public abstract String longOpt

The long name of the option, i.e. --info (without dashes)

Returns:

Default:

""

desc

public abstract String desc

The textual description of the option

Returns:

Default:

""

hasArg

public abstract boolean hasArg

True, if the paramter has an argument, default is false.

Returns:

Default:

false

required

public abstract boolean required

True, if the parameter is required, default is false;

Returns:

Default:

false

defaultValue

public abstract String defaultValue

The default value of this parameter. The default value is used, when the parameter is not required and an argument has been ommitted.

Returns:

the default value as a string or null, if none is set

Default:

""