|
||||||||||
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.Str
The Option.Str
class is an implementation of the Option
class that
encapsulates a string.
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 java.lang.String |
defvalue
The defvalue field stores the default (initial) value for this option. |
protected java.lang.String |
value
|
Fields inherited from class avrora.util.Option |
COMPARATOR, description, name |
Constructor Summary | |
Option.Str(java.lang.String nm,
java.lang.String val,
java.lang.String desc)
The constructor for the Option.Str class creates a new option that can store a string.
|
Method Summary | |
java.lang.String |
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. |
void |
setNewDefault(java.lang.String val)
The setNewDefault() method sets a new default value for this 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 java.lang.String defvalue
defvalue
field stores the default (initial) value for this option. It is used in
reporting the help item.
protected java.lang.String value
Constructor Detail |
public Option.Str(java.lang.String nm, java.lang.String val, java.lang.String desc)
Option.Str
class creates a new option that can store a string.
It is given an option name, a help description, and a default value.
nm
- the string name of the optionval
- the default value of the optiondesc
- 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 void setNewDefault(java.lang.String val)
setNewDefault()
method sets a new default value for this option. This is useful
for inherited options that might have a different default value for different actions or different
simulations.
val
- the new default value for this optionpublic java.lang.String get()
get()
method returns the current value of the 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 |