Class IntParameterImpl

java.lang.Object

com.biglybt.pifimpl.local.ui.config.ParameterImpl

com.biglybt.pifimpl.local.ui.config.IntParameterImpl

All Implemented Interfaces:

ParameterListener, ConfigParameter, EnablerParameter, IntParameter, Parameter, ParameterWithSuffix

public class IntParameterImpl
extends ParameterImpl
implements IntParameter

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	limited
private int	max_value
private int	min_value
private boolean	storedAsString
private String	suffixLabelKey
private int	valueWhenBlank

Fields inherited from class ParameterImpl

configKey

Fields inherited from interface Parameter

MODE_ADVANCED, MODE_BEGINNER, MODE_INTERMEDIATE

Constructor Summary

Constructors

Constructor	Description
IntParameterImpl(String configKey, String labelKey)
IntParameterImpl(String configKey, String labelKey, int min_value, int max_value)

Method Summary

Modifier and Type	Method	Description
void	addIntegerValidator(ParameterValidator<Integer> validator)	Same as Parameter.addValidator(ParameterValidator), but casts the "toValue" to Integer.
int	getMaxValue()
int	getMinValue()
String	getSuffixLabelKey()
int	getValue()
Object	getValueObject()	Retrieve the parameter's value as an Object.
int	getValueWhenBlank()
boolean	isLimited()
boolean	isStoredAsString()
void	setMaxValue(int max_value)
void	setMinValue(int min_value)
void	setStoredAsString(boolean storedAsString, int valueWhenBlank)	Note: We can't easily propogate this to IntParameter, because BasicPluginConfigModel.addIntParameter2(String, String, int) sets the default value to int before setStoredAsString can be called.
void	setSuffixLabelKey(String suffixLabelKey)
void	setSuffixLabelText(String text)
void	setValue(int value)

Methods inherited from class ParameterImpl

addAndFireListener, addConfigParameterListener, addDisabledOnSelection, addDisabledOnSelection, addEnabledOnSelection, addEnabledOnSelection, addImplListener, addListener, addValidator, destroy, fireParameterChanged, getConfigKeyName, getDisabledOnSelectionParameters, getEnabledOnSelectionParameters, getGenerateIntermediateEvents, getGroup, getIndent, getKey, getLabelKey, getLabelText, getMinimumRequiredUserMode, getReferenceID, hasBeenSet, isEnabled, isForUIType, isIndentFancy, isVisible, parameterChanged, refreshControl, removeConfigParameterListener, removeImplListener, removeListener, resetToDefault, search, setAllowedUiTypes, setEnabled, setGenerateIntermediateEvents, setGroup, setIndent, setLabelKey, setLabelText, setMinimumRequiredUserMode, setReferenceID, setVisible, validate

Methods inherited from class Object

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

Methods inherited from interface ConfigParameter

addConfigParameterListener, removeConfigParameterListener

Methods inherited from interface Parameter

addAndFireListener, addListener, addValidator, getConfigKeyName, getGenerateIntermediateEvents, getLabelKey, getLabelText, getMinimumRequiredUserMode, hasBeenSet, isEnabled, isForUIType, isVisible, removeListener, resetToDefault, setAllowedUiTypes, setEnabled, setGenerateIntermediateEvents, setIndent, setLabelKey, setLabelText, setMinimumRequiredUserMode, setVisible

Field Details

limited

private boolean limited

min_value

private int min_value

max_value

private int max_value

storedAsString

private boolean storedAsString

valueWhenBlank

private int valueWhenBlank

suffixLabelKey

private String suffixLabelKey

Constructor Details

IntParameterImpl

public IntParameterImpl(String configKey,
 String labelKey)

IntParameterImpl

public IntParameterImpl(String configKey,
 String labelKey,
 int min_value,
 int max_value)

Method Details

getValue

public int getValue()

Specified by:

getValue in interface IntParameter

getValueObject

public Object getValueObject()

Description copied from interface: Parameter

Retrieve the parameter's value as an Object. Subclasses will usually have a getValue() that will return a specific type.

Specified by:

getValueObject in interface Parameter

Overrides:

getValueObject in class ParameterImpl

setValue

public void setValue(int value)

Specified by:

setValue in interface IntParameter

isLimited

public boolean isLimited()

Specified by:

isLimited in interface IntParameter

Returns:

Whether the parameter has a min and max value set

getMinValue

public int getMinValue()

Specified by:

getMinValue in interface IntParameter

getMaxValue

public int getMaxValue()

Specified by:

getMaxValue in interface IntParameter

setMinValue

public void setMinValue(int min_value)

Specified by:

setMinValue in interface IntParameter

setMaxValue

public void setMaxValue(int max_value)

Specified by:

setMaxValue in interface IntParameter

addIntegerValidator

public void addIntegerValidator(ParameterValidator<Integer> validator)

Description copied from interface: IntParameter

Same as Parameter.addValidator(ParameterValidator), but casts the "toValue" to Integer.

Specified by:

addIntegerValidator in interface IntParameter

isStoredAsString

public boolean isStoredAsString()

setStoredAsString

public void setStoredAsString(boolean storedAsString,
 int valueWhenBlank)

Note: We can't easily propogate this to IntParameter, because BasicPluginConfigModel.addIntParameter2(String, String, int) sets the default value to int before setStoredAsString can be called. This introducing a window where retrieving the parameter value may cause a cast error.

Plus, we don't want to encourage plugins to store ints as strings.

getValueWhenBlank

public int getValueWhenBlank()

getSuffixLabelKey

public String getSuffixLabelKey()

Specified by:

getSuffixLabelKey in interface ParameterWithSuffix

setSuffixLabelKey

public void setSuffixLabelKey(String suffixLabelKey)

Specified by:

setSuffixLabelKey in interface ParameterWithSuffix

setSuffixLabelText

public void setSuffixLabelText(String text)

Specified by:

setSuffixLabelText in interface ParameterWithSuffix