digital.toke.azc

Class CmdLineParser.Option<T>

java.lang.Object

digital.toke.azc.CmdLineParser.Option<T>

Direct Known Subclasses:

CmdLineParser.Option.BooleanOption, CmdLineParser.Option.DoubleOption, CmdLineParser.Option.IntegerOption, CmdLineParser.Option.LongOption, CmdLineParser.Option.StringOption

Enclosing class:

CmdLineParser

public abstract static class CmdLineParser.Option<T>
extends Object

Representation of a command-line option

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CmdLineParser.Option.BooleanOption An option that expects a boolean value
static class	CmdLineParser.Option.DoubleOption An option that expects a floating-point value
static class	CmdLineParser.Option.IntegerOption An option that expects an integer value
static class	CmdLineParser.Option.LongOption An option that expects a long integer value
static class	CmdLineParser.Option.StringOption An option that expects a string value

Field Summary

Fields

Modifier and Type	Field and Description
private String	longForm
private String	shortForm
private boolean	wantsValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Option(char shortForm, String longForm, boolean wantsValue)
protected	Option(String longForm, boolean wantsValue)
private	Option(String shortForm, String longForm, boolean wantsValue)

Method Summary

Modifier and Type	Method and Description
protected T	getDefaultValue() Override to define default value returned by getValue if option does not want a value
T	getValue(String arg, Locale locale)
String	longForm()
protected T	parseValue(String arg, Locale locale) Override to extract and convert an option value passed on the command-line
String	shortForm()
boolean	wantsValue() Tells whether or not this option wants a value

Methods inherited from class java.lang.Object

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

Field Detail

shortForm

private final String shortForm

longForm

private final String longForm

wantsValue

private final boolean wantsValue

Constructor Detail

Option

protected Option(String longForm,
                 boolean wantsValue)

Option

protected Option(char shortForm,
                 String longForm,
                 boolean wantsValue)

Option

private Option(String shortForm,
               String longForm,
               boolean wantsValue)

Method Detail

shortForm

public String shortForm()

longForm

public String longForm()

wantsValue

public boolean wantsValue()

Tells whether or not this option wants a value

getValue

public final T getValue(String arg,
                        Locale locale)
                 throws CmdLineParser.IllegalOptionValueException

Throws:

CmdLineParser.IllegalOptionValueException

parseValue

protected T parseValue(String arg,
                       Locale locale)
                throws CmdLineParser.IllegalOptionValueException

Override to extract and convert an option value passed on the command-line

Throws:

CmdLineParser.IllegalOptionValueException

getDefaultValue

protected T getDefaultValue()

Override to define default value returned by getValue if option does not want a value