Package net.solarnetwork.settings.support

Class BasicToggleSettingSpecifier

java.lang.Object

net.solarnetwork.settings.support.BaseSettingSpecifier

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

net.solarnetwork.settings.support.BasicToggleSettingSpecifier

All Implemented Interfaces:

KeyedSettingSpecifier<Object>, MappableSpecifier, SettingSpecifier, ToggleSettingSpecifier

public class BasicToggleSettingSpecifier
extends BaseKeyedSettingSpecifier<Object>
implements ToggleSettingSpecifier

Basic implementation of ToggleSettingSpecifier.

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
BasicToggleSettingSpecifier(String key, Object defaultValue)	Constructor.
BasicToggleSettingSpecifier(String key, Object defaultValue, boolean trans)	Constructor.

Method Summary

Modifier and Type	Method	Description
Object	getFalseValue()	Get the "false" value for this setting
Object	getTrueValue()	Get the "true" value for this setting.
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	setFalseValue(Object falseValue)	Set the "false" value.
void	setTrueValue(Object trueValue)	Set the "true" value.

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

BasicToggleSettingSpecifier

public BasicToggleSettingSpecifier(String key,
 Object defaultValue)

Constructor.

Parameters:

key - the key

defaultValue - the default value

BasicToggleSettingSpecifier

public BasicToggleSettingSpecifier(String key,
 Object defaultValue,
 boolean trans)

Constructor.

Parameters:

key - the key

defaultValue - the default value

trans - the transient flag value

Method Details

getTrueValue

public Object getTrueValue()

Description copied from interface: ToggleSettingSpecifier

Get the "true" value for this setting.

If this returns null then Boolean.TRUE is assumed.

Specified by:

getTrueValue in interface ToggleSettingSpecifier

Returns:

the "true" value

getFalseValue

public Object getFalseValue()

Description copied from interface: ToggleSettingSpecifier

Get the "false" value for this setting

If this returns null then Boolean.FALSE is assumed.

Specified by:

getFalseValue in interface ToggleSettingSpecifier

Returns:

the "false" 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

setTrueValue

public void setTrueValue(Object trueValue)

Set the "true" value.

Parameters:

trueValue - the value to set

setFalseValue

public void setFalseValue(Object falseValue)

Set the "false" value.

Parameters:

falseValue - the value to set