io.airlift.command

Annotation Type Option

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

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	name An array of allowed command line parameters (e.g.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	allowedValues
int	arity How many parameter values this option will consume.
String	description A description of this option.
boolean	hidden If true, this parameter won't appear in the usage().
boolean	required Whether this option is required.
String	title Name use to identify the option value in documentation and error messages.
OptionType	type Is this a command, group or global option

Element Detail

name

public abstract String[] name

An array of allowed command line parameters (e.g. "-n", "--name", etc...).

type

public abstract OptionType type

Is this a command, group or global option

Default:

io.airlift.command.OptionType.COMMAND

title

public abstract String title

Name use to identify the option value in documentation and error messages.

Default:

""

description

public abstract String description

A description of this option.

Default:

""

required

public abstract boolean required

Whether this option is required.

Default:

false

arity

public abstract int arity

How many parameter values this option will consume. For example, an arity of 2 will allow "-pair value1 value2".

Default:

-2147483648

hidden

public abstract boolean hidden

If true, this parameter won't appear in the usage().

Default:

false

allowedValues

public abstract String[] allowedValues

Default:

{}