org.seedstack.seed.command

Annotation Type Option

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

This annotation marks fields of a command to be injected with the option value set at command invocation.

Required Element Summary

Required Elements

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	defaultValue The default value of the option.
String	description The description of the option (used by the help command).
boolean	hasArgument If the option has an argument (i.e.
String	longName The long name of the option.
boolean	mandatory If the command is mandatory.

Element Detail

name

public abstract String name

The short name of the option.

hasArgument

public abstract boolean hasArgument

If the option has an argument (i.e. value).

Default:

false

longName

public abstract String longName

The long name of the option.

Default:

""

description

public abstract String description

The description of the option (used by the help command).

Default:

""

mandatory

public abstract boolean mandatory

If the command is mandatory.

Default:

false

defaultValue

public abstract String defaultValue

The default value of the option.

Default:

""