Package org.openhab.core.config.core

Class ConfigDescriptionParameterBuilder

java.lang.Object

org.openhab.core.config.core.ConfigDescriptionParameterBuilder

public class ConfigDescriptionParameterBuilder
extends Object

The ConfigDescriptionParameterBuilder class provides a builder for the ConfigDescriptionParameter class.

Author:

Chris Jackson - Initial contribution, Thomas Höfer - Added unit

Method Summary

Modifier and Type	Method	Description
ConfigDescriptionParameter	build()	Builds a result with the settings of this builder.
static ConfigDescriptionParameterBuilder	create(String name, ConfigDescriptionParameter.Type type)	Creates a parameter builder
ConfigDescriptionParameterBuilder	withAdvanced(Boolean advanced)	Set the configuration parameter as an advanced parameter
ConfigDescriptionParameterBuilder	withContext(String context)	Set the context of the configuration parameter
ConfigDescriptionParameterBuilder	withDefault(String defaultValue)	Set the default value of the configuration parameter
ConfigDescriptionParameterBuilder	withDescription(String description)	Set the description of the configuration parameter
ConfigDescriptionParameterBuilder	withFilterCriteria(List<FilterCriteria> filterCriteria)	Set the filter criteria of the configuration parameter
ConfigDescriptionParameterBuilder	withGroupName(String groupName)	Set the configuration parameter to be limited to the values in the options list
ConfigDescriptionParameterBuilder	withLabel(String label)	Set the label of the configuration parameter
ConfigDescriptionParameterBuilder	withLimitToOptions(Boolean limitToOptions)	Set the configuration parameter to be limited to the values in the options list
ConfigDescriptionParameterBuilder	withMaximum(BigDecimal max)	Set the maximum value of the configuration parameter
ConfigDescriptionParameterBuilder	withMinimum(BigDecimal min)	Set the minimum value of the configuration parameter
ConfigDescriptionParameterBuilder	withMultiple(Boolean multiple)	Set the configuration parameter to allow multiple selection
ConfigDescriptionParameterBuilder	withMultipleLimit(Integer multipleLimit)	Set the configuration parameter to allow multiple selection
ConfigDescriptionParameterBuilder	withOptions(List<ParameterOption> options)	Set the options of the configuration parameter
ConfigDescriptionParameterBuilder	withPattern(String pattern)	Set the pattern of the configuration parameter
ConfigDescriptionParameterBuilder	withReadOnly(Boolean readOnly)	Set the configuration parameter as read only
ConfigDescriptionParameterBuilder	withRequired(Boolean required)	Set the configuration parameter to be required
ConfigDescriptionParameterBuilder	withStepSize(BigDecimal step)	Set the step size of the configuration parameter
ConfigDescriptionParameterBuilder	withUnit(String unit)	Sets the unit of the configuration parameter.
ConfigDescriptionParameterBuilder	withUnitLabel(String unitLabel)	Sets the unit label of the configuration parameter.
ConfigDescriptionParameterBuilder	withVerify(Boolean verify)	Set the configuration parameter as a verifyable parameter

Methods inherited from class java.lang.Object

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

Method Details

create

public static ConfigDescriptionParameterBuilder create(String name,
 ConfigDescriptionParameter.Type type)

Creates a parameter builder

Parameters:

name - configuration parameter name

type - configuration parameter type

Returns:

parameter builder

withMinimum

public ConfigDescriptionParameterBuilder withMinimum(BigDecimal min)

Set the minimum value of the configuration parameter

Parameters:

min - the min value of the ConfigDescriptionParameter

Returns:

the updated builder instance

withMaximum

public ConfigDescriptionParameterBuilder withMaximum(BigDecimal max)

Set the maximum value of the configuration parameter

Parameters:

max - the max value of the ConfigDescriptionParameter

Returns:

the updated builder instance

withStepSize

public ConfigDescriptionParameterBuilder withStepSize(BigDecimal step)

Set the step size of the configuration parameter

