Package org.openhab.core.thing.type

Class AbstractDescriptionType

java.lang.Object

org.openhab.core.thing.type.AbstractDescriptionType

All Implemented Interfaces:

Identifiable<UID>

Direct Known Subclasses:

ChannelGroupType, ChannelType, ThingType

@NonNullByDefault
public abstract class AbstractDescriptionType
extends Object
implements Identifiable<UID>

The AbstractDescriptionType class is the base class for a ThingType, a BridgeType a ChannelType or a ChannelGroupType. This class contains only properties and methods accessing them.

Hint: This class is immutable.

Author:

Michael Grammling - Initial contribution

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDescriptionType(UID uid, String label, @Nullable String description, @Nullable URI configDescriptionURI)	Creates a new instance of this class with the specified parameters.

Method Summary

Modifier and Type	Method	Description
@Nullable URI	getConfigDescriptionURI()	Returns the link to a concrete ConfigDescription.
@Nullable String	getDescription()	Returns the human-readable description for the according type.
String	getLabel()	Returns the human-readable label for the according type.
UID	getUID()	Returns the unique identifier which identifies the according type within the overall system.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractDescriptionType

protected AbstractDescriptionType(UID uid,
 String label,
 @Nullable String description,
 @Nullable URI configDescriptionURI)
                           throws IllegalArgumentException

Creates a new instance of this class with the specified parameters.

Parameters:

uid - the unique identifier which identifies the according type within the overall system (must neither be null, nor empty)

label - the human-readable label for the according type (must neither be null nor empty)

description - the human-readable description for the according type (could be null or empty)

configDescriptionURI - the URI that references the ConfigDescription of this type

Throws:

IllegalArgumentException - if the UID is null, or the label is null or empty

Method Details

getUID

public UID getUID()

Returns the unique identifier which identifies the according type within the overall system.

Specified by:

getUID in interface Identifiable<UID>

Returns:

the unique identifier which identifies the according type within the overall system (neither null, nor empty)

getLabel

public String getLabel()

Returns the human-readable label for the according type.

Returns:

the human-readable label for the according type (neither null, nor empty)

getDescription

public @Nullable String getDescription()

Returns the human-readable description for the according type.

Returns:

the human-readable description for the according type (could be null or empty)

getConfigDescriptionURI

public @Nullable URI getConfigDescriptionURI()

Returns the link to a concrete ConfigDescription.

Returns:

the link to a concrete ConfigDescription