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

Class BridgeBuilder

java.lang.Object

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

org.openhab.core.thing.binding.builder.BridgeBuilder

@NonNullByDefault
public class BridgeBuilder
extends ThingBuilder

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

Author:

Dennis Nobel - Initial contribution, Kai Kreuzer - Refactoring to make BridgeBuilder a subclass of ThingBuilder, Markus Rathgeb - Override methods to return BridgeBuidler instead of ThingBuidler, Andrew Fiddian-Green - Added semanticEquipmentTag

Field Summary

Fields inherited from class org.openhab.core.thing.binding.builder.ThingBuilder

thingTypeUID, thingUID

Method Summary

Modifier and Type	Method	Description
Bridge	build()	Build the thing
static BridgeBuilder	create(Bridge bridge)	Create a new bridge BridgeBuilder for a copy of the given bridge
static BridgeBuilder	create(ThingTypeUID thingTypeUID, String bridgeId)
static BridgeBuilder	create(ThingTypeUID thingTypeUID, ThingUID thingUID)
BridgeBuilder	withBridge(@Nullable ThingUID bridgeUID)	Set the bridge for this thing
BridgeBuilder	withChannel(Channel channel)	Adds the given channel to the thing
BridgeBuilder	withChannels(List<Channel> channels)	Replaces all channels of this thing with the given channels
BridgeBuilder	withChannels(Channel... channels)	Replaces all channels of this thing with the given channels
BridgeBuilder	withConfiguration(Configuration thingConfiguration)	Set (or replace) the configuration of the thing
BridgeBuilder	withLabel(@Nullable String label)	Sets the label for the thing
BridgeBuilder	withLocation(@Nullable String location)	Set the location for this thing
BridgeBuilder	withoutChannel(ChannelUID channelUID)	Removes the channel with the given UID from the thing
BridgeBuilder	withoutChannels(List<Channel> channels)	Removes the given channels from the thing
BridgeBuilder	withoutChannels(Channel... channels)	Removes the given channels from the thing
BridgeBuilder	withProperties(Map<String,String> properties)	Set/replace the properties for this thing
BridgeBuilder	withSemanticEquipmentTag(@Nullable String semanticEquipmentTag)	Set the semantic (equipment) tag for this thing
BridgeBuilder	withSemanticEquipmentTag(SemanticTag semanticEquipmentTag)	Set the semantic (equipment) tag for this thing

Methods inherited from class org.openhab.core.thing.binding.builder.ThingBuilder

create, populate, withProperty

Methods inherited from class java.lang.Object

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

Method Details

create

public static BridgeBuilder create(ThingTypeUID thingTypeUID,
 String bridgeId)

create

public static BridgeBuilder create(ThingTypeUID thingTypeUID,
 ThingUID thingUID)

create

public static BridgeBuilder create(Bridge bridge)

Create a new bridge BridgeBuilder for a copy of the given bridge

Parameters:

bridge - the Bridge to create this builder from

Returns:

the created BridgeBuilder

build

public Bridge build()

Description copied from class: ThingBuilder

Build the thing

Overrides:

build in class ThingBuilder

Returns:

the Thing

withLabel

public BridgeBuilder withLabel(@Nullable String label)

Description copied from class: ThingBuilder

Sets the label for the thing

Overrides:

withLabel in class ThingBuilder

Parameters:

label - a string containing the label

Returns:

the ThingBuilder itself

withChannel

public BridgeBuilder withChannel(Channel channel)

Description copied from class: ThingBuilder

Adds the given channel to the thing

Overrides:

withChannel in class ThingBuilder

Parameters:

channel - the Channel

Returns:

the ThingBuilder itself

withChannels

public BridgeBuilder withChannels(Channel... channels)

Description copied from class: ThingBuilder

Replaces all channels of this thing with the given channels

Overrides:

withChannels in class ThingBuilder

Parameters:

channels - one or more Channels

Returns:

the ThingBuilder itself

withChannels

public BridgeBuilder withChannels(List<Channel> channels)

Description copied from class: ThingBuilder

Replaces all channels of this thing with the given channels

Overrides:

withChannels in class ThingBuilder

Parameters:

channels - a List of Channels

Returns:

the ThingBuilder itself

withoutChannel

public BridgeBuilder withoutChannel(ChannelUID channelUID)

Description copied from class: ThingBuilder

Removes the channel with the given UID from the thing

Overrides:

withoutChannel in class ThingBuilder

Parameters:

channelUID - the ChannelUID of the channel

Returns:

the ThingBuilder itself

withoutChannels

public BridgeBuilder withoutChannels(Channel... channels)

Description copied from class: ThingBuilder

Removes the given channels from the thing

Overrides:

withoutChannels in class ThingBuilder

Parameters:

channels - one or more Channels

Returns:

the ThingBuilder itself

withoutChannels

public BridgeBuilder withoutChannels(List<Channel> channels)

Description copied from class: ThingBuilder

Removes the given channels from the thing

Overrides:

withoutChannels in class ThingBuilder

Parameters:

channels - a List of Channels

Returns:

the ThingBuilder itself

withConfiguration

public BridgeBuilder withConfiguration(Configuration thingConfiguration)

Description copied from class: ThingBuilder

Set (or replace) the configuration of the thing

Overrides:

withConfiguration in class ThingBuilder

Parameters:

thingConfiguration - a Configuration for this thing

Returns:

the ThingBuilder itself

withBridge

public BridgeBuilder withBridge(@Nullable ThingUID bridgeUID)

Description copied from class: ThingBuilder

Set the bridge for this thing

Overrides:

withBridge in class ThingBuilder

Parameters:

bridgeUID - the ThingUID of the bridge for the thing

Returns:

the ThingBuilder itself

withProperties

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

Description copied from class: ThingBuilder

Set/replace the properties for this thing

Overrides:

withProperties in class ThingBuilder

Parameters:

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

Returns:

the ThingBuilder itself

withLocation

public BridgeBuilder withLocation(@Nullable String location)

Description copied from class: ThingBuilder

Set the location for this thing

Overrides:

withLocation in class ThingBuilder

Parameters:

location - a string wih the location of the thing

Returns:

the ThingBuilder itself

withSemanticEquipmentTag

public BridgeBuilder withSemanticEquipmentTag(@Nullable String semanticEquipmentTag)

Description copied from class: ThingBuilder

Set the semantic (equipment) tag for this thing

Overrides:

withSemanticEquipmentTag in class ThingBuilder

Parameters:

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

Returns:

the ThingBuilder itself

withSemanticEquipmentTag

public BridgeBuilder withSemanticEquipmentTag(SemanticTag semanticEquipmentTag)

Description copied from class: ThingBuilder

Set the semantic (equipment) tag for this thing

Overrides:

withSemanticEquipmentTag in class ThingBuilder

Parameters:

semanticEquipmentTag - semantic (equipment) tag for this thing

Returns:

the ThingBuilder itself