ninja.validation

Interface Validation

All Known Implementing Classes:

ValidationImpl

public interface Validation

This interface means the validation context (implemented by ValidationImpl) and can be injected in your controller method. There are several types of violations that can occur: field violations (on controller method fields), bean violations (on an injected beans field) or general violations (deprecated). A controller using this validation can have violations on his parameters or, if you use a injected data container like a DTO or bean, you may have violations inside this object. Each violation on a field (parameter or in an annotated bean) results in a FieldViolation. This makes it possible to validate all controller parameters at once. If an error appears while validating the controller method parameters, it results in a violation which you can get using getFieldViolations(). If your injected bean contains violations, you should use getBeanViolations().

Author:

James Roper, Philip Sommer

Method Summary

Modifier and Type	Method and Description
void	addBeanViolation(FieldViolation fieldViolation) Add a bean violation.
void	addFieldViolation(FieldViolation fieldViolation) Add a field violation to the list of filed violations.
void	addFieldViolation(java.lang.String field, ConstraintViolation constraintViolation) Add a violation to the given field
void	addViolation(ConstraintViolation constraintViolation) Deprecated.
java.util.List<FieldViolation>	getBeanViolations() Get all bean validations for that bean.
java.util.List<FieldViolation>	getFieldViolations() Get a complete list of all field violations.
java.util.List<FieldViolation>	getFieldViolations(java.lang.String fieldName) Get a complete list of field violations for a specified field.
java.util.List<ConstraintViolation>	getGeneralViolations() Deprecated.
boolean	hasBeanViolation(java.lang.String name) Checks if the validation has bean violation.
boolean	hasBeanViolations() Whether any violation occured while validating your beans Note: For now, you can only have one bean in your controller method signature, so this is explicit.
boolean	hasFieldViolation(java.lang.String field) Whether the validation context has a violation for the given field
boolean	hasViolations() Whether the validation context has violations (including field and bean violations)

Method Detail

hasViolations

boolean hasViolations()

Whether the validation context has violations (including field and bean violations)

Returns:

True if it does

hasFieldViolation

boolean hasFieldViolation(java.lang.String field)

Whether the validation context has a violation for the given field

Returns:

True if it does

addFieldViolation

void addFieldViolation(java.lang.String field,
                       ConstraintViolation constraintViolation)

Add a violation to the given field

Parameters:

field - The field to add the violation to

constraintViolation - The constraint violation

addViolation

@Deprecated
void addViolation(ConstraintViolation constraintViolation)

Deprecated.

Add a general violation

Parameters:

constraintViolation - The constraint violation

getFieldViolations

java.util.List<FieldViolation> getFieldViolations()

Get a complete list of all field violations. This list DOES NOT contain general violations (use getGeneralViolations() instead).

Returns:

A List of FieldViolation-objects

getFieldViolations

java.util.List<FieldViolation> getFieldViolations(java.lang.String fieldName)

Get a complete list of field violations for a specified field. This list DOES NOT contain general violations (use getGeneralViolations() instead).

Returns:

A List of FieldViolation-objects

getGeneralViolations

@Deprecated
java.util.List<ConstraintViolation> getGeneralViolations()

Deprecated.

Get all general constraint violations. This list does not contain any specific field violation (use getFieldViolations() instead).

Returns:

The list of general violations.

addFieldViolation

void addFieldViolation(FieldViolation fieldViolation)

Add a field violation to the list of filed violations.

Parameters:

fieldViolation -

addBeanViolation

void addBeanViolation(FieldViolation fieldViolation)

Add a bean violation. A bean, like a DTO consists of several fields which are validated. Each validation error of a dto-field results in a field-violation for that bean. Note: For now, you can only have one bean in your controller method signature, so this is explicit.

Parameters:

beanName - maybe the name of your dto

fieldViolation - the FieldViolation consisting of a cinstraintViolation and the fields name

hasBeanViolation

boolean hasBeanViolation(java.lang.String name)

Checks if the validation has bean violation.

Parameters:

name - Name of the bean.

Returns:

Whether the named bean has violation.

hasBeanViolations

boolean hasBeanViolations()

Whether any violation occured while validating your beans Note: For now, you can only have one bean in your controller method signature, so this is explicit.

Returns:

true if there are any, false if none

getBeanViolations

java.util.List<FieldViolation> getBeanViolations()

Get all bean validations for that bean. Note: For now, you can only have one bean in your controller method signature, so this is explicit.

Parameters:

beanName -

Returns:

A list of field violations