com.beust.jcommander

Annotation Type DynamicParameter

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	assignment The character(s) used to assign the values.
String	description A description of this option.
String	descriptionKey The key used to find the string in the message bundle.
boolean	hidden If true, this parameter won't appear in the usage().
String[]	names An array of allowed command line parameters (e.g.
int	order If specified, this number will be used to order the description of this parameter when usage() is invoked.
boolean	required Whether this option is required.
Class<? extends IValueValidator>[]	validateValueWith
Class<? extends IParameterValidator>[]	validateWith The validation classes to use.

Element Detail

names

public abstract String[] names

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

Default:

{}

required

public abstract boolean required

Whether this option is required.

Default:

false

description

public abstract String description

A description of this option.

Default:

""

descriptionKey

public abstract String descriptionKey

The key used to find the string in the message bundle.

Default:

""

hidden

public abstract boolean hidden

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

Default:

false

validateWith

public abstract Class<? extends IParameterValidator>[] validateWith

The validation classes to use.

Default:

com.beust.jcommander.validators.NoValidator.class

assignment

public abstract String assignment

The character(s) used to assign the values.

Default:

"="

validateValueWith

public abstract Class<? extends IValueValidator>[] validateValueWith

Default:

com.beust.jcommander.validators.NoValueValidator.class

order

public abstract int order

If specified, this number will be used to order the description of this parameter when usage() is invoked.

Returns:

Default:

-1