avrora.util
Class Option.Bool

java.lang.Object
  avrora.util.Option
      avrora.util.Option.Bool

Enclosing class:

Option

public static class Option.Bool

extends Option

The Option.Bool class is an implementation of the Option class that encapsulates a boolean.

Nested Class Summary

Nested classes inherited from class avrora.util.Option

Option.Bool, Option.Double, Option.Interval, Option.List, Option.Long, Option.Str

Field Summary

protected boolean	defvalue The defvalue field stores the default (initial) value for this option.
protected boolean	value

Fields inherited from class avrora.util.Option

COMPARATOR, description, name

Constructor Summary

Option.Bool(java.lang.String nm, boolean val, java.lang.String desc)
The constructor for the Option.Long class creates a new option that can store a boolean value.

Method Summary

boolean	get() The get() method returns the current value of the option.
void	printHelp() The printHelp() method prints out a textual paragraph of the help item for this option to the terminal.
void	set(java.lang.String val) The set() method updates the value of the option.
java.lang.String	stringValue() The stringValue() method returns a string representation of the value of the option.

Methods inherited from class avrora.util.Option

getName, parseError, printDescription, printHeader

Methods inherited from class java.lang.Object

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

Field Detail

defvalue

protected final boolean defvalue

The defvalue field stores the default (initial) value for this option. It is used in reporting the help item.

value

protected boolean value

Constructor Detail

Option.Bool

public Option.Bool(java.lang.String nm,
                   boolean val,
                   java.lang.String desc)

The constructor for the Option.Long class creates a new option that can store a boolean value. It is given an option name, a help description, and a default value.

Parameters:

nm - the string name of the option

val - the default value of the option

desc - the description of the option

Method Detail

set

public void set(java.lang.String val)

The set() method updates the value of the option.

Specified by:

set in class Option

Parameters:

val - a string representation of the new value of the option.

get

public boolean get()

The get() method returns the current value of the option.

Returns:

the value of the option as a boolean.

stringValue

public java.lang.String stringValue()

The stringValue() method returns a string representation of the value of the option. This is used in debugging and reporting purposes.

Specified by:

stringValue in class Option

Returns:

a string representation of the value of the option.

printHelp

public void printHelp()

The printHelp() method prints out a textual paragraph of the help item for this option to the terminal.

Specified by:

printHelp in class Option