Package org.openhab.core.automation.module.script.profile

Class ScriptProfileFactory

java.lang.Object

org.openhab.core.automation.module.script.profile.ScriptProfileFactory

All Implemented Interfaces:

ProfileFactory, ProfileTypeProvider

@NonNullByDefault
public class ScriptProfileFactory
extends Object
implements ProfileFactory, ProfileTypeProvider

The ScriptProfileFactory creates ScriptProfile instances

Author:

Jan N. Klug - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROFILE_CONFIG_URI_PREFIX

Constructor Summary

Constructors

Constructor	Description
ScriptProfileFactory()

Method Summary

Modifier and Type	Method	Description
void	bindScriptTransformationService(ScriptTransformationService service, Map<String,Object> properties)
@Nullable Profile	createProfile(ProfileTypeUID profileTypeUID, ProfileCallback callback, ProfileContext profileContext)	Creates a Profile instance for the given profile type identifier.
Collection<ProfileType>	getProfileTypes(@Nullable Locale locale)	Returns all profile types for the given Locale.
Collection<ProfileTypeUID>	getSupportedProfileTypeUIDs()	Return the identifiers of all supported profile types.
void	unbindScriptTransformationService(ScriptTransformationService service, Map<String,Object> properties)

Methods inherited from class java.lang.Object

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

Field Details

PROFILE_CONFIG_URI_PREFIX

public static final String PROFILE_CONFIG_URI_PREFIX

See Also:

• Constant Field Values

Constructor Details

ScriptProfileFactory

public ScriptProfileFactory()

Method Details

createProfile

public @Nullable Profile createProfile(ProfileTypeUID profileTypeUID,
 ProfileCallback callback,
 ProfileContext profileContext)

Description copied from interface: ProfileFactory

Creates a Profile instance for the given profile type identifier.

Specified by:

createProfile in interface ProfileFactory

Parameters:

profileTypeUID - the profile type identifier

callback - the ProfileCallback instance to be used by the Profile instance

profileContext - giving access to the profile's context like configuration, scheduler, etc.

Returns:

the profile instance or null if this factory cannot handle the given link

getSupportedProfileTypeUIDs

public Collection<ProfileTypeUID> getSupportedProfileTypeUIDs()

Description copied from interface: ProfileFactory

Return the identifiers of all supported profile types.

Specified by:

getSupportedProfileTypeUIDs in interface ProfileFactory

Returns:

a collection of all profile type identifier which this class is capable of creating

getProfileTypes

public Collection<ProfileType> getProfileTypes(@Nullable Locale locale)

Description copied from interface: ProfileTypeProvider

Returns all profile types for the given Locale.

Specified by:

getProfileTypes in interface ProfileTypeProvider

Parameters:

locale - (can be null)

Returns:

all profile types or empty list if no profile type exists

bindScriptTransformationService

public void bindScriptTransformationService(ScriptTransformationService service,
 Map<String,Object> properties)

unbindScriptTransformationService

public void unbindScriptTransformationService(ScriptTransformationService service,
 Map<String,Object> properties)