net.windwards.options

Class OptionDescription

java.lang.Object

net.windwards.options.OptionDescription

public class OptionDescription
extends Object

Information about a single options as detected during scanning.

Add a class reference to OptionDescription.parsers in order to instruct OptionParser how to interpret option values into new types. For example, OptionParser could be taught to understand BigInteger thus:

 OptionDescription.parsers.put(BigInteger.class, new ValueParser() {
   public Object parse(OptionDescription desc, Class<?> type, String value) throws InvalidOptionValue {
     return new BigInteger(value);
   }
 });
 

Note that this occurs during scanning, so the new ValueParser must be inserted before the OptionParser is created.

See Also:

OptionParser

Field Summary

Fields

Modifier and Type	Field and Description
Set<String>	alternatives If now null, the values allowed for this option; currently used for enums
Object	defaultValue default value of this option at time of scanning
String	documentation documentation string, as picked up from @Option
Field	field The field object representing the referenced class member
String	longOptionName Full name of the option
static Map<Class<?>,ValueParser>	parsers Map of known ValueParsers.
String	shortOptionName Short (one-letter) version of option, or null if none.
ValueParser	valueParser

Constructor Summary

Constructors

Constructor and Description
OptionDescription(Field field)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
void	extractDefaultValue(Object options)
Class<?>	getType()
Object	interpretValue(String value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parsers

public static final Map<Class<?>,ValueParser> parsers

Map of known ValueParsers.

longOptionName

public String longOptionName

Full name of the option

shortOptionName

public String shortOptionName

Short (one-letter) version of option, or null if none.

defaultValue

public Object defaultValue

default value of this option at time of scanning

documentation

public String documentation

documentation string, as picked up from @Option

alternatives

public Set<String> alternatives

If now null, the values allowed for this option; currently used for enums

field

public Field field

The field object representing the referenced class member

valueParser

public ValueParser valueParser

Constructor Detail

OptionDescription

public OptionDescription(Field field)

Method Detail

extractDefaultValue

public void extractDefaultValue(Object options)

interpretValue

public Object interpretValue(String value)
                      throws InvalidOptionValue

Throws:

InvalidOptionValue

getType

public Class<?> getType()

equals

public boolean equals(Object o)

Overrides:

equals in class Object