org.jargp

Class BoolDef

java.lang.Object

org.jargp.ParameterDef

org.jargp.BoolDef

public class BoolDef
extends ParameterDef

Command line flag definition. This defines a simple command line flag that sets a boolean parameter value. Both true and false settings are supported.

Constructor Summary

Constructors

Constructor and Description
BoolDef(char chr, java.lang.String name) Constructor defaulting to flag true.
BoolDef(char chr, java.lang.String name, boolean sense) Constructor with flag sense specified.
BoolDef(char chr, java.lang.String name, java.lang.String desc) Constructor defaulting to flag true with description.
BoolDef(char chr, java.lang.String name, java.lang.String desc, boolean sense) Constructor with flag sense specified and description.

Method Summary

Methods

Modifier and Type	Method and Description
void	handle(ArgumentProcessor proc) Handle argument.

Methods inherited from class org.jargp.ParameterDef

getAbbreviation, getDescription, getFlag

Methods inherited from class java.lang.Object

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

Constructor Detail

BoolDef

public BoolDef(char chr,
       java.lang.String name,
       java.lang.String desc,
       boolean sense)

Constructor with flag sense specified and description.

Parameters:

chr - parameter flag character

name - field name for parameter

desc - discription text for parameter (may be null)

sense - value set when flag is seen

BoolDef

public BoolDef(char chr,
       java.lang.String name,
       boolean sense)

Constructor with flag sense specified.

Parameters:

chr - parameter flag character

name - field name for parameter

sense - value set when flag is seen

BoolDef

public BoolDef(char chr,
       java.lang.String name,
       java.lang.String desc)

Constructor defaulting to flag true with description.

Parameters:

chr - parameter flag character

name - field name for parameter

desc - discription text for parameter

BoolDef

public BoolDef(char chr,
       java.lang.String name)

Constructor defaulting to flag true.

Parameters:

chr - parameter flag character

name - field name for parameter

Method Detail

handle

public void handle(ArgumentProcessor proc)

Handle argument. This implementation of the abstract base class method just sets the parameter value as appropriate for the flag.

Specified by:

handle in class ParameterDef

Parameters:

proc - argument processor making call to handler

Throws:

java.lang.IllegalArgumentException - on error in processing