org.vmutil.options

Class StringOption

java.lang.Object

org.vmutil.options.Option

org.vmutil.options.StringOption

Direct Known Subclasses:

PerfEvents

public class StringOption
extends Option

An option that has a simple string value.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	defaultValue
protected String	value

Fields inherited from class org.vmutil.options.Option

ADDRESS_OPTION, BOOLEAN_OPTION, ENUM_OPTION, FLOAT_OPTION, INT_OPTION, MICROSECONDS_OPTION, PAGES_OPTION, RAW, READABLE, set, STRING_OPTION, XML

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StringOption(OptionSet set, String name, String desc, String defaultValue) Create a new string option.

Method Summary

Modifier and Type	Method and Description
String	getDefaultValue() Read the default value of the option
String	getValue() Read the current value of the option.
void	setDefaultValue(String value) Modify the default value of the option.
void	setValue(String value) Update the value of the option, echoing the change if the echoOptions option is set.

Methods inherited from class org.vmutil.options.Option

fail, failIf, getDescription, getKey, getName, getNext, getType, setNext, validate, warn, warnIf

Methods inherited from class java.lang.Object

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

Field Detail

defaultValue

protected String defaultValue

value

protected String value

Constructor Detail

StringOption

protected StringOption(OptionSet set,
                       String name,
                       String desc,
                       String defaultValue)

Create a new string option.

Parameters:

set - The option set this option belongs to.

name - The space separated name for the option.

desc - The purpose of the option

defaultValue - The default value of the option.

Method Detail

getValue

public String getValue()

Read the current value of the option.

Returns:

The option value.

getDefaultValue

public String getDefaultValue()

Read the default value of the option

Returns:

The default value.

setValue

public void setValue(String value)

Update the value of the option, echoing the change if the echoOptions option is set. This method also calls the validate method to allow subclasses to perform any required validation.

Parameters:

value - The new value for the option.

setDefaultValue

public void setDefaultValue(String value)

Modify the default value of the option.

Parameters:

value - The new default value for the option.