AValTarget


1   /** 
2    * Spoon - http://spoon.gforge.inria.fr/
3    * Copyright (C) 2006 INRIA Futurs <renaud.pawlak@inria.fr>
4    * 
5    * This software is governed by the CeCILL-C License under French law and
6    * abiding by the rules of distribution of free software. You can use, 
7    * modify and/or redistribute the software under the terms of the
8    * CeCILL-C
9    * 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   */
20  
21  package spoon.aval.annotation.structure;
22  
23  import java.lang.annotation.Retention  ;
24  import java.lang.annotation.RetentionPolicy  ;
25  
26  import spoon.aval.annotation.Implementation;
27  import spoon.aval.support.validator.AValTargetValidator;
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  import spoon.reflect.declaration.CtElement;
33  
34  /**
35   * Validator that states on which elements can an annotation be places
36   * 
37   * These elements (classes, interfaces) are defined through
38   * spoon.reflect.declaration classes.
39   * <p>
40   * For example, to say that an annotation can only be placed on interfaces, this
41   * would be the used:
42   * 
43   * <pre>
44   * &#64;AValTarget(CtInterface.class)
45   * public &#64;interface Example {
46   * }
47   * </pre>
48   * 
49   * @see spoon.aval.support.validator.AValTargetValidator
50   */
51  @Retention  (RetentionPolicy.RUNTIME)
52  @AValTarget(CtAnnotationType.class)
53  @Implementation(AValTargetValidator.class)
54  public @interface AValTarget {
55      /**
56       * The annotation can only be placed on declarations of this kind
57       */
58      Class  <? extends CtElement> value();
59  
60      /**
61       * Message to report when validation fails
62       */
63      String   message() default "This annotation can only be placed on ?val";
64      
65      /**
66       * Severity of the validation faliure
67       */
68      Severity severity() default Severity.WARNING;
69      
70      /**
71       * The list of {@link ProblemFixer}s to propose 
72       * when the validation fails.
73       */
74      Class  <? extends ProblemFixer>[] fixers() default {RemoveThisAnnotation.class};
75  
76  }
77
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags