Package de.knightsoftnet.validators.annotation.processor

Interface TypeElementConstraintDescriptor<T extends AnnotationMirror>

All Known Implementing Classes:
TypeElementConstraintDescriptorImpl
public interface TypeElementConstraintDescriptor<T extends AnnotationMirror>

  • Method Details

    • getAnnotation

      T getAnnotation()
      Returns the annotation describing the constraint declaration. If a composing constraint, attribute values are reflecting the overridden attributes of the composing constraint
      Returns:
      the annotation for this constraint

    • getAttributes

      Map<String,Map.Entry<? extends ExecutableElement,? extends AnnotationValue>> getAttributes()
      Returns a map containing the annotation attribute names as keys and the annotation attribute values as value.

      If this constraint is used as part of a composed constraint, attribute values are reflecting the overridden attribute of the composing constraint.

      Returns:
      a map containing the annotation attribute names as keys and the annotation attribute values as value

    • getComposingConstraints

      List<TypeElementConstraintDescriptor<?>> getComposingConstraints()
      Return a set of composing ConstraintDescriptors where each descriptor describes a composing constraint. ConstraintDescriptor instances of composing constraints reflect overridden attribute values in getAttributes() and getAnnotation().
      Returns:
      a set of TypeElementConstraintDescriptor objects or an empty set in case there are no composing constraints

    • getConstraintValidatorClasses

      List<TypeMirror> getConstraintValidatorClasses()
      List of the constraint validation implementation classes.
      Returns:
      list of the constraint validation implementation classes

    • getGroups

      Set<TypeMirror> getGroups()
      The set of groups the constraint is applied on. If the constraint declares no group, a set with only the Default group is returned.
      Returns:
      the groups the constraint is applied on

    • getPayload

      Set<TypeElement> getPayload()
      The set of payload the constraint hosts.
      Returns:
      payload classes hosted on the constraint or an empty set if none

    • isReportAsSingleViolation

      boolean isReportAsSingleViolation()
      check if this is reported as single violation.
      Returns:
      true if the constraint is annotated with ReportAsSingleViolation

    • getDefinedOn

      org.hibernate.validator.internal.metadata.core.ConstraintOrigin getDefinedOn()
      get defined on.
      Returns:
      constraint origin

    • getConstraintLocationKind

      org.hibernate.validator.internal.metadata.location.ConstraintLocation.ConstraintLocationKind getConstraintLocationKind()
      get constraint location kind.
      Returns:
      constraint location kind