Package org.openhab.core.config.core.validation

Class ConfigValidationMessage

java.lang.Object

org.openhab.core.config.core.validation.ConfigValidationMessage

public final class ConfigValidationMessage
extends Object

The ConfigValidationMessage is the result of a specific ConfigDescriptionParameter validation, e.g. the validation of the required flag or of the min/max attribute. It contains the name of the configuration parameter whose value does not meet its declaration in the ConfigDescription, a default message, a message key to be used for internationalization and an optional content to be passed as parameters into the message.

Author:

Thomas Höfer - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
final Object[]	content	The optional content to be passed as message parameters into the message.
final String	defaultMessage	The default message describing the validation issue.
final String	messageKey	The key of the message to be used for internationalization.
final String	parameterName	The name of the configuration parameter whose value does not meet its ConfigDescription declaration.

Constructor Summary

Constructors

Constructor	Description
ConfigValidationMessage(String parameterName, String defaultMessage, String messageKey)	Creates a new ConfigValidationMessage
ConfigValidationMessage(String parameterName, String defaultMessage, String messageKey, Object... content)	Creates a new ConfigValidationMessage

Method Summary

Modifier and Type	Method	Description
boolean	equals(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 whose value does not meet its ConfigDescription declaration.

defaultMessage

public final String defaultMessage

The default message describing the validation issue.

messageKey

public final String messageKey

The key of the message to be used for internationalization.

content

public final Object[] content

The optional content to be passed as message parameters into the message.

Constructor Details

ConfigValidationMessage

public ConfigValidationMessage(String parameterName,
 String defaultMessage,
 String messageKey)

Creates a new ConfigValidationMessage

Parameters:

parameterName - the parameter name

defaultMessage - the default message

messageKey - the message key to be used for internationalization

ConfigValidationMessage

public ConfigValidationMessage(String parameterName,
 String defaultMessage,
 String messageKey,
 Object... content)

Creates a new ConfigValidationMessage

Parameters:

parameterName - the parameter name

defaultMessage - the default message

messageKey - the message key to be used for internationalization

content - the content to be passed as parameters into the message

Method Details

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object