jargs.gnu.option
Class AbstractOption<E>

java.lang.Object
  jargs.gnu.option.AbstractOption<E>

Type Parameters:

E - Type of options value.

Direct Known Subclasses:

BooleanOption, DateOption, DoubleOption, FloatOption, IntegerOption, LongOption, StringOption

public abstract class AbstractOption<E>
extends java.lang.Object

Representation of an command-line option.

Author:

Philipp Eichhorn, All JArgs authors see JARGS_LICENCE

Constructor Summary

AbstractOption(char shortForm, java.lang.String longForm, java.lang.String description, boolean wantsValue)

AbstractOption(java.lang.String longForm, java.lang.String description, boolean wantsValue)

Method Summary

AbstractOption<E>	addValidator(AbstractValidator<E> validator) Adds a validator to this option.
java.lang.String	description()
E	getValue(java.lang.String arg, java.util.Locale locale)
java.lang.String	longForm()
abstract E	parseValue(java.lang.String arg, java.util.Locale locale) Override to extract and convert an option value passed on the command-line.
java.lang.String	shortForm()
java.lang.String	toString()
boolean	wantsValue() Tells whether or not this option wants a value

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractOption

public AbstractOption(java.lang.String longForm,
                      java.lang.String description,
                      boolean wantsValue)

AbstractOption

public AbstractOption(char shortForm,
                      java.lang.String longForm,
                      java.lang.String description,
                      boolean wantsValue)

Method Detail

shortForm

public java.lang.String shortForm()

Returns:

The short form of an command-line option.

longForm

public java.lang.String longForm()

Returns:

The long form of an command-line option.

description

public java.lang.String description()

Returns:

The description of an command-line option.

wantsValue

public boolean wantsValue()

Tells whether or not this option wants a value

addValidator

public AbstractOption<E> addValidator(AbstractValidator<E> validator)

Adds a validator to this option.

getValue

public final E getValue(java.lang.String arg,
                        java.util.Locale locale)
                 throws IllegalOptionValueException

Throws:

IllegalOptionValueException

parseValue

public abstract E parseValue(java.lang.String arg,
                             java.util.Locale locale)
                      throws IllegalOptionValueException

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

Parameters:

arg - A command-line argument.

locale - The specified Locale.

Returns:

The parsed option value.

Throws:

IllegalOptionValueException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object