com.ziesemer.utils.cli

Annotation Type Parameter

@Target(value={FIELD,METHOD})
 @Retention(value=RUNTIME)
public @interface Parameter

Author:

Mark A. Ziesemer <www.ziesemer.com>

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	argCount The number of argument values this option can take.
String	argName The display name of the argument value.
boolean	argOptional If the option can have an optional argument.
String	description The description of the option.
String	groupId Any other options sharing this same key / identifier will be placed into an OptionGroup (a group of mutually exclusive options).
String	longName The long name of the option.
String	name The name of the option.
boolean	required If the option is required.
char	valueSeparator The character used to separate values.

Element Detail

name

public abstract String name

The name of the option.

See Also:

Option.getOpt()

Default:

""

longName

public abstract String longName

The long name of the option. If both the name and the long name are unspecified, the name of the declaring field or method will be used here.

See Also:

Option.getLongOpt()

Default:

""

description

public abstract String description

The description of the option.

See Also:

Option.getDescription()

Default:

""

argName

public abstract String argName

The display name of the argument value.

See Also:

Option.getArgName()

Default:

""

argCount

public abstract int argCount

The number of argument values this option can take. If unspecified, 1 will be used for a field, or the number of parameters in a method will be used for a method.

See Also:

Option.getArgs()

Default:

-2147483648

argOptional

public abstract boolean argOptional

If the option can have an optional argument.

See Also:

Option.setOptionalArg(boolean)

Default:

false

valueSeparator

public abstract char valueSeparator

The character used to separate values.

See Also:

Option.getValueSeparator()

Default:

0

required

public abstract boolean required

If the option is required.

See Also:

Option.isRequired()

Default:

false

groupId

public abstract String groupId

Any other options sharing this same key / identifier will be placed into an OptionGroup (a group of mutually exclusive options).

Default:

""