at.meks.validation.result

Class ValidationResult

java.lang.Object

at.meks.validation.result.ValidationResult

public class ValidationResult
extends Object

This is the result of a validation.

Method Summary

Modifier and Type	Method and Description
static ValidationResult	fail(ErrorDescription onErrorMessage)
String	getErrorCode()
String	getErrorMessage()
boolean	isValid()
static ValidationResult	ok() this method return a ValidationResult which is valid.
void	throwIfInvalid(String myTestedParam) This method is very handy if you'd like to catch and violation without the need of using if statements.

Methods inherited from class java.lang.Object

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

Method Detail

getErrorCode

public String getErrorCode()

Returns:

error code which was set when the validation was created

getErrorMessage

public String getErrorMessage()

Returns:

the error message why the validation failed

isValid

public boolean isValid()

Returns:

false if the validation failed

ok

public static ValidationResult ok()

this method return a ValidationResult which is valid. It is normaly used by the Validation implementations which return the ValidationResult at the end of the validation of an value.

Returns:

the valid singleton ValidationResult

fail

public static ValidationResult fail(ErrorDescription onErrorMessage)

Parameters:

onErrorMessage - is set in the returned ValidationResult

Returns:

new instance of an error-ValidationResult containting the error message

throwIfInvalid

public void throwIfInvalid(String myTestedParam)
                    throws ValidationException

This method is very handy if you'd like to catch and violation without the need of using if statements. Example: old school
ValidationResult result = validation.test(testedValue); if (!result.isValid()) { //do something } result = nextValidation.test(testedValue); if (!result.isValid() { // do something } instead you can use this method. validation.test(testedValue).throwIfInvalid("testedValue"); nextValidation.test(otherValue).throwIfInvalid("otherValue"); Somewhere for sure you have to catch it and do something.

Parameters:

myTestedParam - the description what was tested. It is used in the exception message

Throws:

ValidationException - only if the method isValid() returns false