org.jboss.aesh.cl

Annotation Type Option

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

A single command line option. It keep information regarding the short option name (-f) and long option name (--foo). A flag to specify if this option is required and a description. Both "=" and space is valid name-value separators. If the field is either Boolean or boolean it will be

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.String	argument A description on what kind of value is used 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.
boolean	hasValue Specify if this option accept values.
java.lang.String	name The name of the option param.
boolean	overrideRequired When this is set to true and used it will override missing Options that are required by the Command.
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.

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 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:

""

argument

public abstract java.lang.String argument

A description on what kind of value is used for this option.

Default:

""

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:

{}

hasValue

public abstract boolean hasValue

Specify if this option accept values. Only accepted to be false for Boolean/boolean

Default:

true

overrideRequired

public abstract boolean overrideRequired

When this is set to true and used it will override missing Options that are required by the Command.

Default:

false

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