Package net.solarnetwork.settings.support

Class BaseSettingsSpecifierLocalizedServiceInfoProvider<PK extends Comparable<PK>>

java.lang.Object

net.solarnetwork.domain.BasicIdentity<PK>

net.solarnetwork.service.support.BaseLocalizedServiceInfoProvider<PK>

net.solarnetwork.settings.support.BaseSettingsSpecifierLocalizedServiceInfoProvider<PK>

All Implemented Interfaces:

Comparable<PK>, Identity<PK>, LocalizedServiceInfoProvider, SettingSpecifierProvider

public abstract class BaseSettingsSpecifierLocalizedServiceInfoProvider<PK extends Comparable<PK>>
extends BaseLocalizedServiceInfoProvider<PK>
implements SettingSpecifierProvider

Convenient abstract class that is both a SettingSpecifierProvider and a LocalizedServiceInfoProvider.

Since:

1.43

Version:

2.0

Author:

matt

Field Summary

Fields inherited from class net.solarnetwork.service.support.BaseLocalizedServiceInfoProvider

log

Constructor Summary

Constructors

Constructor	Description
BaseSettingsSpecifierLocalizedServiceInfoProvider(PK id)	Constructor.

Method Summary

Modifier and Type	Method	Description
LocalizedServiceInfo	getLocalizedServiceInfo(Locale locale)	Get localized information for a specific locale.
String	getSettingUid()	Get a unique, application-wide setting ID.
protected void	populateInfoMessages(Locale locale, SettingSpecifier spec, Map<String,String> msgs, org.springframework.context.MessageSource ms)	Populate the info messages for a single SettingSpecifier.
protected Map<String,String>	resolveInfoMessages(Locale locale)	Resolve the localized info messages.

Methods inherited from class net.solarnetwork.service.support.BaseLocalizedServiceInfoProvider

getMessageSource, setMessageSource

Methods inherited from class net.solarnetwork.domain.BasicIdentity

clone, compareTo, equals, getId, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.solarnetwork.domain.Identity

hasId

Methods inherited from interface net.solarnetwork.settings.SettingSpecifierProvider

getDisplayName, getMessageSource, getSettingSpecifiers

Constructor Details

BaseSettingsSpecifierLocalizedServiceInfoProvider

public BaseSettingsSpecifierLocalizedServiceInfoProvider(PK id)

Constructor.

Parameters:

id - the identity of this provider

Method Details

getSettingUid

public String getSettingUid()

Description copied from interface: SettingSpecifierProvider

Get a unique, application-wide setting ID.

This ID must be unique across all setting providers registered within the system.

Specified by:

getSettingUid in interface SettingSpecifierProvider

Returns:

unique ID

getLocalizedServiceInfo

public LocalizedServiceInfo getLocalizedServiceInfo(Locale locale)

Description copied from interface: LocalizedServiceInfoProvider

Get localized information for a specific locale.

Specified by:

getLocalizedServiceInfo in interface LocalizedServiceInfoProvider

Overrides:

getLocalizedServiceInfo in class BaseLocalizedServiceInfoProvider<PK extends Comparable<PK>>

Parameters:

locale - the locale to get localized information for

Returns:

the localized info, never null

resolveInfoMessages

protected Map<String,String> resolveInfoMessages(Locale locale)

Description copied from class: BaseLocalizedServiceInfoProvider

Resolve the localized info messages.

This method returns an empty map. Extending classes can override.

Overrides:

resolveInfoMessages in class BaseLocalizedServiceInfoProvider<PK extends Comparable<PK>>

Parameters:

locale - the locale to resolve mesages for

Returns:

the map, never null

populateInfoMessages

protected void populateInfoMessages(Locale locale,
 SettingSpecifier spec,
 Map<String,String> msgs,
 org.springframework.context.MessageSource ms)

Populate the info messages for a single SettingSpecifier.

This implementation looks for message codes based on KeyedSettingSpecifier.getKey() values with .key and .desc appended, for "title" and "description" messages for that setting.

Parameters:

locale - the desired locale

spec - the specifier

msgs - the info map to store the resolved messages in

ms - the message source to resolve messages with