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

Class ChannelBuilder

java.lang.Object

org.openhab.core.thing.binding.builder.ChannelBuilder

@NonNullByDefault
public class ChannelBuilder
extends Object

ChannelBuilder is responsible for creating Channels.

Author:

Dennis Nobel - Initial contribution, Alex Tugarev - Extended about default tags, Chris Jackson - Added properties and label/description

Method Summary

Modifier and Type	Method	Description
Channel	build()	Builds and returns the Channel.
static ChannelBuilder	create(Channel channel)	Creates a ChannelBuilder from the given Channel.
static ChannelBuilder	create(ChannelUID channelUID)	Creates a ChannelBuilder for the given ChannelUID.
static ChannelBuilder	create(ChannelUID channelUID, @Nullable String acceptedItemType)	Creates a ChannelBuilder for the given ChannelUID and item type.
ChannelBuilder	withAcceptedItemType(@Nullable String acceptedItemType)	Sets the accepted item type of the Channel to be build.
ChannelBuilder	withAutoUpdatePolicy(@Nullable AutoUpdatePolicy policy)	Sets the AutoUpdatePolicy to the Channel to be build.
ChannelBuilder	withConfiguration(Configuration configuration)	Appends a Configuration to the Channel to be build.
ChannelBuilder	withDefaultTags(Set<String> defaultTags)	Appends default tags to the Channel to be build.
ChannelBuilder	withDescription(String description)	Sets the channel description.
ChannelBuilder	withKind(ChannelKind kind)	Sets the ChannelKind of the Channel to be build.
ChannelBuilder	withLabel(String label)	Sets the channel label.
ChannelBuilder	withProperties(Map<String,String> properties)	Adds properties to the Channel.
ChannelBuilder	withType(@Nullable ChannelTypeUID channelTypeUID)	Appends the ChannelType given by its ChannelTypeUID to the Channel to be build

Methods inherited from class java.lang.Object

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

Method Details

create

public static ChannelBuilder create(ChannelUID channelUID)

Creates a ChannelBuilder for the given ChannelUID.

Parameters:

channelUID - the ChannelUID

Returns:

channel builder

create

public static ChannelBuilder create(ChannelUID channelUID,
 @Nullable String acceptedItemType)

Creates a ChannelBuilder for the given ChannelUID and item type.

Parameters:

channelUID - the ChannelUID

acceptedItemType - item type that is accepted by this channel

Returns:

channel builder

create

public static ChannelBuilder create(Channel channel)

Creates a ChannelBuilder from the given Channel.

Parameters:

channel - the channel to be changed

Returns:

channel builder

withType

public ChannelBuilder withType(@Nullable ChannelTypeUID channelTypeUID)

Appends the ChannelType given by its ChannelTypeUID to the Channel to be build

Parameters:

channelTypeUID - the ChannelTypeUID

Returns:

channel builder

withConfiguration

public ChannelBuilder withConfiguration(Configuration configuration)

Appends a Configuration to the Channel to be build.

Parameters:

configuration - the Configuration

Returns:

channel builder

withProperties

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

Adds properties to the Channel.

Parameters:

properties - properties to add

Returns:

channel builder

withLabel

public ChannelBuilder withLabel(String label)

Sets the channel label. This allows overriding of the default label set in the ChannelType.

Parameters:

label - the channel label to override the label set in the ChannelType

Returns:

channel builder

withDescription

public ChannelBuilder withDescription(String description)

Sets the channel description. This allows overriding of the default description set in the ChannelType.

Parameters:

description - the channel label to override the description set in the ChannelType

Returns:

channel builder

withDefaultTags

public ChannelBuilder withDefaultTags(Set<String> defaultTags)

Appends default tags to the Channel to be build.

Parameters:

defaultTags - default tags

Returns:

channel builder

withKind

public ChannelBuilder withKind(ChannelKind kind)

Sets the ChannelKind of the Channel to be build.

Parameters:

kind - the ChannelKind

Returns:

channel builder

withAcceptedItemType

public ChannelBuilder withAcceptedItemType(@Nullable String acceptedItemType)

Sets the accepted item type of the Channel to be build. See CoreItemFactory.getSupportedItemTypes() for a list of available item types.

Parameters:

acceptedItemType - item type that is accepted by this channel

Returns:

channel builder

withAutoUpdatePolicy

public ChannelBuilder withAutoUpdatePolicy(@Nullable AutoUpdatePolicy policy)

Sets the AutoUpdatePolicy to the Channel to be build.

Parameters:

policy - the AutoUpdatePolicy to be used

Returns:

channel builder

build

public Channel build()

Builds and returns the Channel.

Returns:

the Channel