com.mesosphere.sdk.config.validate

Class ConfigValidationError

java.lang.Object

com.mesosphere.sdk.config.validate.ConfigValidationError

public class ConfigValidationError
extends java.lang.Object

Signals that a certain configuration value, or transition between two configurations, did not pass validation.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfigurationField() Returns the name of the field which had the error.
java.lang.String	getConfigurationValue() Returns the current value which triggered the error.
java.lang.String	getMessage() Returns the provided error message for this error.
java.lang.String	getPreviousConfigurationValue() Returns the previous value which failed to transition to the current value, or null if this is not a transition error.
java.lang.String	toString() Returns a complete user-facing string representation providing the error and its source.
static ConfigValidationError	transitionError(java.lang.String configField, java.lang.String oldConfigValue, java.lang.String newConfigValue, java.lang.String message) Returns a new validation error which indicates that a configuration field has an invalid transition from its previous value to the current value.
static ConfigValidationError	valueError(java.lang.String configField, java.lang.String configValue, java.lang.String message) Returns a new validation error which indicates that a configuration field has an invalid value.

Methods inherited from class java.lang.Object

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

Method Detail

valueError

public static ConfigValidationError valueError(java.lang.String configField,
                                               java.lang.String configValue,
                                               java.lang.String message)

Returns a new validation error which indicates that a configuration field has an invalid value. This is equivalent to a transition error, except with no prior value.

transitionError

public static ConfigValidationError transitionError(java.lang.String configField,
                                                    java.lang.String oldConfigValue,
                                                    java.lang.String newConfigValue,
                                                    java.lang.String message)

Returns a new validation error which indicates that a configuration field has an invalid transition from its previous value to the current value.

getConfigurationField

public java.lang.String getConfigurationField()

Returns the name of the field which had the error.

getConfigurationValue

public java.lang.String getConfigurationValue()

Returns the current value which triggered the error.

getPreviousConfigurationValue

public java.lang.String getPreviousConfigurationValue()

Returns the previous value which failed to transition to the current value, or null if this is not a transition error.

getMessage

public java.lang.String getMessage()

Returns the provided error message for this error.

toString

public java.lang.String toString()

Returns a complete user-facing string representation providing the error and its source.

Overrides:

toString in class java.lang.Object