Package net.solarnetwork.settings.support

Class BasicSliderSettingSpecifier

java.lang.Object

net.solarnetwork.settings.support.BaseSettingSpecifier

net.solarnetwork.settings.support.BaseKeyedSettingSpecifier<Double>

net.solarnetwork.settings.support.BasicSliderSettingSpecifier

All Implemented Interfaces:

KeyedSettingSpecifier<Double>, MappableSpecifier, SettingSpecifier, SliderSettingSpecifier

public class BasicSliderSettingSpecifier
extends BaseKeyedSettingSpecifier<Double>
implements SliderSettingSpecifier

Basic implementation of SliderSettingSpecifier.

Version:

1.0

Author:

matt

Nested Class Summary

Nested classes/interfaces inherited from interface net.solarnetwork.settings.MappableSpecifier

MappableSpecifier.Mapper

Constructor Summary

Constructors

Constructor	Description
BasicSliderSettingSpecifier(String key, Double defaultValue, Double minValue, Double maxValue, Double step)	Construct with values.

Method Summary

Modifier and Type	Method	Description
Double	getMaximumValue()	The maximum value allowed.
Double	getMinimumValue()	The minimum value allowed.
Double	getStep()	Get a step value for acceptable values between the minimum and maximum.
SettingSpecifier	mappedWithMapper(MappableSpecifier.Mapper mapper)	Return a setting specifier mapped to a new path, using a MappableSpecifier.Mapper.
SettingSpecifier	mappedWithPlaceholer(String template)	Return a setting specifier mapped to a new path, using a format template.
void	setMaximumValue(Double maximumValue)	Set the maximum value.
void	setMinimumValue(Double minimumValue)	Set the minimum value.
void	setStep(Double step)	Set the increment step.

Methods inherited from class net.solarnetwork.settings.support.BaseKeyedSettingSpecifier

getDefaultValue, getDescriptionArguments, getKey, isTransient, mappedTo, setDefaultValue, setDescriptionArguments, setKey, setTransient, toString

Methods inherited from class net.solarnetwork.settings.support.BaseSettingSpecifier

getTitle, getType, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.solarnetwork.settings.KeyedSettingSpecifier

getDefaultValue, getDescriptionArguments, getKey, isTransient

Methods inherited from interface net.solarnetwork.settings.MappableSpecifier

mappedTo

Methods inherited from interface net.solarnetwork.settings.SettingSpecifier

getTitle, getType

Constructor Details

BasicSliderSettingSpecifier

public BasicSliderSettingSpecifier(String key,
 Double defaultValue,
 Double minValue,
 Double maxValue,
 Double step)

Construct with values.

Parameters:

key - the key

defaultValue - the default value

minValue - the minimum value

maxValue - the maximum value

step - the step value

Method Details

getMinimumValue

public Double getMinimumValue()

Description copied from interface: SliderSettingSpecifier

The minimum value allowed.

If null then 0 is assumed.

Specified by:

getMinimumValue in interface SliderSettingSpecifier

Returns:

the minimum value

getMaximumValue

public Double getMaximumValue()

Description copied from interface: SliderSettingSpecifier

The maximum value allowed.

If null then 1 is assumed.

Specified by:

getMaximumValue in interface SliderSettingSpecifier

Returns:

the maximum value

getStep

public Double getStep()

Description copied from interface: SliderSettingSpecifier

Get a step value for acceptable values between the minimum and maximum.

If null then 1 is assumed.

Specified by:

getStep in interface SliderSettingSpecifier

Returns:

the step value

mappedWithPlaceholer

public SettingSpecifier mappedWithPlaceholer(String template)

Description copied from interface: MappableSpecifier

Return a setting specifier mapped to a new path, using a format template.

Specified by:

mappedWithPlaceholer in interface MappableSpecifier

Parameters:

template - the format template

Returns:

the new instance

mappedWithMapper

public SettingSpecifier mappedWithMapper(MappableSpecifier.Mapper mapper)

Description copied from interface: MappableSpecifier

Return a setting specifier mapped to a new path, using a MappableSpecifier.Mapper.

Specified by:

mappedWithMapper in interface MappableSpecifier

Parameters:

mapper - the mapper

Returns:

the new instance

setMinimumValue

public void setMinimumValue(Double minimumValue)

Set the minimum value.

Parameters:

minimumValue - the minimum value to set

setMaximumValue

public void setMaximumValue(Double maximumValue)

Set the maximum value.

Parameters:

maximumValue - the maximum value to set

setStep

public void setStep(Double step)

Set the increment step.

Parameters:

step - the step to set