org.mule.extension.validation.internal

Class ImmutableValidationResult

java.lang.Object

org.mule.extension.validation.internal.ImmutableValidationResult

All Implemented Interfaces:

Serializable, ValidationResult

public class ImmutableValidationResult
extends Object
implements ValidationResult

An immutable implementation of ValidationResult. It provides a series of static factory methods for creating a result in which the validation succeeded (ok()), and for validations that failed (error(I18nMessage), error(String) error(I18nMessage, ValidationErrorType) and error(String, ValidationErrorType)).

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImmutableValidationResult(String message, ValidationErrorType type, boolean error)

Method Summary

Modifier and Type	Method and Description
static ValidationResult	error(org.mule.runtime.api.i18n.I18nMessage message) Creates a new instance with the given message and which isError() returns true, with error type ValidationErrorType.VALIDATION.
static ValidationResult	error(org.mule.runtime.api.i18n.I18nMessage message, ValidationErrorType type) Creates a new instance with the given message and which isError() returns true, with error type type.
static ValidationResult	error(String message) Creates a new instance with the given message and which isError() returns true, with error type ValidationErrorType.VALIDATION.
static ValidationResult	error(String message, ValidationErrorType type) Creates a new instance with the given message and which isError() returns true, with error type type.
ValidationErrorType	getErrorType() Returns the error type associated to the result, if ValidationResult.isError() is true.
String	getMessage() Returns a message associated with the execution of the validation.
boolean	isError() Whether the validation has failed or not
static ValidationResult	ok() returns a ImmutableValidationResult without message and which isError() method returns false.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableValidationResult

public ImmutableValidationResult(String message,
                                 ValidationErrorType type,
                                 boolean error)

Method Detail

error

public static ValidationResult error(String message)

Creates a new instance with the given message and which isError() returns true, with error type ValidationErrorType.VALIDATION.

Parameters:

message - a message

Returns:

a new instance of ImmutableValidationResult

error

public static ValidationResult error(String message,
                                     ValidationErrorType type)

Creates a new instance with the given message and which isError() returns true, with error type type.

Parameters:

message - a message

type - an error type

Returns:

a new instance of ImmutableValidationResult

error

public static ValidationResult error(org.mule.runtime.api.i18n.I18nMessage message)

Creates a new instance with the given message and which isError() returns true, with error type ValidationErrorType.VALIDATION.

Parameters:

message - a message

Returns:

a new instance of ImmutableValidationResult

error

public static ValidationResult error(org.mule.runtime.api.i18n.I18nMessage message,
                                     ValidationErrorType type)

Creates a new instance with the given message and which isError() returns true, with error type type.

Parameters:

message - a message

type - an error type

Returns:

a new instance of ImmutableValidationResult

ok

public static ValidationResult ok()

returns a ImmutableValidationResult without message and which isError() method returns false. Since this class is immutable, the same instance is always returned

Returns:

OK

getMessage

public String getMessage()

Returns a message associated with the execution of the validation. If the validation failed (which means that ValidationResult.isError() is true), then it will contain the reason why the error was generated. Otherwise, it might or might not contain some additional consideration about the validation result

Specified by:

getMessage in interface ValidationResult

Returns:

a String or null

getErrorType

public ValidationErrorType getErrorType()

Returns the error type associated to the result, if ValidationResult.isError() is true.

Specified by:

getErrorType in interface ValidationResult

Returns:

a ValidationErrorType or null if there was no error

isError

public boolean isError()

Whether the validation has failed or not

Specified by:

isError in interface ValidationResult

Returns:

{code true} if the validation failed. false otherwise