Package org.openhab.core.thing.type

Class ThingTypeBuilder

java.lang.Object

org.openhab.core.thing.type.ThingTypeBuilder

@NonNullByDefault
public class ThingTypeBuilder
extends Object

A ThingType builder.

Author:

Henning Treu - Initial contribution, Andrew Fiddian-Green - Added semanticEquipmentTag

Method Summary

Modifier and Type	Method	Description
ThingType	build()	Builds and returns a new ThingType according to the given values from this builder.
BridgeType	buildBridge()	Builds and returns a new BridgeType according to the given values from this builder.
static ThingTypeBuilder	instance(String bindingId, String thingTypeId, String label)	Create and return a ThingTypeBuilder with the given bindingId, thingTypeId and label.
static ThingTypeBuilder	instance(ThingTypeUID thingTypeUID, String label)	Create and return a ThingTypeBuilder with the given ThingTypeUID and label.
static ThingTypeBuilder	instance(ThingType thingType)	Create this builder with all properties from the given ThingType.
ThingTypeBuilder	isListed(boolean listed)
ThingTypeBuilder	withCategory(String category)
ThingTypeBuilder	withChannelDefinitions(List<ChannelDefinition> channelDefinitions)
ThingTypeBuilder	withChannelGroupDefinitions(List<ChannelGroupDefinition> channelGroupDefinitions)
ThingTypeBuilder	withConfigDescriptionURI(URI configDescriptionURI)
ThingTypeBuilder	withDescription(String description)
ThingTypeBuilder	withExtensibleChannelTypeIds(List<String> extensibleChannelTypeIds)
ThingTypeBuilder	withLabel(String label)
ThingTypeBuilder	withProperties(Map<String,String> properties)
ThingTypeBuilder	withRepresentationProperty(String representationProperty)
ThingTypeBuilder	withSemanticEquipmentTag(String semanticEquipmentTag)
ThingTypeBuilder	withSemanticEquipmentTag(SemanticTag semanticEquipmentTag)
ThingTypeBuilder	withSupportedBridgeTypeUIDs(List<String> supportedBridgeTypeUIDs)

Methods inherited from class java.lang.Object

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

Method Details

instance

public static ThingTypeBuilder instance(String bindingId,
 String thingTypeId,
 String label)

Create and return a ThingTypeBuilder with the given bindingId, thingTypeId and label. Also, listed defaults to true.

Parameters:

bindingId - the binding Id the resulting ThingType will have. Must not be null or empty.

thingTypeId - the thingTypeId the resulting ThingType will have (builds a ThingTypeUID with bindingId:thingTypeId. Must not be null or empty.

label - the label of the resulting ThingType. Must not be null or empty.

Returns:

the new ThingTypeBuilder.

instance

public static ThingTypeBuilder instance(ThingTypeUID thingTypeUID,
 String label)

Create and return a ThingTypeBuilder with the given ThingTypeUID and label. Also, listed defaults to true.

Parameters:

thingTypeUID - the ThingTypeUID the resulting ThingType will have. Must not be null.

label - the label of the resulting ThingType. Must not be null or empty.

Returns:

the new ThingTypeBuilder.

instance

public static ThingTypeBuilder instance(ThingType thingType)

Create this builder with all properties from the given ThingType.

Parameters:

thingType - take all properties from this ThingType.

Returns:

a new ThingTypeBuilder configured with all properties from the given ThingType;

build

public ThingType build()

Builds and returns a new ThingType according to the given values from this builder.

Returns:

a new ThingType according to the given values from this builder.

Throws:

IllegalStateException - if one of bindingId, thingTypeId or label are not given.

buildBridge

public BridgeType buildBridge()

Builds and returns a new BridgeType according to the given values from this builder.

Returns:

a new BridgeType according to the given values from this builder.

Throws:

IllegalStateException - if one of bindingId, thingTypeId or label are not given.

withLabel

public ThingTypeBuilder withLabel(String label)

withDescription

public ThingTypeBuilder withDescription(String description)

withCategory

public ThingTypeBuilder withCategory(String category)

isListed

public ThingTypeBuilder isListed(boolean listed)

withRepresentationProperty

public ThingTypeBuilder withRepresentationProperty(String representationProperty)

withChannelDefinitions

public ThingTypeBuilder withChannelDefinitions(List<ChannelDefinition> channelDefinitions)

withChannelGroupDefinitions

public ThingTypeBuilder withChannelGroupDefinitions(List<ChannelGroupDefinition> channelGroupDefinitions)

withProperties

public ThingTypeBuilder withProperties(Map<String,String> properties)

withConfigDescriptionURI

public ThingTypeBuilder withConfigDescriptionURI(URI configDescriptionURI)

withExtensibleChannelTypeIds

public ThingTypeBuilder withExtensibleChannelTypeIds(List<String> extensibleChannelTypeIds)

withSupportedBridgeTypeUIDs

public ThingTypeBuilder withSupportedBridgeTypeUIDs(List<String> supportedBridgeTypeUIDs)

withSemanticEquipmentTag

public ThingTypeBuilder withSemanticEquipmentTag(String semanticEquipmentTag)

withSemanticEquipmentTag

public ThingTypeBuilder withSemanticEquipmentTag(SemanticTag semanticEquipmentTag)