Package org.openhab.core.config.core

Class ConfigDescriptionBuilder

java.lang.Object

org.openhab.core.config.core.ConfigDescriptionBuilder

@NonNullByDefault
public class ConfigDescriptionBuilder
extends Object

The ConfigDescriptionBuilder class provides a builder for the ConfigDescription class.

Author:

Christoph Weitkamp - Initial contribution

Method Summary

Modifier and Type	Method	Description
ConfigDescription	build()	Builds a ConfigDescription with the settings of this builder.
static ConfigDescriptionBuilder	create(URI uri)	Creates a config description builder
ConfigDescriptionBuilder	withParameter(ConfigDescriptionParameter parameter)	Adds a ConfigDescriptionParameters.
ConfigDescriptionBuilder	withParameterGroup(ConfigDescriptionParameterGroup parameterGroup)	Adds a ConfigDescriptionParameterGroup associated with the ConfigDescriptionParameters.
ConfigDescriptionBuilder	withParameterGroups(List<ConfigDescriptionParameterGroup> parameterGroups)	Adds a list of ConfigDescriptionParameterGroup associated with the ConfigDescriptionParameters.
ConfigDescriptionBuilder	withParameters(List<ConfigDescriptionParameter> parameters)	Adds a list of ConfigDescriptionParameters.

Methods inherited from class java.lang.Object

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

Method Details

create

public static ConfigDescriptionBuilder create(URI uri)

Creates a config description builder

Parameters:

uri - the URI of this description within the ConfigDescriptionRegistry

Returns:

the config description builder instance

withParameter

public ConfigDescriptionBuilder withParameter(ConfigDescriptionParameter parameter)

Adds a ConfigDescriptionParameters.

Returns:

the updated builder instance

withParameters

public ConfigDescriptionBuilder withParameters(List<ConfigDescriptionParameter> parameters)

Adds a list of ConfigDescriptionParameters.

Returns:

the updated builder instance

withParameterGroup

public ConfigDescriptionBuilder withParameterGroup(ConfigDescriptionParameterGroup parameterGroup)

Adds a ConfigDescriptionParameterGroup associated with the ConfigDescriptionParameters.

Returns:

the updated builder instance

withParameterGroups

public ConfigDescriptionBuilder withParameterGroups(List<ConfigDescriptionParameterGroup> parameterGroups)

Adds a list of ConfigDescriptionParameterGroup associated with the ConfigDescriptionParameters.

Returns:

the updated builder instance

build

public ConfigDescription build()
                        throws IllegalArgumentException

Builds a ConfigDescription with the settings of this builder.

Returns:

the desired result

Throws:

IllegalArgumentException - if the URI is invalid