bpiwowar.argparser
Annotation Type Argument


@Retention(value=RUNTIME)
public @interface Argument

Marks a field that should be accessible from the command line To check integrity, use ArgumentPostProcessor

Author:
Benjamin Piwowarski

Optional Element Summary
 boolean[] activated
          Is this option active by defaut (true by default)?
 Class<? extends ValueChecker>[] checkers
          List of value checkers (see ValueChecker)
 boolean displayDefault
          Should the default value be displayed ?
 String group
          The group the option belongs to
 Class<? extends Handler> handler
          Fully qualified name of the wrapper object
 String help
          The help string
 String id
          The ID of the option in case one wants to refer to it
 String[] intervals
          Deprecated. 
 String[] name
          How to use the option on the command line (each name will be prefixed by --)
 String[] names
          Deprecated. 
 String prefix
          Prefix for sub-options
 boolean[] required
          Is this option mandatory (false by default)?
 

names

@Deprecated
public abstract String[] names
Deprecated. 

List of options in the command line

Default:
{}

name

public abstract String[] name
How to use the option on the command line (each name will be prefixed by --)

Default:
{}

help

public abstract String help
The help string

Default:
""

group

public abstract String group
The group the option belongs to

Default:
""

handler

public abstract Class<? extends Handler> handler
Fully qualified name of the wrapper object

Default:
bpiwowar.argparser.handlers.Handler.class

displayDefault

public abstract boolean displayDefault
Should the default value be displayed ?

Default:
false

intervals

@Deprecated
public abstract String[] intervals
Deprecated. 

The valid intervals of values In case of arrays, this can be a list of intervals Example: [0,1),(2,3] Note that intervals are converted by the handler

Default:
{}

checkers

public abstract Class<? extends ValueChecker>[] checkers
List of value checkers (see ValueChecker)

Default:
{}

required

public abstract boolean[] required
Is this option mandatory (false by default)?

Default:
{}

activated

public abstract boolean[] activated
Is this option active by defaut (true by default)?

Default:
{}

id

public abstract String id
The ID of the option in case one wants to refer to it

Default:
""

prefix

public abstract String prefix
Prefix for sub-options

Default:
""


Copyright © 2013. All Rights Reserved.