org.hibernate.validator.ap.checks

Class CrossParameterConstraintCheck

java.lang.Object

org.hibernate.validator.ap.checks.AbstractConstraintCheck

org.hibernate.validator.ap.checks.CrossParameterConstraintCheck

All Implemented Interfaces:

ConstraintCheck

public class CrossParameterConstraintCheck
extends AbstractConstraintCheck

Checks that a cross-parameter constraint is defined correctly with reference to the specifications.

• It must have at most one cross-parameter validator.
• The cross-parameter validator must resolve to Object or Object[].
• If the constraint is both normal and cross-parameter, it must define a 'validationAppliesTo()' attribute.
• The 'validationAppliesTo' method, if any, must return a ConstraintTarget.
• The 'validationAppliesTo' method, if any, must declare ConstraintTarget#IMPLICIT as default return value.

Author:

Nicola Ferraro

Constructor Summary

Constructors

Constructor and Description
CrossParameterConstraintCheck(AnnotationApiHelper annotationApiHelper, ConstraintHelper constraintHelper, Types typeUtils)

Method Summary

Modifier and Type	Method and Description
Set<ConstraintCheckIssue>	checkAnnotationType(TypeElement element, AnnotationMirror annotation) Checks, whether the given annotation is allowed at the given annotation type declaration.

Methods inherited from class org.hibernate.validator.ap.checks.AbstractConstraintCheck

checkField, checkMethod, checkNonAnnotationType

Methods inherited from class java.lang.Object

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

Constructor Detail

CrossParameterConstraintCheck

public CrossParameterConstraintCheck(AnnotationApiHelper annotationApiHelper,
                                     ConstraintHelper constraintHelper,
                                     Types typeUtils)

Method Detail

checkAnnotationType

public Set<ConstraintCheckIssue> checkAnnotationType(TypeElement element,
                                                     AnnotationMirror annotation)

Description copied from interface: ConstraintCheck

Checks, whether the given annotation is allowed at the given annotation type declaration.

Specified by:

checkAnnotationType in interface ConstraintCheck

Overrides:

checkAnnotationType in class AbstractConstraintCheck

Parameters:

element - An annotated annotation type declaration.

annotation - An annotation at that annotation type.

Returns:

A set with errors, that describe, why the given annotation is not allowed at the given element. In case no errors occur (the given annotation is allowed at the given element), an empty set must be returned.