de.unkrig.commons.util.annotation

Annotation Type CommandLineOption

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface CommandLineOption

Indicates that the annotated method maps to a "command line option".

See Also:

The algorithm that determines the command line option(s) for this method

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
CommandLineOption.Cardinality	cardinality Configures how often this option may appear on the command line.
Class<?>[]	group Indicates that this command line option is related with other command line options, e.g. they are mutually exclusive.
String[]	name The name(s) that identify the option on the command line.

Element Detail

name

public abstract String[] name

The name(s) that identify the option on the command line.

If the name starts with "--", then only the double-hyphen variant is recognized; if it starts with "-", then only the single-hyphen is recognized; otherwise, both variants are recognized.

If this element is not specified, then the name is derived from the method name as follows: An optional prefix "set" or "add" is removed. The rest of the method name is converted from camel case into lower-case-hyphenated notation.
Example: If the method name is "setFooBar", then the following command line options are recognized: "-foo-bar" and "--foo-bar".

Default:

{}

cardinality

public abstract CommandLineOption.Cardinality cardinality

Configures how often this option may appear on the command line.

CommandLineOption.Cardinality.OPTIONAL (the default):

Zero times or once

CommandLineOption.Cardinality.MANDATORY:

Exactly once

CommandLineOption.Cardinality.ONCE_OR_MORE:

Once or multiple times

CommandLineOption.Cardinality.ANY:

Any number of times, including 0 and 1

Default:

de.unkrig.commons.util.annotation.CommandLineOption.Cardinality.OPTIONAL

group

public abstract Class<?>[] group

Indicates that this command line option is related with other command line options, e.g. they are mutually exclusive.

Default:

{}