Class LongParameterImpl

java.lang.Object

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

com.biglybt.pifimpl.local.ui.config.LongParameterImpl

All Implemented Interfaces:

ParameterListener, ConfigParameter, EnablerParameter, LongParameter, Parameter, ParameterWithSuffix

public class LongParameterImpl
extends ParameterImpl
implements LongParameter

Field Summary

Fields

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

Fields inherited from class ParameterImpl

configKey

Fields inherited from interface Parameter

MODE_ADVANCED, MODE_BEGINNER, MODE_INTERMEDIATE

Constructor Summary

Constructors

Constructor	Description
LongParameterImpl(String configKey, String labelKey)
LongParameterImpl(String configKey, String labelKey, long min_value, long max_value)

Method Summary

Modifier and Type	Method	Description
void	addLongValidator(ParameterValidator<Long> validator)
long	getMaxValue()
long	getMinValue()
String	getSuffixLabelKey()
long	getValue()
Object	getValueObject()	Retrieve the parameter's value as an Object.
long	getValueWhenBlank()
boolean	isLimited()
boolean	isStoredAsString()
void	setMaxValue(long max_value)
void	setMinValue(long min_value)
void	setStoredAsString(boolean storedAsString, int valueWhenBlank)	Note: We can't easily propogate this to invalid reference 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(long 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 long min_value

max_value

private long max_value

storedAsString

private boolean storedAsString

valueWhenBlank

private long valueWhenBlank

suffixLabelKey

private String suffixLabelKey

Constructor Details

LongParameterImpl

public LongParameterImpl(String configKey,
 String labelKey)

LongParameterImpl

public LongParameterImpl(String configKey,
 String labelKey,
 long min_value,
 long max_value)

Method Details

getValue

public long getValue()

Specified by:

getValue in interface LongParameter

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(long value)

Specified by:

setValue in interface LongParameter

isLimited

public boolean isLimited()

Specified by:

isLimited in interface LongParameter

getMinValue

public long getMinValue()

Specified by:

getMinValue in interface LongParameter

getMaxValue

public long getMaxValue()

Specified by:

getMaxValue in interface LongParameter

setMinValue

public void setMinValue(long min_value)

Specified by:

setMinValue in interface LongParameter

setMaxValue

public void setMaxValue(long max_value)

Specified by:

setMaxValue in interface LongParameter

addLongValidator

public void addLongValidator(ParameterValidator<Long> validator)

Specified by:

addLongValidator in interface LongParameter

isStoredAsString

public boolean isStoredAsString()

setStoredAsString

public void setStoredAsString(boolean storedAsString,
 int valueWhenBlank)

Note: We can't easily propogate this to

invalid reference

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 long 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