org.crsh.cmdline.annotations
Annotation Type Option


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

Annotates a field or parameter to become an command line option.

Version:
$Revision$
Author:
Julien Viet

Required Element Summary
 String[] names
          The option names, when an option name has one letter it will be used as a short switch, when it has more letter it is considered as a long switch.
 
Optional Element Summary
 Class<? extends Completer> completer
          The completer type to complete this option value.
 boolean password
          Not yet implemented.
 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 one letter it will be used as a short switch, when it has more letter it is considered as a long switch.

Returns:
the option names

password

public abstract boolean password
Not yet implemented.

Returns:
the password value
Default:
false

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.cmdline.completers.EmptyCompleter.class


Copyright © 2012 eXo Platform SAS. All Rights Reserved.