br.com.caelum.vraptor.validator

Interface Validator

All Known Implementing Classes:

AbstractValidator, DefaultValidator, MockValidator

public interface Validator

A validator interface for VRaptor. It allows you to assert for specific situations.

Author:

Guilherme Silveira

Method Summary

Modifier and Type	Method and Description
Validator	add(Message message) Adds the message and return the same validator instance.
Validator	addAll(Collection<? extends Message> messages) Adds the list of messages and return the same validator instance.
<T> Validator	addAll(Set<javax.validation.ConstraintViolation<T>> errors) Add messages from bean validation translating to vraptor Message.
Validator	addIf(boolean expression, Message message) Adds the message to validation errors if the expression is true.
Validator	check(boolean expression, Message message) alias to ensure
Validator	ensure(boolean expression, Message message) Ensure that expression is true, otherwise adds the message to validation errors.
List<Message>	getErrors() Returns a list of errors.
boolean	hasErrors() Return true if has validation errors.
<T> T	onErrorForwardTo(Class<T> controller) Shortcut for
<T> T	onErrorForwardTo(T controller) Shortcut for
<T> T	onErrorRedirectTo(Class<T> controller) Shortcut for
<T> T	onErrorRedirectTo(T controller) Shortcut for
void	onErrorSendBadRequest() Shortcut for
<T extends View> T	onErrorUse(Class<T> view) If validator has errors, you can use this method to define what to do.
<T> T	onErrorUsePageOf(Class<T> controller) Shortcut for
<T> T	onErrorUsePageOf(T controller) Shortcut for
Validator	validate(Object object, Class<?>... groups) Validate an object instance using bean validation.

Method Detail

ensure

Validator ensure(boolean expression,
                 Message message)

Ensure that expression is true, otherwise adds the message to validation errors.

Parameters:

expression - expression to test

message - the message to add if expression is false.

Returns:

the same validator

Since:

4.0.0

check

Validator check(boolean expression,
                Message message)

alias to ensure

Parameters:

expression - expression to test

message - the message to add if expression is false.

Returns:

the same validator

Since:

4.0.0

addIf

Validator addIf(boolean expression,
                Message message)

Adds the message to validation errors if the expression is true.

Parameters:

expression - expression to test

message - the message to add if expression is true.

Returns:

the same validator

Since:

4.0.0

validate

Validator validate(Object object,
                   Class<?>... groups)

Validate an object instance using bean validation.

Parameters:

object - object to validate.

groups - if you want to validate a group of properties.

Returns:

add

Validator add(Message message)

Adds the message and return the same validator instance.

Parameters:

message -

addAll

Validator addAll(Collection<? extends Message> messages)

Adds the list of messages and return the same validator instance.

Parameters:

messages -

addAll

<T> Validator addAll(Set<javax.validation.ConstraintViolation<T>> errors)

Add messages from bean validation translating to vraptor Message.

Parameters:

errors -

getErrors

List<Message> getErrors()

Returns a list of errors.

Returns:

hasErrors

boolean hasErrors()

Return true if has validation errors. False otherwise.

Returns:

onErrorUse

<T extends View> T onErrorUse(Class<T> view)

If validator has errors, you can use this method to define what to do. WARN: this method don't stop the flow.

Parameters:

view -

Returns:

onErrorForwardTo

<T> T onErrorForwardTo(Class<T> controller)

Shortcut for

onErrorUse(logic()).forwardTo(controller);

onErrorForwardTo

<T> T onErrorForwardTo(T controller)

Shortcut for

onErrorUse(logic()).forwardTo(controller.getClass());

For usage in the same controller:

validator.onErrorForwardTo(this).someLogic();

onErrorRedirectTo

<T> T onErrorRedirectTo(Class<T> controller)

Shortcut for

onErrorUse(logic()).redirectTo(controller);

onErrorRedirectTo

<T> T onErrorRedirectTo(T controller)

Shortcut for

onErrorUse(logic()).redirectTo(controller.getClass());

For usage in the same controller:

validator.onErrorRedirectTo(this).someLogic();

onErrorUsePageOf

<T> T onErrorUsePageOf(Class<T> controller)

Shortcut for

onErrorUse(page()).of(controller);

onErrorUsePageOf

<T> T onErrorUsePageOf(T controller)

Shortcut for

onErrorUse(page()).of(controller.getClass());

For usage in the same controller:

validator.onErrorUsePageOf(this).someLogic();

onErrorSendBadRequest

void onErrorSendBadRequest()

Shortcut for

onErrorUse(status()).badRequest(errors);

the actual validation errors list will be used.