com.munkei

Annotation Type CommandLineOption

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

An annotation to use for command line options.

All elements are optional. Thus the simplest usage is:

 @CommandLineOption

 private Boolean verbose;
 

The above will match the option --verbose when parsing (JArgP.parse(java.lang.String[])), and if it is present, the field verbose (of the "subject", see JArgP.JArgP(java.lang.Object)) will be set to true.

If you want the command line option to use the next argument as a value for a field, make the field something other than a Boolean. Values are converted in Option.convert(java.lang.String, java.lang.Class), see its documentation for details.

To configure the specifics of the command line option and how it is parsed, see each element:

• To specify which command line options match a field, see names() and pattern().
• To specify how the documentation for the field is printed (JArgP.printUsage(java.io.PrintStream)), see placeholder(), description(), defaultValue() and defaultValue().

Since:

0.0.1

Author:

Theo 'Biffen' Willows

See Also:

JArgP

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	defaultValue A default value.
String	description A description of the option to use for the usage text.
String[]	names The names of the option.
boolean	opposite Creates a --no-[...] alias that sets it to false.
String	pattern For complex names match this pattern.
String	placeholder Text to use as a placeholder when printing the usage.
String	setter Specifies a method to set the value.
String	shortPattern For complex names match this pattern.

Element Detail

names

public abstract String[] names

The names of the option. These names will be accepted as options when parsing.

If no names are specified (and no pattern() is specified), the name of the field itself is used.

Single character names will be short options ( -[...]), others will be long options ( --[...]), with the exception of -, which will be just that.

See Also:

pattern()

Default:

{}

setter

public abstract String setter

Specifies a method to set the value. Must take either two String parameters, where the first one is the name and the second one is the value:

<setter>(String name, String value)

or a single String parameter that is the value:

<setter>(String value)

For multiples (Collections) it is assumed the setter appends a single value.

One reason to use a setter would be to do some kind of validation of the value. You may throw an exception in the setter if the value is considered invalid. E.g. an ArgumentParsingException, but any type can be used, just make sure to catch it wherever you call JArgP.parse(java.lang.String[]).

If not used, members will be set directly.

Default:

""

pattern

public abstract String pattern

For complex names match this pattern. Patterns will be matched after names and aliases.

E.g: [0-9]+ for options like -1, -2, etc.

See Also:

shortPattern(), names()

Default:

""

shortPattern

public abstract String shortPattern

For complex names match this pattern. shortPatterns are matched against short options (--[...]). Patterns will be matched after names and aliases.

E.g: [0-9]+ for options like -1, -2, etc.

See Also:

pattern()

Default:

""

opposite

public abstract boolean opposite

Creates a --no-[...] alias that sets it to false.

Switches only.

Default:

false

placeholder

public abstract String placeholder

Text to use as a placeholder when printing the usage.

E.g. for an option called file one might set the placeholder to "FILE", to get a usage like:

--file FILE

The default is "VALUE".

Only used for options that take a value, i.e. not Booleans.

See Also:

JArgP.printUsage(java.io.PrintStream)

Default:

"VALUE"

description

public abstract String description

A description of the option to use for the usage text.

See Also:

JArgP.printUsage(java.io.PrintStream)

Default:

""

defaultValue

public abstract String defaultValue

A default value. Will be documented in the usage text. Will be set by JArgP.parse(java.lang.String[]) to any member that has not been set by the arguments.

See Also:

JArgP.printUsage(java.io.PrintStream)

Default:

""