Package org.openhab.core.automation.type

Class ModuleType

java.lang.Object

org.openhab.core.automation.type.ModuleType

All Implemented Interfaces:

Identifiable<String>

Direct Known Subclasses:

ActionType, ConditionType, TriggerType

@NonNullByDefault
public abstract class ModuleType
extends Object
implements Identifiable<String>

This class provides common functionality for creating ModuleType instances. Each ModuleType instance defines the meta-information needed for creation of a Module instance which is a building block for a Rule. The meta-information describes the Configuration of a Module providing list with ConfigDescriptionParameters, Inputs and Outputs of a Module. Each ModuleType instance owns a unique id which is used as reference in the Modules, to find their meta-information.

Whether the ModuleTypes can be used by anyone, depends from their Visibility value, but they can be modified only by their creator.

Author:

Yordan Mihaylov - Initial contribution, Ana Dimova - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ConfigDescriptionParameter>	configDescriptions	Describes meta-data for the configuration of the future Module instances.

Constructor Summary

Constructors

Constructor	Description
ModuleType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions)	Creates a ModuleType instance.
ModuleType(@Nullable String uid, @Nullable List<ConfigDescriptionParameter> configDescriptions, @Nullable String label, @Nullable String description, @Nullable Set<String> tags, @Nullable Visibility visibility)	Creates a ModuleType instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)
List<ConfigDescriptionParameter>	getConfigurationDescriptions()	Gets the meta-data for the configuration of the future Module instances.
@Nullable String	getDescription()	Gets the description of the ModuleType.
@Nullable String	getLabel()	Gets the label of the ModuleType.
Set<String>	getTags()	Gets the assigned to the ModuleType - tags.
String	getUID()	Gets the ModuleType.
Visibility	getVisibility()	Gets the visibility of the ModuleType.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Details

configDescriptions

protected List<ConfigDescriptionParameter> configDescriptions

Describes meta-data for the configuration of the future Module instances.

Constructor Details

ModuleType

public ModuleType(@Nullable String uid,
 @Nullable List<ConfigDescriptionParameter> configDescriptions)

Creates a ModuleType instance. This constructor is responsible to initialize common base properties of the ModuleTypes.

Parameters:

uid - the ModuleType's identifier, or null if a random identifier should be generated.

configDescriptions - describing meta-data for the configuration of the future Module instances

ModuleType

public ModuleType(@Nullable String uid,
 @Nullable List<ConfigDescriptionParameter> configDescriptions,
 @Nullable String label,
 @Nullable String description,
 @Nullable Set<String> tags,
 @Nullable Visibility visibility)

Creates a ModuleType instance. This constructor is responsible to initialize all common properties of the ModuleTypes.

Parameters:

uid - the ModuleType's identifier, or null if a random identifier should be generated.

configDescriptions - describing meta-data for the configuration of the future Module instances.

label - a short and accurate, human-readable label of the ModuleType.

description - a detailed, human-readable description of usage of ModuleType and its benefits.

tags - defines categories that fit the ModuleType and which can serve as criteria for searching or filtering it.

visibility - determines whether the ModuleType can be used by anyone if it is Visibility.VISIBLE or only by its creator if it is Visibility.HIDDEN. If null is provided the default visibility Visibility.VISIBLE will be used.

Method Details

getUID

public String getUID()

Gets the ModuleType. It can be specified by the ModuleType's creator, or randomly generated.

Specified by:

getUID in interface Identifiable<String>

Returns:

an identifier of this ModuleType. Can't be null.

getConfigurationDescriptions

public List<ConfigDescriptionParameter> getConfigurationDescriptions()

Gets the meta-data for the configuration of the future Module instances.

Returns:

a Set of meta-information configuration descriptions.

getTags

public Set<String> getTags()

Gets the assigned to the ModuleType - tags.

Returns:

a set of tags, assigned to this ModuleType.

getLabel

public @Nullable String getLabel()

Gets the label of the ModuleType. The label is a short and accurate, human-readable label of the ModuleType.

Returns:

the ModuleType's label. Can be null.

getDescription

public @Nullable String getDescription()

Gets the description of the ModuleType. The description is a short and understandable description of that for what can be used the ModuleType.

Returns:

the ModuleType's description. Can be null.

getVisibility

public Visibility getVisibility()

Gets the visibility of the ModuleType. The visibility determines whether the ModuleTypes can be used by anyone if they are Visibility.VISIBLE or only by their creator if they are Visibility.HIDDEN. The default visibility is Visibility.VISIBLE.

Returns:

the visibility of the ModuleType.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object