org.crsh.cli

Annotation Type Option

@Target(value={FIELD,PARAMETER,ANNOTATION_TYPE})
@Retention(value=RUNTIME)
public @interface Option

An option command parameter.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	names The option names, when an option name has a single letter it will be used as a short switch, when it has two letters or more it is considered as a long switch.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends Completer>	completer The completer type to complete this option value.
boolean	unquote Indicates whether or not the value should be unquoted.

Element Detail

names

public abstract String[] names

The option names, when an option name has a single letter it will be used as a short switch, when it has two letters or more it is considered as a long switch.

Returns:

the option names

unquote

public abstract boolean unquote

Indicates whether or not the value should be unquoted.

Returns:

the unquote value

Default:

true

completer

public abstract Class<? extends Completer> completer

The completer type to complete this option value.

Returns:

the completer type

Default:

org.crsh.cli.completers.EmptyCompleter.class