Package net.solarnetwork.settings

Interface TitleSettingSpecifier

All Superinterfaces:

KeyedSettingSpecifier<String>, MappableSpecifier, MarkupSetting, SettingSpecifier

All Known Subinterfaces:

CronExpressionSettingSpecifier, MultiValueSettingSpecifier, RadioGroupSettingSpecifier, TextFieldSettingSpecifier

All Known Implementing Classes:

BasicCronExpressionSettingSpecifier, BasicMultiValueSettingSpecifier, BasicRadioGroupSettingSpecifier, BasicTextFieldSettingSpecifier, BasicTitleSettingSpecifier

public interface TitleSettingSpecifier
extends KeyedSettingSpecifier<String>, MarkupSetting

A read-only string setting.

Version:

1.1

Author:

matt

Nested Class Summary

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

MappableSpecifier.Mapper

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getValueTitles()	An optional mapping of possible values for this setting to associated titles.

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.MarkupSetting

isMarkup

Methods inherited from interface net.solarnetwork.settings.SettingSpecifier

getTitle, getType

Method Details

getValueTitles

Map<String,String> getValueTitles()

An optional mapping of possible values for this setting to associated titles.

This can be used to display user-friendly titles for setting values if the setting value itself is cryptic.

Returns:

the setting value titles