/
ConstraintCheck.java
88 lines (81 loc) · 3.11 KB
/
ConstraintCheck.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/*
* Hibernate Validator, declare and validate application constraints
*
* License: Apache License, Version 2.0
* See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
*/
package org.hibernate.validator.ap.checks;
import java.util.Set;
import javax.lang.model.element.AnnotationMirror;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.VariableElement;
/**
* <p>
* Implementations represent checks, which determine whether a given constraint
* annotation is allowed at a given element.
* </p>
* <p>
* Implementations should be derived from {@link AbstractConstraintCheck} in
* order to implement only those check methods applicable for the element kinds
* supported by the check.
* </p>
*
* @author Gunnar Morling
*/
public interface ConstraintCheck {
/**
* Checks, whether the given annotation is allowed at the given field.
*
* @param element An annotated field.
* @param annotation An annotation at that field.
*
* @return 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.
*/
Set<ConstraintCheckError> checkField(VariableElement element,
AnnotationMirror annotation);
/**
* Checks, whether the given annotation is allowed at the given method.
*
* @param element An annotated method.
* @param annotation An annotation at that method.
*
* @return 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.
*/
Set<ConstraintCheckError> checkMethod(ExecutableElement element,
AnnotationMirror annotation);
/**
* Checks, whether the given annotation is allowed at the given annotation
* type declaration.
*
* @param element An annotated annotation type declaration.
* @param annotation An annotation at that annotation type.
*
* @return 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.
*/
Set<ConstraintCheckError> checkAnnotationType(TypeElement element,
AnnotationMirror annotation);
/**
* Checks, whether the given annotation is allowed at the given type
* declaration (class, interface, enum).
*
* @param element An annotated type declaration.
* @param annotation An annotation at that type.
*
* @return 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.
*/
Set<ConstraintCheckError> checkNonAnnotationType(TypeElement element,
AnnotationMirror annotation);
}