org.dishevelled.commandline.argument

Class BooleanArgument

java.lang.Object

org.dishevelled.commandline.argument.AbstractArgument<Boolean>

org.dishevelled.commandline.argument.BooleanArgument

All Implemented Interfaces:

Argument<Boolean>

public final class BooleanArgument
extends AbstractArgument<Boolean>

A boolean argument.

Author:

Michael Heuer

Constructor Summary

Constructors

Constructor and Description
BooleanArgument(String shortName, String longName, String description, boolean required) Create a new boolean argument.

Method Summary

Modifier and Type	Method and Description
protected Boolean	convert(String s) Convert the specified string value into an instance of class E.

Methods inherited from class org.dishevelled.commandline.argument.AbstractArgument

equals, getDescription, getLongName, getShortName, getValue, getValue, hashCode, isArgumentString, isRequired, isValueString, visit, wasFound

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanArgument

public BooleanArgument(String shortName,
                       String longName,
                       String description,
                       boolean required)

Create a new boolean argument.

Parameters:

shortName - short argument name

longName - long argument name

description - argument description

required - true if this argument is required

Method Detail

convert

protected Boolean convert(String s)
                   throws Exception

Convert the specified string value into an instance of class E.

Specified by:

convert in class AbstractArgument<Boolean>

Parameters:

s - string value

Returns:

an instance of class E converted from the specified string value

Throws:

Exception - if an error occurs