Package net.solarnetwork.settings

Interface KeyedSettingSpecifier<T>

Type Parameters:

T - the type of value stored by this setting

All Superinterfaces:

MappableSpecifier, SettingSpecifier

All Known Subinterfaces:

CronExpressionSettingSpecifier, MultiValueSettingSpecifier, RadioGroupSettingSpecifier, SliderSettingSpecifier, TextAreaSettingSpecifier, TextFieldSettingSpecifier, TitleSettingSpecifier, ToggleSettingSpecifier

All Known Implementing Classes:

BaseKeyedSettingSpecifier, BasicCronExpressionSettingSpecifier, BasicMultiValueSettingSpecifier, BasicRadioGroupSettingSpecifier, BasicSliderSettingSpecifier, BasicTextAreaSettingSpecifier, BasicTextFieldSettingSpecifier, BasicTitleSettingSpecifier, BasicToggleSettingSpecifier

public interface KeyedSettingSpecifier<T>
extends SettingSpecifier, MappableSpecifier

A setting specifier that can store a value associated with a key.

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
T	getDefaultValue()	Get the default value for this setting.
Object[]	getDescriptionArguments()	Get an optional list of message arguments to use when rendering a description of this specifier.
String	getKey()	Get the key for this setting.
boolean	isTransient()	Get transient flag.

Methods inherited from interface net.solarnetwork.settings.MappableSpecifier

mappedTo, mappedWithMapper, mappedWithPlaceholer

Methods inherited from interface net.solarnetwork.settings.SettingSpecifier

getTitle, getType

Method Details

getKey

String getKey()

Get the key for this setting.

Returns:

the key to associate with this setting

getDefaultValue

T getDefaultValue()

Get the default value for this setting.

Returns:

the default value

isTransient

boolean isTransient()

Get transient flag.

If a setting is transient, its associated value is never actually persisted and the getDefaultValue() is treated as its "current" value. This can be used for

Returns:

true if the setting is transient

getDescriptionArguments

Object[] getDescriptionArguments()

Get an optional list of message arguments to use when rendering a description of this specifier.

Returns:

An optional list of message arguments.