Requires


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.Annotation  ;
24  import java.lang.annotation.Retention  ;
25  import java.lang.annotation.RetentionPolicy  ;
26  
27  import spoon.aval.annotation.Implementation;
28  import spoon.aval.support.validator.RequiresValidator;
29  import spoon.aval.support.validator.problemFixer.DefaultRequiresProblemFixer;
30  import spoon.aval.support.validator.problemFixer.RemoveThisAnnotation;
31  import spoon.processing.ProblemFixer;
32  import spoon.processing.Severity;
33  import spoon.reflect.declaration.CtAnnotationType;
34  
35  /**
36   * Validator that states that elements annotated with this annotation must alse be
37   * annotated with another one
38   * <p>
39   * For example if <code>&#64;B</code> must be placed on the same element as <code>@A</code>, 
40   * the declaration of <code>&#64;B</code> would be:
41   * 
42   * <p>
43   * <pre>
44   * &#64;Requieres(A.class)
45   * &#64;Target(FIELD)
46   * public &#64;interface B{}
47   * </pre>
48   * </p>
49   * 
50   * @see spoon.aval.support.validator.RequiresValidator
51   */
52  @Retention  (RetentionPolicy.RUNTIME)
53  @AValTarget(CtAnnotationType.class)
54  @Implementation(RequiresValidator.class)
55  public @interface Requires {
56      /**
57       * The other annotation
58       */
59      Class  <? extends Annotation  > value();
60      /**
61       * Message to report when validation fails
62       */
63      String   message() default "The use of this annotation requires @?val annotation";
64      
65      /**
66       * Severity of the validation faliure
67       */
68      Severity severity() default Severity.WARNING;
69      /**
70       * The list of {@link ProblemFixer}s to propose 
71       * when the validation fails.
72       */
73      Class  <? extends ProblemFixer>[] fixers() default {RemoveThisAnnotation.class, DefaultRequiresProblemFixer.class};
74  
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