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

Class ConfigStatusMessage

java.lang.Object

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

public final class ConfigStatusMessage
extends Object

The ConfigStatusMessage is a domain object for a configuration status message. It contains the name of the configuration parameter, the ConfigStatusMessage.Type information, the internationalized message and an optional status code.

The framework will take care of setting the corresponding internationalized message. For this purpose there must be an i18n properties file inside the bundle of the ConfigStatusProvider that has a message declared for the messageKey. The actual message key is built by ConfigStatusMessage.Builder.withMessageKeySuffix(String) in the manner that the given message key suffix is appended to config-status.config-status-message-type.. As a result depending on the type of the message the final constructed message keys are:

• config-status.information.any-suffix
• config-status.warning.any-suffix
• config-status.error.any-suffix
• config-status.pending.any-suffix

Author:

Thomas Höfer - Initial contribution, Chris Jackson - Add withMessageKey and remove message from other methods

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigStatusMessage.Builder	The builder for a ConfigStatusMessage object.
static enum	ConfigStatusMessage.Type	The ConfigStatusMessage.Type defines an enumeration of all supported types for a configuration status message.

Field Summary

Fields

Modifier and Type	Field	Description
final @Nullable String	message	The corresponding internationalized status message.
final String	parameterName	The name of the configuration parameter.
final @Nullable Integer	statusCode	The optional status code of the configuration status message; to be used if there are additional information to be provided.
final ConfigStatusMessage.Type	type	The ConfigStatusMessage.Type of the configuration status message.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

parameterName

public final String parameterName

The name of the configuration parameter.

type

public final ConfigStatusMessage.Type type

The ConfigStatusMessage.Type of the configuration status message.

message

public final @Nullable String message

The corresponding internationalized status message.

statusCode

public final @Nullable Integer statusCode

The optional status code of the configuration status message; to be used if there are additional information to be provided.

Method Details

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object