Package net.solarnetwork.settings

Interface ToggleSettingSpecifier

All Superinterfaces:

KeyedSettingSpecifier<Object>, MappableSpecifier, SettingSpecifier

All Known Implementing Classes:

BasicToggleSettingSpecifier

public interface ToggleSettingSpecifier
extends KeyedSettingSpecifier<Object>

A logically boolean toggle setting.

Version:

1.0

Author:

matt

Nested Class Summary

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

MappableSpecifier.Mapper

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.

Methods inherited from interface net.solarnetwork.settings.KeyedSettingSpecifier

getDefaultValue, getDescriptionArguments, getKey, isTransient

Methods inherited from interface net.solarnetwork.settings.MappableSpecifier

mappedTo, mappedWithMapper, mappedWithPlaceholer

Methods inherited from interface net.solarnetwork.settings.SettingSpecifier

getTitle, getType

Method Details

getTrueValue

Object getTrueValue()

Get the "true" value for this setting.

If this returns null then Boolean.TRUE is assumed.

Returns:

the "true" value

getFalseValue

Object getFalseValue()

Get the "false" value for this setting

If this returns null then Boolean.FALSE is assumed.

Returns:

the "false" value