Package org.openhab.core.automation.util

Class RuleBuilder

java.lang.Object

org.openhab.core.automation.util.RuleBuilder

@NonNullByDefault
public class RuleBuilder
extends Object

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

Author:

Kai Kreuzer - Initial contribution

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RuleBuilder(Rule rule)

Method Summary

Modifier and Type	Method	Description
Rule	build()
static RuleBuilder	create(String ruleUid)	Build a new Rule using the specified rule UID.
static RuleBuilder	create(String ruleUid, Rule r)	Build a new Rule with a new UID, based on an existing rule.
static RuleBuilder	create(Rule r)	Build a new Rule based on an existing rule.
static RuleBuilder	create(RuleTemplate template, String uid, @Nullable String name, Configuration configuration, Visibility visibility)	Build a new Rule from the specified RuleTemplate and Configuration.
RuleBuilder	withActions(@Nullable List<? extends Action> actions)
RuleBuilder	withActions(@Nullable Action... actions)
RuleBuilder	withConditions(@Nullable List<? extends Condition> conditions)
RuleBuilder	withConditions(@Nullable Condition... conditions)
RuleBuilder	withConfiguration(@Nullable Configuration ruleConfiguration)
RuleBuilder	withConfigurationDescriptions(@Nullable List<ConfigDescriptionParameter> configDescs)
RuleBuilder	withDescription(@Nullable String description)
RuleBuilder	withName(@Nullable String name)
RuleBuilder	withTags(String... tags)
RuleBuilder	withTags(@Nullable Collection<String> tags)
RuleBuilder	withTemplateState(Rule.TemplateState templateState)
RuleBuilder	withTemplateUID(@Nullable String uid)
RuleBuilder	withTriggers(@Nullable List<? extends Trigger> triggers)
RuleBuilder	withTriggers(@Nullable Trigger... triggers)
RuleBuilder	withVisibility(@Nullable Visibility visibility)

Methods inherited from class java.lang.Object

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

Constructor Details

RuleBuilder

protected RuleBuilder(Rule rule)

Method Details

create

public static RuleBuilder create(String ruleUid)

Build a new Rule using the specified rule UID.

Parameters:

ruleUid - the UID to use.

Returns:

The new RuleBuilder.

create

public static RuleBuilder create(Rule r)

Build a new Rule based on an existing rule.

Parameters:

r - the Rule to base the builder on.

Returns:

The new RuleBuilder.

create

public static RuleBuilder create(String ruleUid,
 Rule r)

Build a new Rule with a new UID, based on an existing rule.

Parameters:

ruleUid - the UID to use.

r - the Rule to base the builder on.

Returns:

The new RuleBuilder.

create

public static RuleBuilder create(RuleTemplate template,
 String uid,
 @Nullable String name,
 Configuration configuration,
 Visibility visibility)

Build a new Rule from the specified RuleTemplate and Configuration. The resulting rule will be ready for template placeholder substitution, but the placeholders won't actually have been substituted. This constructor is only suitable for preparing to substitute placeholders.

Parameters:

template - the RuleTemplate to use.

uid - the UID of the resulting Rule.

name - the name to initialize the builder with.

configuration - the configuration to initialize the builder with.

visibility - the Visibility to initialize the builder with.

Returns:

The new RuleBuilder.

withName

public RuleBuilder withName(@Nullable String name)

withDescription

public RuleBuilder withDescription(@Nullable String description)

withTemplateUID

public RuleBuilder withTemplateUID(@Nullable String uid)

withTemplateState

public RuleBuilder withTemplateState(Rule.TemplateState templateState)

withVisibility

public RuleBuilder withVisibility(@Nullable Visibility visibility)

withTriggers

public RuleBuilder withTriggers(@Nullable Trigger... triggers)

withTriggers

public RuleBuilder withTriggers(@Nullable List<? extends Trigger> triggers)

withConditions

public RuleBuilder withConditions(@Nullable Condition... conditions)

withConditions

public RuleBuilder withConditions(@Nullable List<? extends Condition> conditions)

withActions

public RuleBuilder withActions(@Nullable Action... actions)

withActions

public RuleBuilder withActions(@Nullable List<? extends Action> actions)

withTags

public RuleBuilder withTags(String... tags)

withTags

public RuleBuilder withTags(@Nullable Collection<String> tags)

withConfiguration

public RuleBuilder withConfiguration(@Nullable Configuration ruleConfiguration)

withConfigurationDescriptions

public RuleBuilder withConfigurationDescriptions(@Nullable List<ConfigDescriptionParameter> configDescs)

build

public Rule build()