Package org.openhab.core.types

Interface StateDescriptionFragmentProvider

@NonNullByDefault
public interface StateDescriptionFragmentProvider

Provide a StateDescriptionFragment for the current StateDescription. Use the StateDescriptionFragmentBuilder to create a StateDescriptionFragment with only the parts known.

Author:

Henning Treu - Initial contribution

Method Summary

Modifier and Type	Method	Description
Integer	getRank()	Return the service rank.
@Nullable StateDescriptionFragment	getStateDescriptionFragment(String itemName, @Nullable Locale locale)	Returns a StateDescriptionFragment with only the parts known by this StateDescriptionFragmentProvider.

Method Details

getStateDescriptionFragment

@Nullable StateDescriptionFragment getStateDescriptionFragment(String itemName,
 @Nullable Locale locale)

Returns a StateDescriptionFragment with only the parts known by this StateDescriptionFragmentProvider.

Parameters:

itemName - item name (must not be null)

locale - locale (can be null)

Returns:

a StateDescriptionFragment with only the parts known by this StateDescriptionFragmentProvider.

getRank

Integer getRank()

Return the service rank. Usually an implementation should piggy-back on the service.ranking OSGi component property. The default is 0 - the higher, the more like it is going to win.

Returns:

an integer value