org.jboss.aesh.cl

Annotation Type OptionList

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

A command line option list Must be defined with a field that implements Collection Eg: --foo=bar1,bar2,bar3 or --foo bar1,bar2,bar3

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<? extends OptionActivator>	activator Define an activator for this option.
java.lang.Class<? extends OptionCompleter>	completer Define a completer for this option.
java.lang.Class<? extends Converter>	converter Define a converter if the field is a type thats not java.lang and other common types, eg: File,++ See ClConverterManager for whats added by default
java.lang.String[]	defaultValue If this options has a value the default will be auto completed if it matches the value already typed
java.lang.String	description A description of the param.
java.lang.String	name The name of the option param.
java.lang.Class<? extends OptionRenderer>	renderer Define a renderer
boolean	required Specify if this option is required
char	shortName The short option name.
java.lang.Class<? extends OptionValidator>	validator Define a validator for this option.
char	valueSeparator If set will force the option to be of the form: name[separator]value As an example, if we want to create an option like: --foo bar1,bar2

Element Detail

name

public abstract java.lang.String name

The name of the option param. The first letter will be used as the short name if shortName is not defined If name is not defined, the variable name will be used.

Default:

""

shortName

public abstract char shortName

The short option name.

Default:

0

description

public abstract java.lang.String description

A description of the param. This text will be printed out as part of a usage info.

Default:

""

valueSeparator

public abstract char valueSeparator

If set will force the option to be of the form: name[separator]value As an example, if we want to create an option like: --foo bar1,bar2

Default:

44

required

public abstract boolean required

Specify if this option is required

Default:

false

defaultValue

public abstract java.lang.String[] defaultValue

If this options has a value the default will be auto completed if it matches the value already typed

Default:

{}

converter

public abstract java.lang.Class<? extends Converter> converter

Define a converter if the field is a type thats not java.lang and other common types, eg: File,++ See ClConverterManager for whats added by default

Default:

org.jboss.aesh.cl.converter.NullConverter.class

completer

public abstract java.lang.Class<? extends OptionCompleter> completer

Define a completer for this option.

Default:

org.jboss.aesh.cl.completer.NullOptionCompleter.class

validator

public abstract java.lang.Class<? extends OptionValidator> validator

Define a validator for this option.

Default:

org.jboss.aesh.cl.validator.NullValidator.class

activator

public abstract java.lang.Class<? extends OptionActivator> activator

Define an activator for this option.

Default:

org.jboss.aesh.cl.activation.NullActivator.class

renderer

public abstract java.lang.Class<? extends OptionRenderer> renderer

Define a renderer

Default:

org.jboss.aesh.cl.renderer.NullOptionRenderer.class