IntOption (Jikes RVM API)

Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.vmutil.options
Class IntOption

java.lang.Object
  org.vmutil.options.Option
      org.vmutil.options.IntOption

Direct Known Subclasses:: ConcurrentTrigger, GCspyPort, GCspyTileSize, MarkSweepMarkBits, Threads, TraceRate, Verbose

public class IntOption
extends Option
extends Option

An option with a simple integer value.

Field Summary
`protected int`	`defaultValue`
`protected int`	`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
`protected`	`IntOption(OptionSet set, String name, String desc, int defaultValue)` Create a new int option.

Method Summary
`int`	`getDefaultValue()` Read the default value of the option.
`int`	`getValue()` Read the current value of the option.
`void`	`setDefaultValue(int value)` Modify the default value of the option.
`void`	`setValue(int 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 int defaultValue

value

protected int value

Constructor Detail

IntOption

protected IntOption(OptionSet set,
                    String name,
                    String desc,
                    int defaultValue)

Create a new int 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 int getValue()

Read the current value of the option.

Returns:: The option value.

getDefaultValue

public int getDefaultValue()

Read the default value of the option.

Returns:: The default value.

setValue

public void setValue(int 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(int value)

Modify the default value of the option.

Parameters:: value - The new default value for the option.