uk.co.flamingpenguin.jewel.cli
Annotation Type Option

Deprecated. please use Option instead

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

Tags a method as an option

Author:

Tim Wood

Optional Element Summary

boolean	defaultToNull Deprecated. The default value is null.
String[]	defaultValue Deprecated. The default value if none is specified
String	description Deprecated. A description of this option
boolean	helpRequest Deprecated. Should help be displayed if this option is present.
String[]	longName Deprecated. The long name of this option
String	pattern Deprecated. The regexp that the values of this option must match
String[]	shortName Deprecated. The short name of this option

longName

public abstract String[] longName

Deprecated.

The long name of this option

Returns:

The long name of this option

Default:

{}

shortName

public abstract String[] shortName

Deprecated.

The short name of this option

Returns:

The short name of this option

Default:

""

pattern

public abstract String pattern

Deprecated.

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

Deprecated.

A description of this option

Returns:

A description of this option

Default:

""

defaultValue

public abstract String[] defaultValue

Deprecated.

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

Deprecated.

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

Deprecated.

Should help be displayed if this option is present.

Returns:

True if this option is a help option

Default:

false