Package net.solarnetwork.domain

Interface LocalizedServiceInfo

All Superinterfaces:
Comparable<String>, Identity<String>
All Known Subinterfaces:
ConfigurableLocalizedServiceInfo
All Known Implementing Classes:
BasicConfigurableLocalizedServiceInfo, BasicLocalizedServiceInfo
public interface LocalizedServiceInfo extends Identity<String>
API for information about a service that has been localized.

This API does not provide a way to localize the information. Rather, it is a marker for an instance that has already been localized. This is designed to support APIs that can localize objects based on a requested locale.

Since:
1.43
Version:
1.1
Author:
matt

  • Field Details

    • SORT_BY_NAME

      static final Comparator<LocalizedServiceInfo> SORT_BY_NAME
      A comparator for ordering by localized names in a case-insensitive manner.
      Since:
      1.1

  • Method Details

    • getLocale

      String getLocale()
      Get the locale used for this information.
      Returns:
      the locale

    • getLocalizedName

      String getLocalizedName()
      Get a localized name for the service.
      Returns:
      the service name

    • getLocalizedDescription

      String getLocalizedDescription()
      Get a localized description of the service.
      Returns:
      the service description

    • getLocalizedInfoMessages

      Map<String,String> getLocalizedInfoMessages()
      Get a map of other localized information.

      The keys in the returned map are service-dependent and defined in advance so they are well-known. The values represent localized messages associated with those well-known keys.

      Returns:
      a map of messages, never null