Package org.openhab.core.thing.binding

Class AbstractStorageBasedTypeProvider

java.lang.Object

org.openhab.core.thing.binding.AbstractStorageBasedTypeProvider

All Implemented Interfaces:

ThingTypeProvider, ChannelGroupTypeProvider, ChannelTypeProvider

@NonNullByDefault
public abstract class AbstractStorageBasedTypeProvider
extends Object
implements ThingTypeProvider, ChannelTypeProvider, ChannelGroupTypeProvider

The AbstractStorageBasedTypeProvider is the base class for the implementation of a Storage based ThingTypeProvider, ChannelTypeProvider and ChannelGroupTypeProvider It can be subclassed by bindings that create ThingTypes and ChannelTypes on-the-fly and need to persist those for future thing initializations

Author:

Jan N. Klug - Initial contribution

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractStorageBasedTypeProvider(StorageService storageService)	Instantiate a new storage based type provider.

Method Summary

Modifier and Type	Method	Description
@Nullable ChannelGroupType	getChannelGroupType(ChannelGroupTypeUID channelGroupTypeUID, @Nullable Locale locale)
Collection<ChannelGroupType>	getChannelGroupTypes(@Nullable Locale locale)
@Nullable ChannelType	getChannelType(ChannelTypeUID channelTypeUID, @Nullable Locale locale)
Collection<ChannelType>	getChannelTypes(@Nullable Locale locale)
@Nullable ThingType	getThingType(ThingTypeUID thingTypeUID, @Nullable Locale locale)	Provides a thing type for the given UID or null if no type for the given UID exists.
Collection<ThingType>	getThingTypes(@Nullable Locale locale)	Provides a collection of thing types
void	putChannelGroupType(ChannelGroupType channelGroupType)	Add or update a ChannelGroupType to the storage
void	putChannelType(ChannelType channelType)	Add or update a ChannelType to the storage
void	putThingType(ThingType thingType)	Add or update a ThingType to the storage
void	removeChannelGroupType(ChannelGroupTypeUID channelGroupTypeUID)	Remove a ChannelGroupType from the storage
void	removeChannelType(ChannelTypeUID channelTypeUID)	Remove a ChannelType from the storage
void	removeThingType(ThingTypeUID thingTypeUID)	Remove a ThingType from the storage

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractStorageBasedTypeProvider

protected AbstractStorageBasedTypeProvider(StorageService storageService)

Instantiate a new storage based type provider. The subclass needs to be a Component and declare itself as ThingTypeProvider and/or ChannelTypeProvider and/or ChannelGroupTypeProvider.

Parameters:

storageService - a persistent StorageService

Method Details

putThingType

public void putThingType(ThingType thingType)

Add or update a ThingType to the storage

Parameters:

thingType - the ThingType that needs to be stored

removeThingType

public void removeThingType(ThingTypeUID thingTypeUID)

Remove a ThingType from the storage

Parameters:

thingTypeUID - the ThingTypeUID of the thing type

putChannelType

public void putChannelType(ChannelType channelType)

Add or update a ChannelType to the storage

Parameters:

channelType - the ChannelType that needs to be stored

removeChannelType

public void removeChannelType(ChannelTypeUID channelTypeUID)

Remove a ChannelType from the storage

Parameters:

channelTypeUID - the ChannelTypeUID of the channel type

putChannelGroupType

public void putChannelGroupType(ChannelGroupType channelGroupType)

Add or update a ChannelGroupType to the storage

Parameters:

channelGroupType - the ChannelType that needs to be stored

removeChannelGroupType

public void removeChannelGroupType(ChannelGroupTypeUID channelGroupTypeUID)

Remove a ChannelGroupType from the storage

Parameters:

channelGroupTypeUID - the ChannelGroupTypeUID of the channel type

getThingTypes

public Collection<ThingType> getThingTypes(@Nullable Locale locale)

Description copied from interface: ThingTypeProvider

Provides a collection of thing types

Specified by:

getThingTypes in interface ThingTypeProvider

Parameters:

locale - locale (can be null)

Returns:

the thing types provided by the ThingTypeProvider

getThingType

public @Nullable ThingType getThingType(ThingTypeUID thingTypeUID,
 @Nullable Locale locale)

Description copied from interface: ThingTypeProvider

Provides a thing type for the given UID or null if no type for the given UID exists.

Specified by:

getThingType in interface ThingTypeProvider

locale - locale (can be null)

Returns:

thing type for the given UID or null if no type for the given UID exists

getChannelTypes

public Collection<ChannelType> getChannelTypes(@Nullable Locale locale)

Specified by:

getChannelTypes in interface ChannelTypeProvider

See Also:

• ChannelTypeRegistry.getChannelTypes(Locale)

getChannelType

public @Nullable ChannelType getChannelType(ChannelTypeUID channelTypeUID,
 @Nullable Locale locale)

Specified by:

getChannelType in interface ChannelTypeProvider

See Also:

• ChannelTypeRegistry.getChannelType(ChannelTypeUID, Locale)

getChannelGroupTypes

public Collection<ChannelGroupType> getChannelGroupTypes(@Nullable Locale locale)

Specified by:

getChannelGroupTypes in interface ChannelGroupTypeProvider

See Also:

• ChannelGroupTypeRegistry.getChannelGroupTypes(Locale)

getChannelGroupType

public @Nullable ChannelGroupType getChannelGroupType(ChannelGroupTypeUID channelGroupTypeUID,
 @Nullable Locale locale)

Specified by:

getChannelGroupType in interface ChannelGroupTypeProvider

See Also:

• ChannelGroupTypeRegistry.getChannelGroupType(ChannelGroupTypeUID, Locale)