jargs.gnu.option
Class BooleanOption

java.lang.Object
  jargs.gnu.option.AbstractOption<java.lang.Boolean>
      jargs.gnu.option.BooleanOption

public class BooleanOption
extends AbstractOption<java.lang.Boolean>

An option that expects a boolean value.

Author:

Philipp Eichhorn, All JArgs authors see JARGS_LICENCE

Constructor Summary

BooleanOption(char shortForm, java.lang.String longForm, java.lang.String description)

BooleanOption(java.lang.String longForm, java.lang.String description)

Method Summary

java.lang.Boolean

parseValue(java.lang.String arg, java.util.Locale locale) Override to extract and convert an option value passed on the command-line.

Methods inherited from class jargs.gnu.option.AbstractOption

addValidator, description, getValue, longForm, shortForm, toString, wantsValue

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanOption

public BooleanOption(java.lang.String longForm,
                     java.lang.String description)

BooleanOption

public BooleanOption(char shortForm,
                     java.lang.String longForm,
                     java.lang.String description)

Method Detail

parseValue

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

Description copied from class: AbstractOption

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

Specified by:

parseValue in class AbstractOption<java.lang.Boolean>

Parameters:

arg - A command-line argument.

locale - The specified Locale.

Returns:

The parsed option value.

Throws:

IllegalOptionValueException