Package org.hibernate.validator.ap.internal.checks

Class AbstractConstraintCheck

java.lang.Object
org.hibernate.validator.ap.internal.checks.AbstractConstraintCheck
All Implemented Interfaces:
ConstraintCheck
Direct Known Subclasses:
AnnotationParametersAbstractCheck, AnnotationTypeCheck, AnnotationTypeMemberCheck, ConstraintValidatorCheck, CrossParameterConstraintCheck, GetterCheck, GroupSequenceProviderCheck, MethodAnnotationCheck, MixDirectAndListAnnotationCheck, PrimitiveCheck, RetentionPolicyCheck, StaticCheck, TargetCheck, TypeCheck
public class AbstractConstraintCheck extends Object implements ConstraintCheck

Abstract base class for ConstraintCheck implementations. Concrete checks should only override those check methods applicable for their supported element types.

For instance would a check ensuring that constraint annotations are only given at non-static fields or methods only override checkField() and checkMethod().

All check methods not overridden will return an empty set.

Author:
Gunnar Morling

  • Constructor Details

    • AbstractConstraintCheck

      public AbstractConstraintCheck()

  • Method Details

    • checkField

      public Set<ConstraintCheckIssue> checkField(VariableElement element, AnnotationMirror annotation)
      Description copied from interface: ConstraintCheck
      Checks, whether the given annotation is allowed at the given field.
      Specified by:
      checkField in interface ConstraintCheck
      Parameters:
      element - An annotated field.
      annotation - An annotation at that field.
      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.

    • checkMethod

      public Set<ConstraintCheckIssue> checkMethod(ExecutableElement element, AnnotationMirror annotation)
      Description copied from interface: ConstraintCheck
      Checks, whether the given annotation is allowed at the given method.
      Specified by:
      checkMethod in interface ConstraintCheck
      Parameters:
      element - An annotated method.
      annotation - An annotation at that method.
      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.

    • 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
      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.

    • checkNonAnnotationType

      public Set<ConstraintCheckIssue> checkNonAnnotationType(TypeElement element, AnnotationMirror annotation)
      Description copied from interface: ConstraintCheck
      Checks, whether the given annotation is allowed at the given type declaration (class, interface, enum).
      Specified by:
      checkNonAnnotationType in interface ConstraintCheck
      Parameters:
      element - An annotated type declaration.
      annotation - An annotation at that 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.