Uses of Class
org.openhab.core.types.StateDescription

Packages that use StateDescription

Package	Description
org.openhab.core.io.rest.core.item
org.openhab.core.items
org.openhab.core.library.items
org.openhab.core.service
org.openhab.core.thing.binding
org.openhab.core.thing.dto
org.openhab.core.thing.i18n
org.openhab.core.thing.type
org.openhab.core.types

Uses of StateDescription in org.openhab.core.io.rest.core.item

Fields in org.openhab.core.io.rest.core.item declared as StateDescription

Modifier and Type	Field	Description
StateDescription	EnrichedItemDTO.stateDescription

Constructors in org.openhab.core.io.rest.core.item with parameters of type StateDescription

Modifier	Constructor	Description
	EnrichedGroupItemDTO(ItemDTO itemDTO, EnrichedItemDTO[] members, String link, String state, String transformedState, StateDescription stateDescription, String unitSymbol)
	EnrichedItemDTO(ItemDTO itemDTO, String link, String state, String transformedState, StateDescription stateDescription, CommandDescription commandDescription, String unitSymbol)

Uses of StateDescription in org.openhab.core.items

Methods in org.openhab.core.items that return StateDescription

Modifier and Type	Method	Description
@Nullable StateDescription	GenericItem.getStateDescription()
@Nullable StateDescription	GenericItem.getStateDescription(@Nullable Locale locale)
@Nullable StateDescription	Item.getStateDescription()	Returns the first provided state description (uses the default locale).
@Nullable StateDescription	Item.getStateDescription(@Nullable Locale locale)	Returns the first provided state description for a given locale.

Uses of StateDescription in org.openhab.core.library.items

Methods in org.openhab.core.library.items that return StateDescription

Modifier and Type	Method	Description
@Nullable StateDescription	NumberItem.getStateDescription(@Nullable Locale locale)

Uses of StateDescription in org.openhab.core.service

Methods in org.openhab.core.service that return StateDescription

Modifier and Type	Method	Description
@Nullable StateDescription	StateDescriptionService.getStateDescription(String itemName, @Nullable Locale locale)	Implementations of this method merge the StateDescriptions provided from multiple StateDescriptionProviders into one final StateDescription.

Uses of StateDescription in org.openhab.core.thing.binding

Methods in org.openhab.core.thing.binding that return StateDescription

Modifier and Type	Method	Description
@Nullable StateDescription	BaseDynamicStateDescriptionProvider.getStateDescription(Channel channel, @Nullable StateDescription original, @Nullable Locale locale)

Methods in org.openhab.core.thing.binding with parameters of type StateDescription

Modifier and Type	Method	Description
@Nullable StateDescription	BaseDynamicStateDescriptionProvider.getStateDescription(Channel channel, @Nullable StateDescription original, @Nullable Locale locale)

Uses of StateDescription in org.openhab.core.thing.dto

Fields in org.openhab.core.thing.dto declared as StateDescription

Modifier and Type	Field	Description
StateDescription	ChannelDefinitionDTO.stateDescription
StateDescription	ChannelTypeDTO.stateDescription

Constructors in org.openhab.core.thing.dto with parameters of type StateDescription

Modifier	Constructor	Description
	ChannelDefinitionDTO(String id, String typeUID, String label, String description, Set<String> tags, String category, StateDescription stateDescription, boolean advanced, Map<String,String> properties)
	ChannelTypeDTO(String uid, String label, String description, String category, String itemType, String unitHint, ChannelKind kind, List<ConfigDescriptionParameterDTO> parameters, List<ConfigDescriptionParameterGroupDTO> parameterGroups, StateDescription stateDescription, Set<String> tags, boolean advanced, CommandDescription commandDescription)

Uses of StateDescription in org.openhab.core.thing.i18n

Methods in org.openhab.core.thing.i18n with parameters of type StateDescription

Modifier and Type	Method	Description
@Nullable StateDescriptionFragment	ChannelTypeI18nLocalizationService.createLocalizedStateDescriptionFragment(org.osgi.framework.Bundle bundle, @Nullable StateDescription state, ChannelTypeUID channelTypeUID, @Nullable Locale locale)

Uses of StateDescription in org.openhab.core.thing.type

Methods in org.openhab.core.thing.type that return StateDescription

Modifier and Type	Method	Description
@Nullable StateDescription	ChannelType.getState()	Returns the StateDescription of an items state which gives information how to interpret it.
@Nullable StateDescription	DynamicStateDescriptionProvider.getStateDescription(Channel channel, @Nullable StateDescription originalStateDescription, @Nullable Locale locale)	For a given Channel, return a StateDescription that should be used for the channel, instead of the one defined statically in the ChannelType.

Methods in org.openhab.core.thing.type with parameters of type StateDescription

Modifier and Type	Method	Description
@Nullable StateDescription	DynamicStateDescriptionProvider.getStateDescription(Channel channel, @Nullable StateDescription originalStateDescription, @Nullable Locale locale)	For a given Channel, return a StateDescription that should be used for the channel, instead of the one defined statically in the ChannelType.

Constructors in org.openhab.core.thing.type with parameters of type StateDescription

Modifier	Constructor	Description
protected	ChannelType(ChannelTypeUID uid, boolean advanced, @Nullable String itemType, @Nullable String unitHint, ChannelKind kind, String label, @Nullable String description, @Nullable String category, @Nullable Set<String> tags, @Nullable StateDescription state, @Nullable CommandDescription commandDescription, @Nullable EventDescription event, @Nullable URI configDescriptionURI, @Nullable AutoUpdatePolicy autoUpdatePolicy)	Creates a new instance of this class with the specified parameters.

Uses of StateDescription in org.openhab.core.types

Methods in org.openhab.core.types that return StateDescription

Modifier and Type	Method	Description
@Nullable StateDescription	StateDescriptionFragment.toStateDescription()	Create and return a StateDescription from this fragment.

Methods in org.openhab.core.types with parameters of type StateDescription

Modifier and Type	Method	Description
static StateDescriptionFragmentBuilder	StateDescriptionFragmentBuilder.create(StateDescription legacy)	Creates a builder instance and initializes all fields from the given StateDescription.