Package org.openhab.core.automation.util

Class ModuleBuilder<B extends ModuleBuilder<B,T>,T extends Module>

java.lang.Object

org.openhab.core.automation.util.ModuleBuilder<B,T>

Direct Known Subclasses:

ActionBuilder, ConditionBuilder, TriggerBuilder

@NonNullByDefault
public abstract class ModuleBuilder<B extends ModuleBuilder<B,T>,T extends Module>
extends Object

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

Author:

Kai Kreuzer - Initial contribution, Markus Rathgeb - Split implementation for different module types in sub classes

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable Configuration	configuration
protected @Nullable String	description
protected @Nullable String	label

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModuleBuilder()
protected	ModuleBuilder(T module)

Method Summary

Modifier and Type	Method	Description
abstract T	build()
static <B extends ModuleBuilder<B, T>, T extends Module> ModuleBuilder<B,T>	create(Module module)
static ActionBuilder	createAction()
static ActionBuilder	createAction(Action action)
static ConditionBuilder	createCondition()
static ConditionBuilder	createCondition(Condition condition)
static TriggerBuilder	createTrigger()
static TriggerBuilder	createTrigger(Trigger trigger)
protected String	getId()
protected String	getTypeUID()
B	withConfiguration(Configuration configuration)
B	withDescription(@Nullable String description)
B	withId(String id)
B	withLabel(@Nullable String label)
B	withTypeUID(String typeUID)

Methods inherited from class java.lang.Object

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

Field Details

configuration

protected @Nullable Configuration configuration

label

protected @Nullable String label

description

protected @Nullable String description

Constructor Details

ModuleBuilder

protected ModuleBuilder()

ModuleBuilder

protected ModuleBuilder(T module)

Method Details

createAction

public static ActionBuilder createAction()

createAction

public static ActionBuilder createAction(Action action)

createCondition

public static ConditionBuilder createCondition()

createCondition

public static ConditionBuilder createCondition(Condition condition)

createTrigger

public static TriggerBuilder createTrigger()

createTrigger

public static TriggerBuilder createTrigger(Trigger trigger)

create

public static <B extends ModuleBuilder<B,
T>,
T extends Module>
ModuleBuilder<B,T> create(Module module)

withId

public B withId(String id)

withTypeUID

public B withTypeUID(String typeUID)

withConfiguration

public B withConfiguration(Configuration configuration)

withLabel

public B withLabel(@Nullable String label)

withDescription

public B withDescription(@Nullable String description)

getId

protected String getId()

getTypeUID

protected String getTypeUID()

build

public abstract T build()