Package org.openhab.core.config.core.status

Class ConfigStatusMessage.Builder

java.lang.Object

org.openhab.core.config.core.status.ConfigStatusMessage.Builder

Enclosing class:

ConfigStatusMessage

public static class ConfigStatusMessage.Builder
extends Object

The builder for a ConfigStatusMessage object.

Method Summary

Modifier and Type	Method	Description
ConfigStatusMessage	build()	Builds the new ConfigStatusMessage object.
static ConfigStatusMessage.Builder	error(String parameterName)	Creates a builder for the construction of a ConfigStatusMessage having type ConfigStatusMessage.Type.ERROR.
static ConfigStatusMessage.Builder	information(String parameterName)	Creates a builder for the construction of a ConfigStatusMessage having type ConfigStatusMessage.Type.INFORMATION.
static ConfigStatusMessage.Builder	pending(String parameterName)	Creates a builder for the construction of a ConfigStatusMessage having type ConfigStatusMessage.Type.PENDING.
static ConfigStatusMessage.Builder	warning(String parameterName)	Creates a builder for the construction of a ConfigStatusMessage having type ConfigStatusMessage.Type.WARNING.
ConfigStatusMessage.Builder	withArguments(Object... arguments)	Adds the given arguments (to be injected into the internationalized message) to the builder.
ConfigStatusMessage.Builder	withMessageKeySuffix(String messageKeySuffix)	Adds the given message key suffix for the creation of ConfigStatusMessage.messageKey.
ConfigStatusMessage.Builder	withStatusCode(Integer statusCode)	Adds the given status code to the builder.

Methods inherited from class java.lang.Object

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

Method Details

information

public static ConfigStatusMessage.Builder information(String parameterName)

Creates a builder for the construction of a ConfigStatusMessage having type ConfigStatusMessage.Type.INFORMATION.

Parameters:

parameterName - the name of the configuration parameter (must not be null)

Returns:

the new builder instance

warning

public static ConfigStatusMessage.Builder warning(String parameterName)

Creates a builder for the construction of a ConfigStatusMessage having type ConfigStatusMessage.Type.WARNING.

Parameters:

parameterName - the name of the configuration parameter (must not be null)

Returns:

the new builder instance

error

public static ConfigStatusMessage.Builder error(String parameterName)

Creates a builder for the construction of a ConfigStatusMessage having type ConfigStatusMessage.Type.ERROR.

Parameters:

parameterName - the name of the configuration parameter (must not be null)

Returns:

the new builder instance

pending

public static ConfigStatusMessage.Builder pending(String parameterName)

Creates a builder for the construction of a ConfigStatusMessage having type ConfigStatusMessage.Type.PENDING.

Parameters:

parameterName - the name of the configuration parameter (must not be null)

Returns:

the new builder instance

withMessageKeySuffix

public ConfigStatusMessage.Builder withMessageKeySuffix(String messageKeySuffix)

Adds the given message key suffix for the creation of ConfigStatusMessage.messageKey.

Parameters:

messageKeySuffix - the message key suffix to be added

Returns:

the updated builder

withArguments

public ConfigStatusMessage.Builder withArguments(Object... arguments)

Adds the given arguments (to be injected into the internationalized message) to the builder.

Parameters:

arguments - the arguments to be added

Returns:

the updated builder instance

withStatusCode

public ConfigStatusMessage.Builder withStatusCode(Integer statusCode)

Adds the given status code to the builder.

Parameters:

statusCode - the status code to be added

Returns:

the updated builder

build

public ConfigStatusMessage build()

Builds the new ConfigStatusMessage object.

Returns:

new ConfigStatusMessage object.