Package net.solarnetwork.settings

Interface SettingSpecifierProviderFactory

All Known Implementing Classes:
BasicSettingSpecifierProviderFactory
public interface SettingSpecifierProviderFactory
API for a SettingSpecifierProvider managed as a factory.
Version:
1.0
Author:
matt

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDisplayName()
    Get a non-localized display name.
    String
    getFactoryUid()
    Get a unique, application-wide factory ID.
    org.springframework.context.MessageSource
    getMessageSource()
    Get a MessageSource to localize the setting text.

  • Method Details

    • getFactoryUid

      String getFactoryUid()
      Get a unique, application-wide factory ID.

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

      Returns:
      unique ID

    • getDisplayName

      String getDisplayName()
      Get a non-localized display name.
      Returns:
      non-localized display name

    • getMessageSource

      org.springframework.context.MessageSource getMessageSource()
      Get a MessageSource to localize the setting text.

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

      Returns:
      the MessageSource, or null