com.vaadin.data

Interface ValidationResult

All Superinterfaces:

Serializable

All Known Implementing Classes:

ValidationResult.SimpleValidationResult

public interface ValidationResult
extends Serializable

Represents the result of a validation. A result may be either successful or contain an error message in case of a failure.

ValidationResult instances are created using the factory methods ok() and error(String), denoting success and failure respectively.

Since:

8.0

Author:

Vaadin Ltd

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ValidationResult.SimpleValidationResult

Method Summary

Modifier and Type	Method and Description
static ValidationResult	error(String errorMessage) Creates the validation result which represent an error with the given errorMessage.
String	getErrorMessage() Returns the result message.
boolean	isError() Checks if the result denotes an error.
static ValidationResult	ok() Returns a successful result.

Method Detail

getErrorMessage

String getErrorMessage()

Returns the result message.

Throws an IllegalStateException if the result represents success.

Returns:

the error message

Throws:

IllegalStateException - if the result represents success

isError

boolean isError()

Checks if the result denotes an error.

Returns:

true if the result denotes an error, false otherwise

ok

static ValidationResult ok()

Returns a successful result.

Returns:

the successful result

error

static ValidationResult error(String errorMessage)

Creates the validation result which represent an error with the given errorMessage.

Parameters:

errorMessage - error message, not null

Returns:

validation result which represent an error with the given errorMessage

Throws:

NullPointerException - if errorMessage is null