Package net.solarnetwork.settings.support

Class BasicFactorySettingSpecifierProvider

java.lang.Object

net.solarnetwork.settings.support.BasicFactorySettingSpecifierProvider

All Implemented Interfaces:

FactorySettingSpecifierProvider, SettingSpecifierProvider

public class BasicFactorySettingSpecifierProvider
extends Object
implements FactorySettingSpecifierProvider

Basic implementation of FactorySettingSpecifierProvider that delegates all SettingSpecifierProvider methods to a delegate.

Version:

1.0

Author:

matt

Constructor Summary

Constructors

Constructor	Description
BasicFactorySettingSpecifierProvider(String factoryInstanceUID, SettingSpecifierProvider delegate)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Get a non-localized display name.
String	getFactoryInstanceUID()	Get the factory-wide unique ID for this provider.
org.springframework.context.MessageSource	getMessageSource()	Get a MessageSource to localize the setting text.
List<SettingSpecifier>	getSettingSpecifiers()	Get a list of SettingSpecifier instances.
String	getSettingUid()	Get a unique, application-wide setting ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BasicFactorySettingSpecifierProvider

public BasicFactorySettingSpecifierProvider(String factoryInstanceUID,
 SettingSpecifierProvider delegate)

Constructor.

Parameters:

factoryInstanceUID - the factory instance UID

delegate - the delegate

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

getDisplayName

public String getDisplayName()

Description copied from interface: SettingSpecifierProvider

Get a non-localized display name.

Specified by:

getDisplayName in interface SettingSpecifierProvider

Returns:

non-localized display name

getMessageSource

public org.springframework.context.MessageSource getMessageSource()

Description copied from interface: SettingSpecifierProvider

Get a MessageSource to localize the setting text.

This method can return null if the provider does not have any localized resources.

Specified by:

getMessageSource in interface SettingSpecifierProvider

Returns:

the MessageSource, or null

getSettingSpecifiers

public List<SettingSpecifier> getSettingSpecifiers()

Description copied from interface: SettingSpecifierProvider

Get a list of SettingSpecifier instances.

Specified by:

getSettingSpecifiers in interface SettingSpecifierProvider

Returns:

list of SettingSpecifier

getFactoryInstanceUID

public String getFactoryInstanceUID()

Description copied from interface: FactorySettingSpecifierProvider

Get the factory-wide unique ID for this provider.

Specified by:

getFactoryInstanceUID in interface FactorySettingSpecifierProvider

Returns:

the factory-wide unique ID