org.josef.util.args

Annotation Type Option

@Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Status(stage=DEVELOPMENT)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public @interface Option

Indicates that the method with this annotation, corresponds to a single command line option.
In the following example: jar -f output.jar f1.out f2.out the one and only Option is "f" and its single argument is "output.jar".

Version:

1.0 $Revision: 5866 $

Author:

Kees Schotanus

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of this Option.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	optional Determines whether this option is optional (true) or mandatory (false).

Element Detail

name

public abstract String name

The name of this Option.

Returns:

the name of this Option.

optional

public abstract boolean optional

Determines whether this option is optional (true) or mandatory (false).

Returns:

True when this Option is optional, otherwise false is returned.

Default:

true