Package org.openhab.core.config.core

Class ConfigDescriptionParameterGroupBuilder

java.lang.Object

org.openhab.core.config.core.ConfigDescriptionParameterGroupBuilder

@NonNullByDefault
public class ConfigDescriptionParameterGroupBuilder
extends Object

The ConfigDescriptionParameterGroupBuilder class provides a builder for the ConfigDescriptionParameterGroup class.

Author:

Christoph Weitkamp - Initial contribution

Method Summary

Modifier and Type	Method	Description
ConfigDescriptionParameterGroup	build()	Builds a result with the settings of this builder.
static ConfigDescriptionParameterGroupBuilder	create(String name)	Creates a parameter group builder
ConfigDescriptionParameterGroupBuilder	withAdvanced(@Nullable Boolean advanced)	Sets the advanced flag for this group.
ConfigDescriptionParameterGroupBuilder	withContext(@Nullable String context)	Set.
ConfigDescriptionParameterGroupBuilder	withDescription(@Nullable String description)	Sets the human readable description of the parameter group.
ConfigDescriptionParameterGroupBuilder	withLabel(@Nullable String label)	Sets the human readable label of the group.

Methods inherited from class java.lang.Object

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

Method Details

create

public static ConfigDescriptionParameterGroupBuilder create(String name)

Creates a parameter group builder

Parameters:

name - configuration parameter name

Returns:

parameter group builder

withContext

public ConfigDescriptionParameterGroupBuilder withContext(@Nullable String context)

Set. the context of the group.

Parameters:

context - group context as a string

Returns:

the updated builder instance

withAdvanced

public ConfigDescriptionParameterGroupBuilder withAdvanced(@Nullable Boolean advanced)

Sets the advanced flag for this group.

Parameters:

advanced - true if the group contains advanced properties

Returns:

the updated builder instance

withLabel

public ConfigDescriptionParameterGroupBuilder withLabel(@Nullable String label)

Sets the human readable label of the group.

Parameters:

label - as a string

Returns:

the updated builder instance

withDescription

public ConfigDescriptionParameterGroupBuilder withDescription(@Nullable String description)

Sets the human readable description of the parameter group.

Parameters:

description - as a string

Returns:

the updated builder instance

build

public ConfigDescriptionParameterGroup build()
                                      throws IllegalArgumentException

Builds a result with the settings of this builder.

Returns:

the desired result

Throws:

IllegalArgumentException