Package org.hibernate.validator.ap.internal

Class ConstraintAnnotationVisitor

java.lang.Object

javax.lang.model.util.AbstractElementVisitor6<R,P>

javax.lang.model.util.SimpleElementVisitor6<R,P>

javax.lang.model.util.ElementKindVisitor6<R,P>

javax.lang.model.util.ElementKindVisitor7<R,P>

javax.lang.model.util.ElementKindVisitor8<T,V>

org.hibernate.validator.ap.internal.AbstractElementVisitor<Void,List<AnnotationMirror>>

org.hibernate.validator.ap.internal.ConstraintAnnotationVisitor

All Implemented Interfaces:

ElementVisitor<Void,List<AnnotationMirror>>

public final class ConstraintAnnotationVisitor
extends AbstractElementVisitor<Void,List<AnnotationMirror>>

An ElementVisitor that visits annotated elements (type declarations, methods and fields) and applies different ConstraintChecks to them. Each ConstraintCheckIssue occurred will be reported using the Messager API.

Author:

Gunnar Morling

Field Summary

Fields inherited from class org.hibernate.validator.ap.internal.AbstractElementVisitor

messager, verbose

Fields inherited from class javax.lang.model.util.SimpleElementVisitor6

DEFAULT_VALUE

Constructor Summary

Constructors

Constructor	Description
ConstraintAnnotationVisitor(ProcessingEnvironment processingEnvironment, MessagerAdapter messager, Configuration configuration)

Method Summary

Modifier and Type	Method	Description
Void	visitExecutableAsMethod(ExecutableElement method, List<AnnotationMirror> mirrors)	Checks whether the given annotations are correctly specified at the given method.
Void	visitTypeAsAnnotationType(TypeElement annotationType, List<AnnotationMirror> mirrors)	Checks whether the given annotations are correctly specified at the given annotation type declaration.
Void	visitTypeAsClass(TypeElement e, List<AnnotationMirror> p)	Checks whether the given annotations are correctly specified at the given class type declaration.
Void	visitTypeAsEnum(TypeElement e, List<AnnotationMirror> p)	Checks whether the given annotations are correctly specified at the given enum type declaration.
Void	visitTypeAsInterface(TypeElement e, List<AnnotationMirror> p)	Checks whether the given annotations are correctly specified at the given interface type declaration.
Void	visitVariableAsField(VariableElement annotatedField, List<AnnotationMirror> mirrors)	Checks whether the given annotations are correctly specified at the given field.
Void	visitVariableAsParameter(VariableElement annotatedField, List<AnnotationMirror> mirrors)	Checks whether the given annotations are correctly specified at the given method parameter.

Methods inherited from class org.hibernate.validator.ap.internal.AbstractElementVisitor

reportIssues

Methods inherited from class javax.lang.model.util.ElementKindVisitor7

visitVariableAsResourceVariable

Methods inherited from class javax.lang.model.util.ElementKindVisitor6

visitExecutable, visitExecutableAsConstructor, visitExecutableAsInstanceInit, visitExecutableAsStaticInit, visitPackage, visitType, visitTypeAsRecord, visitTypeParameter, visitVariable, visitVariableAsBindingVariable, visitVariableAsEnumConstant, visitVariableAsExceptionParameter, visitVariableAsLocalVariable

Methods inherited from class javax.lang.model.util.SimpleElementVisitor6

defaultAction

Methods inherited from class javax.lang.model.util.AbstractElementVisitor6

visit, visit, visitModule, visitRecordComponent, visitUnknown

Methods inherited from class java.lang.Object

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

Constructor Details

ConstraintAnnotationVisitor

public ConstraintAnnotationVisitor(ProcessingEnvironment processingEnvironment,
 MessagerAdapter messager,
 Configuration configuration)

Method Details

visitExecutableAsMethod

public Void visitExecutableAsMethod(ExecutableElement method,
 List<AnnotationMirror> mirrors)

Checks whether the given annotations are correctly specified at the given method. The following checks are performed:

• Constraint annotations may only be given at non-static, JavaBeans getter methods which's return type is supported by the constraints.
• The @Valid annotation may only be given at non-static, non-primitive JavaBeans getter methods.

Overrides:

visitExecutableAsMethod in class ElementKindVisitor6<Void,List<AnnotationMirror>>

visitVariableAsField

public Void visitVariableAsField(VariableElement annotatedField,
 List<AnnotationMirror> mirrors)

Checks whether the given annotations are correctly specified at the given field. The following checks are performed:

• Constraint annotations may only be given at non-static fields which's type is supported by the constraints.
• The @Valid annotation may only be given at non-static, non-primitive fields.

Overrides:

visitVariableAsField in class ElementKindVisitor6<Void,List<AnnotationMirror>>

visitVariableAsParameter

public Void visitVariableAsParameter(VariableElement annotatedField,
 List<AnnotationMirror> mirrors)

Checks whether the given annotations are correctly specified at the given method parameter. The following checks are performed:

• Constraint annotation parameter values are meaningful and valid.

Overrides:

visitVariableAsParameter in class ElementKindVisitor6<Void,List<AnnotationMirror>>

visitTypeAsAnnotationType

public Void visitTypeAsAnnotationType(TypeElement annotationType,
 List<AnnotationMirror> mirrors)

Checks whether the given annotations are correctly specified at the given annotation type declaration. The following checks are performed:

• The only annotation types allowed to be annotated with other constraint annotations are composed constraint annotation type declarations.

Overrides:

visitTypeAsAnnotationType in class ElementKindVisitor6<Void,List<AnnotationMirror>>

visitTypeAsClass

public Void visitTypeAsClass(TypeElement e,
 List<AnnotationMirror> p)

Checks whether the given annotations are correctly specified at the given class type declaration. The following checks are performed:

• Constraint annotations may at types supported by the constraints.

Overrides:

visitTypeAsClass in class ElementKindVisitor6<Void,List<AnnotationMirror>>

visitTypeAsEnum

public Void visitTypeAsEnum(TypeElement e,
 List<AnnotationMirror> p)

Checks whether the given annotations are correctly specified at the given enum type declaration. The following checks are performed:

• Constraint annotations may at types supported by the constraints.

Overrides:

visitTypeAsEnum in class ElementKindVisitor6<Void,List<AnnotationMirror>>

visitTypeAsInterface

public Void visitTypeAsInterface(TypeElement e,
 List<AnnotationMirror> p)

Checks whether the given annotations are correctly specified at the given interface type declaration. The following checks are performed:

• Constraint annotations may at types supported by the constraints.

Overrides:

visitTypeAsInterface in class ElementKindVisitor6<Void,List<AnnotationMirror>>