DefaultAnnotationForParameters


1   /*
2    * FindBugs - Find Bugs in Java programs
3    * Copyright (C) 2005, University of Maryland
4    * 
5    * This library is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU Lesser General Public
7    * License as published by the Free Software Foundation; either
8    * version 2.1 of the License, or (at your option) any later version.
9    * 
10   * This library is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13   * Lesser General Public License for more details.
14   * 
15   * You should have received a copy of the GNU Lesser General Public
16   * License along with this library; if not, write to the Free Software
17   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   */
19  
20  package edu.umd.cs.findbugs.annotations;
21  
22  import java.lang.annotation.Annotation  ;
23  import java.lang.annotation.Documented  ;
24  import java.lang.annotation.ElementType  ;
25  import java.lang.annotation.Retention  ;
26  import java.lang.annotation.RetentionPolicy  ;
27  import java.lang.annotation.Target  ;
28  
29  /**
30   * Indicates that all members of the class or package should be
31   * annotated with the default value of the supplied annotation class.
32   * 
33   * This would be used for behavior annotations such as @NonNull, @CheckForNull,
34   * or @CheckReturnValue.
35   * 
36   * In particular, you can use @DefaultAnnotation(NonNull.class) on a class or package,
37   * and then use @Nullable only on those parameters, methods or fields that you want
38   * to allow to be null.
39   *
40   * @author William Pugh
41   */
42  
43  @Documented  
44  @Target  ({ElementType.TYPE, ElementType.PACKAGE})
45  @Retention  (RetentionPolicy.CLASS)
46  
47  public @interface DefaultAnnotationForParameters {
48      Class  <? extends Annotation  >[] value();
49      Priority priority() default Priority.MEDIUM;
50  }
51  
52

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags