01: /**
02: * Spoon - http://spoon.gforge.inria.fr/
03: * Copyright (C) 2006 INRIA Futurs <renaud.pawlak@inria.fr>
04: *
05: * This software is governed by the CeCILL-C License under French law and
06: * abiding by the rules of distribution of free software. You can use,
07: * modify and/or redistribute the software under the terms of the
08: * CeCILL-C
09: * license as circulated by CEA, CNRS and INRIA at the following URL:
10: * http://www.cecill.info.
11: *
12: * This program is distributed in the hope that it will be useful, but
13: * WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the CeCILL-C
15: * License for more details.
16: *
17: * The fact that you are presently reading this means that you have had
18: * knowledge of the CeCILL-C license and that you accept its terms.
19: */package spoon.aval.annotation.structure;
20:
21: import java.lang.annotation.Annotation;
22: import java.lang.annotation.Retention;
23: import java.lang.annotation.RetentionPolicy;
24:
25: import spoon.aval.annotation.Implementation;
26: import spoon.aval.support.validator.RequiresValidator;
27: import spoon.aval.support.validator.problemFixer.DefaultRequiresProblemFixer;
28: import spoon.aval.support.validator.problemFixer.RemoveThisAnnotation;
29: import spoon.processing.ProblemFixer;
30: import spoon.processing.Severity;
31: import spoon.reflect.declaration.CtAnnotationType;
32:
33: /**
34: * Validator that states that elements annotated with this annotation must alse be
35: * annotated with another one
36: * <p>
37: * For example if <code>@B</code> must be placed on the same element as <code>@A</code>,
38: * the declaration of <code>@B</code> would be:
39: *
40: * <p>
41: * <pre>
42: * @Requieres(A.class)
43: * @Target(FIELD)
44: * public @interface B{}
45: * </pre>
46: * </p>
47: *
48: * @see spoon.aval.support.validator.RequiresValidator
49: */
50: @Retention(RetentionPolicy.RUNTIME)
51: @AValTarget(CtAnnotationType.class)
52: @Implementation(RequiresValidator.class)
53: public @interface Requires {
54: /**
55: * The other annotation
56: */
57: Class<? extends Annotation> value();
58:
59: /**
60: * Message to report when validation fails
61: */
62: String message() default "The use of this annotation requires @?val annotation";
63:
64: /**
65: * Severity of the validation faliure
66: */
67: Severity severity() default Severity.WARNING;
68:
69: /**
70: * The list of {@link ProblemFixer}s to propose
71: * when the validation fails.
72: */
73: Class<? extends ProblemFixer>[] fixers() default {
74: RemoveThisAnnotation.class,
75: DefaultRequiresProblemFixer.class };
76:
77: }
|