Class ValidationError

public class ValidationError
extends java.lang.Object

Provides a Form function validation error.

Since:

17.10.0

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	errorKey	The validation error message key.
java.util.Map<java.lang.String,​java.lang.Object>	parameters	The validation error message parameters.
java.lang.String	path	The data element path.

Constructor Summary

Constructors

Constructor	Description
ValidationError​(java.lang.String errorKey)	Create a validation error with the given errorKey.
ValidationError​(java.lang.String errorKey, java.lang.String path)	Create a validation error with the given errorKey and data path.
ValidationError​(java.lang.String errorKey, java.lang.String path, java.util.Map<java.lang.String,​java.lang.Object> parameters)	Create a validation error with the given errorKey, data path and parameters.

Method Summary

All Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

errorKey

public final java.lang.String errorKey The validation error message key.

path

public final java.lang.String path The data element path.

parameters

public final java.util.Map<java.lang.String,​java.lang.Object> parameters The validation error message parameters.

Constructor Detail

ValidationError

public ValidationError​(java.lang.String errorKey) Create a validation error with the given errorKey.

Parameters:

errorKey - the validation errorKey (required)

ValidationError

public ValidationError​(java.lang.String errorKey,
                       java.lang.String path)

Create a validation error with the given errorKey and data path.

Parameters:

errorKey - the validation errorKey (required)

path - the validation error data path (optional)

ValidationError

public ValidationError​(java.lang.String errorKey,
                       java.lang.String path,
                       java.util.Map<java.lang.String,​java.lang.Object> parameters)

Create a validation error with the given errorKey, data path and parameters.

Parameters:

errorKey - the validation errorKey (required)

path - the validation error data path (optional)

parameters - the validation error parameters (optional)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.