org.cyclopsgroup.jcli.annotation

Annotation Type Option

@Documented
 @Target(value={METHOD,FIELD})
 @Retention(value=RUNTIME)
public @interface Option

Option of command

Author:

Jiaqi Guo

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	defaultValue
String	description
String	displayName
String	longName
boolean	required

Element Detail

name

public abstract String name

Returns:

Short option name specified with single dash

defaultValue

public abstract String defaultValue

Returns:

Default value of option

Default:

""

description

public abstract String description

Returns:

String description of option which is displayed in usage

Default:

""

displayName

public abstract String displayName

Returns:

Display name of option

Default:

"value"

longName

public abstract String longName

Returns:

Long option name specified with double dash

Default:

""

required

public abstract boolean required

Returns:

True if option has to be specified explicitly

Default:

false