com.lexicalscope.jewel.cli

Annotation Type Option

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

Tags a method as an option

Author:

Tim Wood

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	defaultToNull The default value is null.
String[]	defaultValue The default value if none is specified
String	description A description of this option
int	exactly Multivalued option must have exactly this many values
boolean	helpRequest Should help be displayed if this option is present.
boolean	hidden Option is not displayed in help messages.
String[]	longName The long name of this option
int	maximum Multivalued option can have at most this many values
int	minimum Multivalued option must have at least this many values
String	pattern The regexp that the values of this option must match
String[]	shortName The short name of this option

Element Detail

longName

public abstract String[] longName

The long name of this option

Returns:

The long name of this option

Default:

{}

shortName

public abstract String[] shortName

The short name of this option

Returns:

The short name of this option

Default:

""

pattern

public abstract String pattern

The regexp that the values of this option must match

Returns:

The regexp that the values of this option must match

Default:

".*"

description

public abstract String description

A description of this option

Returns:

A description of this option

Default:

""

defaultValue

public abstract String[] defaultValue

The default value if none is specified

Returns:

The value to present if none is specified

Default:

"7acb394c-4c4f-4414-89df-28a62e785507?39858"

defaultToNull

public abstract boolean defaultToNull

The default value is null. Java does not allow null values in annotations. Setting this attribute to true will default the value of the option to null.

Returns:

true iff the default value of the option should be null

Default:

false

helpRequest

public abstract boolean helpRequest

Should help be displayed if this option is present.

Returns:

True if this option is a help option

Default:

false

hidden

public abstract boolean hidden

Option is not displayed in help messages. Probably best not to use this with mandatory options.

Returns:

the option is not displayed in any help messages

Default:

false

minimum

public abstract int minimum

Multivalued option must have at least this many values

Returns:

Multivalued option must have at least this many values

Default:

-1

exactly

public abstract int exactly

Multivalued option must have exactly this many values

Returns:

Multivalued option must have exactly this many values

Default:

-1

maximum

public abstract int maximum

Multivalued option can have at most this many values

Returns:

Multivalued option can have at most this many values

Default:

2147483647