Package net.solarnetwork.domain

Class BasicLocalizedServiceInfo

java.lang.Object

net.solarnetwork.domain.BasicIdentity<String>

net.solarnetwork.domain.BasicLocalizedServiceInfo

All Implemented Interfaces:

Comparable<String>, Identity<String>, LocalizedServiceInfo

Direct Known Subclasses:

BasicConfigurableLocalizedServiceInfo

public class BasicLocalizedServiceInfo
extends BasicIdentity<String>
implements LocalizedServiceInfo

Basic immutable implementation of LocalizedServiceInfo.

Since:

1.43

Version:

1.0

Author:

matt

Nested Class Summary

Nested classes/interfaces inherited from interface net.solarnetwork.domain.LocalizedServiceInfo

LocalizedServiceInfo.LocalizedNameComparator

Field Summary

Fields inherited from interface net.solarnetwork.domain.LocalizedServiceInfo

SORT_BY_NAME

Constructor Summary

Constructors

Constructor	Description
BasicLocalizedServiceInfo(String id, Locale locale, String name, String description, Map<String,String> infoMessages)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getLocale()	Get the locale used for this information.
String	getLocalizedDescription()	Get a localized description of the service.
Map<String,String>	getLocalizedInfoMessages()	Get a map of other localized information.
String	getLocalizedName()	Get a localized name for the service.

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 java.lang.Comparable

compareTo

Methods inherited from interface net.solarnetwork.domain.Identity

getId, hasId

Constructor Details

BasicLocalizedServiceInfo

public BasicLocalizedServiceInfo(String id,
 Locale locale,
 String name,
 String description,
 Map<String,String> infoMessages)

Constructor.

Parameters:

id - the unique service identifier

locale - the locale

name - the localized name

description - the localized description

infoMessages - the localized info messages

Method Details

getLocale

public String getLocale()

Description copied from interface: LocalizedServiceInfo

Get the locale used for this information.

Specified by:

getLocale in interface LocalizedServiceInfo

Returns:

the locale

getLocalizedName

public String getLocalizedName()

Description copied from interface: LocalizedServiceInfo

Get a localized name for the service.

Specified by:

getLocalizedName in interface LocalizedServiceInfo

Returns:

the service name

getLocalizedDescription

public String getLocalizedDescription()

Description copied from interface: LocalizedServiceInfo

Get a localized description of the service.

Specified by:

getLocalizedDescription in interface LocalizedServiceInfo

Returns:

the service description

getLocalizedInfoMessages

public Map<String,String> getLocalizedInfoMessages()

Description copied from interface: LocalizedServiceInfo

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.

Specified by:

getLocalizedInfoMessages in interface LocalizedServiceInfo

Returns:

a map of messages, never null