com.github.raphcal.argparser

Annotation Type Option

@Retention(value=RUNTIME)
public @interface Option

Describes an option (also called a flag).

Author:

Raphaël Calabro (ddaeke-github@yahoo.fr)

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description Description to print in the usage.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	alias Alias to use instead of the property name for the option.
boolean	autonomous Should be set to true if this option can be used without the required arguments (for example: help option or version option).

Element Detail

description

public abstract String description

Description to print in the usage.

Returns:

the description of the description.

alias

public abstract String alias

Alias to use instead of the property name for the option.

Useful to change an option name from camelCase to dash-case.

Returns:

the alias of the option.

Default:

""

autonomous

public abstract boolean autonomous

Should be set to true if this option can be used without the required arguments (for example: help option or version option).

Returns:

true if this option is autonomous, false otherwise.

Default:

false