|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object avrora.util.Option avrora.util.Option.Interval
The Option.Long
class is an implementation of the Option
class that
encapsulates a long integer value.
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 long |
default_high
The default_high field stores the default (initial) high value for this option. |
protected long |
default_low
The default_low field stores the default (initial) low value for this option. |
protected long |
high
|
protected long |
low
|
Fields inherited from class avrora.util.Option |
COMPARATOR, description, name |
Constructor Summary | |
Option.Interval(java.lang.String nm,
long l,
long h,
java.lang.String desc)
The constructor for the Option.Interval class creates a new option that can store an
interval which is denoted by a low integer and a high integer. |
Method Summary | |
long |
getHigh()
The getHigh() method returns the current highest value of the interval for this
option. |
long |
getLow()
The getLow() method returns the current lowest value of the interval for this 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 |
protected final long default_low
default_low
field stores the default (initial) low value for this option. It is
used in reporting the help item.
protected final long default_high
default_high
field stores the default (initial) high value for this option. It is
used in reporting the help item.
protected long low
protected long high
Constructor Detail |
public Option.Interval(java.lang.String nm, long l, long h, java.lang.String desc)
Option.Interval
class creates a new option that can store an
interval which is denoted by a low integer and a high integer. It is given an option name, a help
description, and a default value.
nm
- the string name of the optionl
- the default lowest value of the intervalh
- the default highest value of the intervaldesc
- the description of the optionMethod Detail |
public void set(java.lang.String val)
set()
method updates the value of the option.
set
in class Option
val
- a string representation of the new value of the option.public long getLow()
getLow()
method returns the current lowest value of the interval for this option.
public long getHigh()
getHigh()
method returns the current highest value of the interval for this
option.
public java.lang.String stringValue()
stringValue()
method returns a string representation of the value of the option.
This is used in debugging and reporting purposes.
stringValue
in class Option
public void printHelp()
printHelp()
method prints out a textual paragraph of the help item for this option
to the terminal.
printHelp
in class Option
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |