Package org.openhab.core.thing.binding.builder

Class ThingBuilder

java.lang.Object

org.openhab.core.thing.binding.builder.ThingBuilder

Direct Known Subclasses:

BridgeBuilder

@NonNullByDefault
public class ThingBuilder
extends Object

This class allows the easy construction of a Thing instance using the builder pattern.

Author:

Dennis Nobel - Initial contribution, Kai Kreuzer - Refactoring to make BridgeBuilder a subclass, Andrew Fiddian-Green - Added semanticEquipmentTag

Field Summary

Fields

Modifier and Type	Field	Description
protected final ThingTypeUID	thingTypeUID
protected final ThingUID	thingUID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ThingBuilder(ThingTypeUID thingTypeUID, ThingUID thingUID)

Method Summary

Modifier and Type	Method	Description
Thing	build()	Build the thing
static ThingBuilder	create(Thing thing)	Create a new thing ThingBuilder for a copy of the given thing
static ThingBuilder	create(ThingTypeUID thingTypeUID, String thingId)	Create a new ThingBuilder
static ThingBuilder	create(ThingTypeUID thingTypeUID, ThingUID thingUID)	Create a new ThingBuilder
protected Thing	populate(org.openhab.core.thing.internal.ThingImpl thing)
ThingBuilder	withBridge(@Nullable ThingUID bridgeUID)	Set the bridge for this thing
ThingBuilder	withChannel(Channel channel)	Adds the given channel to the thing
ThingBuilder	withChannels(List<Channel> channels)	Replaces all channels of this thing with the given channels
ThingBuilder	withChannels(Channel... channels)	Replaces all channels of this thing with the given channels
ThingBuilder	withConfiguration(Configuration configuration)	Set (or replace) the configuration of the thing
ThingBuilder	withLabel(@Nullable String label)	Sets the label for the thing
ThingBuilder	withLocation(@Nullable String location)	Set the location for this thing
ThingBuilder	withoutChannel(ChannelUID channelUID)	Removes the channel with the given UID from the thing
ThingBuilder	withoutChannels(List<Channel> channels)	Removes the given channels from the thing
ThingBuilder	withoutChannels(Channel... channels)	Removes the given channels from the thing
ThingBuilder	withProperties(Map<String,String> properties)	Set/replace the properties for this thing
ThingBuilder	withProperty(String key, String value)	Set / replace a single property for this thing
ThingBuilder	withSemanticEquipmentTag(@Nullable String semanticEquipmentTag)	Set the semantic (equipment) tag for this thing
ThingBuilder	withSemanticEquipmentTag(SemanticTag semanticEquipmentTag)	Set the semantic (equipment) tag for this thing

Methods inherited from class java.lang.Object

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

Field Details

thingUID

protected final ThingUID thingUID

thingTypeUID

protected final ThingTypeUID thingTypeUID

Constructor Details

ThingBuilder

protected ThingBuilder(ThingTypeUID thingTypeUID,
 ThingUID thingUID)

Method Details

create

public static ThingBuilder create(ThingTypeUID thingTypeUID,
 String thingId)

Create a new ThingBuilder

Parameters:

thingTypeUID - the ThingTypeUID of the new thing

thingId - the id part of the ThingUID of the new thing

Returns:

the created ThingBuilder

create

public static ThingBuilder create(ThingTypeUID thingTypeUID,
 ThingUID thingUID)

Create a new ThingBuilder

Parameters:

thingTypeUID - the ThingTypeUID of the new thing

thingUID - the ThingUID of the new thing

Returns:

the created ThingBuilder

create

public static ThingBuilder create(Thing thing)

Create a new thing ThingBuilder for a copy of the given thing

Parameters:

thing - the Thing to create this builder from

Returns:

the created ThingBuilder

build

public Thing build()

Build the thing

Returns:

the Thing

withLabel

public ThingBuilder withLabel(@Nullable String label)

Sets the label for the thing

Parameters:

label - a string containing the label

Returns:

the ThingBuilder itself

withChannel

public ThingBuilder withChannel(Channel channel)

Adds the given channel to the thing

Parameters:

channel - the Channel

Returns:

the ThingBuilder itself

Throws:

IllegalArgumentException - if a channel with the same UID is already present or the ChannelUID is not valid

withChannels

public ThingBuilder withChannels(Channel... channels)

Replaces all channels of this thing with the given channels

Parameters:

channels - one or more Channels

Returns:

the ThingBuilder itself

Throws:

IllegalArgumentException - if a channel with the same UID is already present or the ChannelUID is not valid

withChannels

public ThingBuilder withChannels(List<Channel> channels)

Replaces all channels of this thing with the given channels

Parameters:

channels - a List of Channels

Returns:

the ThingBuilder itself

Throws:

IllegalArgumentException - if a channel with the same UID is already present or the ChannelUID is not valid

withoutChannel

public ThingBuilder withoutChannel(ChannelUID channelUID)

Removes the channel with the given UID from the thing

Parameters:

channelUID - the ChannelUID of the channel

Returns:

the ThingBuilder itself

withoutChannels

public ThingBuilder withoutChannels(Channel... channels)

Removes the given channels from the thing

Parameters:

channels - one or more Channels

Returns:

the ThingBuilder itself

withoutChannels

public ThingBuilder withoutChannels(List<Channel> channels)

Removes the given channels from the thing

Parameters:

channels - a List of Channels

Returns:

the ThingBuilder itself

withConfiguration

public ThingBuilder withConfiguration(Configuration configuration)

Set (or replace) the configuration of the thing

Parameters:

configuration - a Configuration for this thing

Returns:

the ThingBuilder itself

withBridge

public ThingBuilder withBridge(@Nullable ThingUID bridgeUID)

Set the bridge for this thing

Parameters:

bridgeUID - the ThingUID of the bridge for the thing

Returns:

the ThingBuilder itself

withProperty

public ThingBuilder withProperty(String key,
 String value)

Set / replace a single property for this thing

Parameters:

key - the key / name of the property

value - the value of the property

Returns:

the ThingBuilder itself

withProperties

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

Set/replace the properties for this thing

Parameters:

properties - a Map<String,String> containing the properties

Returns:

the ThingBuilder itself

withLocation

public ThingBuilder withLocation(@Nullable String location)

Set the location for this thing

Parameters:

location - a string wih the location of the thing

Returns:

the ThingBuilder itself

withSemanticEquipmentTag

public ThingBuilder withSemanticEquipmentTag(@Nullable String semanticEquipmentTag)

Set the semantic (equipment) tag for this thing

Parameters:

semanticEquipmentTag - a string with semantic (equipment) tag for this thing

Returns:

the ThingBuilder itself

withSemanticEquipmentTag

public ThingBuilder withSemanticEquipmentTag(SemanticTag semanticEquipmentTag)

Set the semantic (equipment) tag for this thing

Parameters:

semanticEquipmentTag - semantic (equipment) tag for this thing

Returns:

the ThingBuilder itself

populate

protected Thing populate(org.openhab.core.thing.internal.ThingImpl thing)