net.windwards.options

Annotation Type Option

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

Option denotes a field that should be interpreted as a commandline option. The name of the denoted field is also the name of the commandline option. E.g.: \@Option public String givenName, becomes --givenName.

Author:

quest

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	documentation document the option's effect.
String	shortName a short version of the option.
Class<? extends ValueParser>	valueParser use a custom ValueParser to interpret value for this option.

Element Detail

shortName

public abstract String shortName

a short version of the option. E.g.: @Option(shortName='p') gives -p.

Default:

""

documentation

public abstract String documentation

document the option's effect. Used to build usage message.

Default:

""

valueParser

public abstract Class<? extends ValueParser> valueParser

use a custom ValueParser to interpret value for this option. Supply a class reference that implements ValueParser.

Default:

net.windwards.options.valueparsers.NullValueParser.class