bpiwowar.argparser
Annotation Type ArgumentClass

@Retention(value=RUNTIME)
public @interface ArgumentClass

Used to mark a variable as a set of other options. If a class A contains the following code:

 
 class A {
 ...
 @ArgumentClass
 OptionsClass aClass;
 ...
 }
 
 

Calling ArgParser.addOptions(Object) with argument an instance of class A, will add the options of object OptionsClass.

The object will be created with the default constructor if not inialised

Author:

Benjamin Piwowarski

Optional Element Summary

boolean	activated The defaut activated value
String	group The default group for the options
String	help The help for this set of options
String	prefix Default prefix to add to the options
boolean	required Is the arguments in this class required? The semantics is as follows.

group

public abstract String group

The default group for the options

Returns:

Default:

""

activated

public abstract boolean activated

The defaut activated value

Returns:

Default:

true

prefix

public abstract String prefix

Default prefix to add to the options

Returns:

Default:

""

required

public abstract boolean required

Is the arguments in this class required? The semantics is as follows. If required() is

true

in the parsed class, any required argument will be required, the others won't.

false

In case this is false, then if on the command line one argument belonging to this class appears, all the required arguments become required.

Default:

false

help

public abstract String help

The help for this set of options

Default:

""