Parameters:

step - the step of the ConfigDescriptionParameter

Returns:

the updated builder instance

withPattern

public ConfigDescriptionParameterBuilder withPattern(String pattern)

Set the pattern of the configuration parameter

Parameters:

pattern - the pattern for the ConfigDescriptionParameter

Returns:

the updated builder instance

withReadOnly

public ConfigDescriptionParameterBuilder withReadOnly(Boolean readOnly)

Set the configuration parameter as read only

Parameters:

readOnly - true to make the parameter read only

Returns:

the updated builder instance

withMultiple

public ConfigDescriptionParameterBuilder withMultiple(Boolean multiple)

Set the configuration parameter to allow multiple selection

Parameters:

multiple - true for multiple selection

Returns:

the updated builder instance

withMultipleLimit

public ConfigDescriptionParameterBuilder withMultipleLimit(Integer multipleLimit)

Set the configuration parameter to allow multiple selection

Parameters:

multipleLimit - the parameters limit

Returns:

the updated builder instance

withContext

public ConfigDescriptionParameterBuilder withContext(String context)

Set the context of the configuration parameter

Parameters:

context - the context for this parameter

Returns:

the updated builder instance

withRequired

public ConfigDescriptionParameterBuilder withRequired(Boolean required)

Set the configuration parameter to be required

Parameters:

required - true if the parameter is required

Returns:

the updated builder instance

withDefault

public ConfigDescriptionParameterBuilder withDefault(String defaultValue)

Set the default value of the configuration parameter

Parameters:

defaultValue - the default value of the configuration parameter

Returns:

the updated builder instance

withLabel

public ConfigDescriptionParameterBuilder withLabel(String label)

Set the label of the configuration parameter

Parameters:

label - a short user friendly description

Returns:

the updated builder instance

withDescription

public ConfigDescriptionParameterBuilder withDescription(String description)

Set the description of the configuration parameter

Parameters:

description - a detailed user friendly description

Returns:

the updated builder instance

withOptions

public ConfigDescriptionParameterBuilder withOptions(List<ParameterOption> options)

Set the options of the configuration parameter

Parameters:

options - the options for this parameter

Returns:

the updated builder instance

withAdvanced

public ConfigDescriptionParameterBuilder withAdvanced(Boolean advanced)

Set the configuration parameter as an advanced parameter

Parameters:

advanced - true to make the parameter advanced

Returns:

the updated builder instance

withVerify

public ConfigDescriptionParameterBuilder withVerify(Boolean verify)

Set the configuration parameter as a verifyable parameter

Parameters:

verify - flag

withLimitToOptions

public ConfigDescriptionParameterBuilder withLimitToOptions(Boolean limitToOptions)

Set the configuration parameter to be limited to the values in the options list

Parameters:

limitToOptions - true if only the declared options are acceptable

Returns:

the updated builder instance

withGroupName

public ConfigDescriptionParameterBuilder withGroupName(String groupName)

Set the configuration parameter to be limited to the values in the options list

Parameters:

groupName - the group name of this config description parameter

Returns:

the updated builder instance

withFilterCriteria

public ConfigDescriptionParameterBuilder withFilterCriteria(List<FilterCriteria> filterCriteria)

Set the filter criteria of the configuration parameter

Parameters:

filterCriteria - the filter criteria

Returns:

the updated builder instance

withUnit

public ConfigDescriptionParameterBuilder withUnit(String unit)

Sets the unit of the configuration parameter.

Parameters:

unit - the unit to be set

Returns:

the updated builder instance

withUnitLabel

public ConfigDescriptionParameterBuilder withUnitLabel(String unitLabel)

Sets the unit label of the configuration parameter.

Parameters:

unitLabel - the unit label to be set

Returns:

the updated builder instance

build

public ConfigDescriptionParameter build()
                                 throws IllegalArgumentException

Builds a result with the settings of this builder.

Returns:

the desired result

Throws:

IllegalArgumentException