Annotation Type DefaultAnnotation


  • @Documented
    @Target({TYPE,PACKAGE})
    @Retention(CLASS)
    @Deprecated
    public @interface DefaultAnnotation
    Deprecated.
    - Use the JSR305 annotations instead. For example, you can use ParametersAreNonnullByDefault instead of @DefaultAnnotation(NonNull.class) so that method parameters are nonnull by default in the annotated element. You can also use TypeQualifierDefault in general to define your own annotation that specifies a default type qualifier. For example,

    
     Nonnegative
     TypeQualifierDefault(ElementType.PARAMETER)
     public @interface ParametersAreNonnegativeByDefault {}
     

    The JSR305 CheckReturnValue annotation can be applied to a type or package, and it will act as a default for all methods in that class or package unless otherwise overridden.

    Indicates that all members of the class or package should be annotated with the default value of the supplied annotation class. This would be used for behavior annotations such as @NonNull, @CheckForNull, or @CheckReturnValue. In particular, you can use @DefaultAnnotation(NonNull.class) on a class or package, and then use @Nullable only on those parameters, methods or fields that you want to allow to be null.
    Author:
    William Pugh
    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.Class<? extends java.lang.annotation.Annotation>[] value
      Deprecated.
       
    • Element Detail

      • value

        java.lang.Class<? extends java.lang.annotation.Annotation>[] value
        Deprecated.
      • priority

        @Deprecated
        Priority priority
        Deprecated.
        Default:
        edu.umd.cs.findbugs.annotations.Priority.MEDIUM
      • confidence

        Confidence confidence
        Deprecated.
        Default:
        edu.umd.cs.findbugs.annotations.Confidence.MEDIUM