Package org.openhab.core.thing.i18n

Class ChannelTypeI18nLocalizationService

java.lang.Object

org.openhab.core.thing.i18n.ChannelTypeI18nLocalizationService

@NonNullByDefault
public class ChannelTypeI18nLocalizationService
extends Object

This OSGi service could be used to localize a ChannelType using the I18N mechanism of the openHAB framework.

Author:

Markus Rathgeb - Initial contribution, Markus Rathgeb - Move code from XML thing type provider to separate service, Laurent Garnier - fix localized label and description for channel group definition, Christoph Weitkamp - factored out from XmlChannelTypeProvider and XmlChannelGroupTypeProvider, Henning Treu - factored out from ThingTypeI18nLocalizationService, Mark Herwege - added unit hint

Constructor Summary

Constructors

Constructor	Description
ChannelTypeI18nLocalizationService(TranslationProvider i18nProvider)

Method Summary

Modifier and Type	Method	Description
ChannelType	createLocalizedChannelType(org.osgi.framework.Bundle bundle, ChannelType channelType, @Nullable Locale locale)
@Nullable CommandDescription	createLocalizedCommandDescription(org.osgi.framework.Bundle bundle, @Nullable CommandDescription command, ChannelTypeUID channelTypeUID, @Nullable Locale locale)
List<CommandOption>	createLocalizedCommandOptions(org.osgi.framework.Bundle bundle, List<CommandOption> commandOptions, ChannelTypeUID channelTypeUID, @Nullable Locale locale)
@Nullable StateDescriptionFragment	createLocalizedStateDescriptionFragment(org.osgi.framework.Bundle bundle, @Nullable StateDescription state, ChannelTypeUID channelTypeUID, @Nullable Locale locale)
List<StateOption>	createLocalizedStateOptions(org.osgi.framework.Bundle bundle, List<StateOption> stateOptions, ChannelTypeUID channelTypeUID, @Nullable Locale locale)
@Nullable String	createLocalizedStatePattern(org.osgi.framework.Bundle bundle, String pattern, ChannelTypeUID channelTypeUID, @Nullable Locale locale)

Methods inherited from class java.lang.Object

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

Constructor Details

ChannelTypeI18nLocalizationService

public ChannelTypeI18nLocalizationService(TranslationProvider i18nProvider)

Method Details

createLocalizedStatePattern

public @Nullable String createLocalizedStatePattern(org.osgi.framework.Bundle bundle,
 String pattern,
 ChannelTypeUID channelTypeUID,
 @Nullable Locale locale)

createLocalizedStateOptions

public List<StateOption> createLocalizedStateOptions(org.osgi.framework.Bundle bundle,
 List<StateOption> stateOptions,
 ChannelTypeUID channelTypeUID,
 @Nullable Locale locale)

createLocalizedStateDescriptionFragment

public @Nullable StateDescriptionFragment createLocalizedStateDescriptionFragment(org.osgi.framework.Bundle bundle,
 @Nullable StateDescription state,
 ChannelTypeUID channelTypeUID,
 @Nullable Locale locale)

createLocalizedCommandOptions

public List<CommandOption> createLocalizedCommandOptions(org.osgi.framework.Bundle bundle,
 List<CommandOption> commandOptions,
 ChannelTypeUID channelTypeUID,
 @Nullable Locale locale)

createLocalizedCommandDescription

public @Nullable CommandDescription createLocalizedCommandDescription(org.osgi.framework.Bundle bundle,
 @Nullable CommandDescription command,
 ChannelTypeUID channelTypeUID,
 @Nullable Locale locale)

createLocalizedChannelType

public ChannelType createLocalizedChannelType(org.osgi.framework.Bundle bundle,
 ChannelType channelType,
 @Nullable Locale locale)