Top Description Fields Methods

io.vertx.core.cli.annotations

public @Interface Option

Annotations

extends Annotation

@Target:METHOD
@Retention:RUNTIME

Imports

java.lang.annotation.ElementType, .Retention, .RetentionPolicy, .Target

Annotates a setter to be called with the value of a command line option. Setter have been preferred to field to allow validation.

The cardinality of the option is detected from the single method parameter type: arrays, list and set can receive several values.

Author: Clement Escoffier
See Also: Argument

Field Summary

Modifier and Type	Field and Description
public static final String	NO_NAME

Method Summary

Modifier and Type	Method and Description
public boolean	acceptMultipleValues() Whether or not the option accept multiple values.
public boolean	acceptValue() Whether or not the option accept a value.
public String	argName() The name of this argument (used in doc)
public String[]	choices() The set of choices accepted as values by this option.
public boolean	flag() Whether or not the option can be used as a flag (meaning no value)
public boolean	help() Whether or not this option is a "Help" option.
public String	longName() The name of the option (without the `--` prefix).
public boolean	required() Whether or not the option is required.
public String	shortName() The short option name (without the `-` prefix).

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Field Detail

NO_NAME	back to summary
public static final String NO_NAME

Method Detail

acceptMultipleValues	back to summary
public boolean acceptMultipleValues() Whether or not the option accept multiple values. If the setter accepts an array, a list, a set, or a collection as parameter, it automatically detect it accepts multiple values.

acceptValue	back to summary
public boolean acceptValue() Whether or not the option accept a value. If the setter accepts an array, a list, a set, or a collection as parameter, it automatically detect it accepts multiple values.

argName	back to summary
public String argName() The name of this argument (used in doc)

choices	back to summary
public String[] choices() The set of choices accepted as values by this option. No need to call this methods for enums.

flag	back to summary
public boolean flag() Whether or not the option can be used as a flag (meaning no value)

help	back to summary
public boolean help() Whether or not this option is a "Help" option. Help options are generally flag.

longName	back to summary
public String longName() The name of the option (without the `--` prefix). Defaults to a name based on the setter name

required	back to summary
public boolean required() Whether or not the option is required.

shortName	back to summary
public String shortName() The short option name (without the `-` prefix). If not given the option has no short name.