edu.umd.cs.findbugs.annotations.DefaultAnnotation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of killbill-platform-service-registry Show documentation
There is a newer version: 0.40.13
Show newest version
/*
 * FindBugs - Find Bugs in Java programs
 * Copyright (C) 2005, University of Maryland
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package edu.umd.cs.findbugs.annotations;

import java.lang.annotation.Annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.annotation.Nonnegative;
import javax.annotation.meta.TypeQualifierDefault;


/**
 * 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.
 *
 * @deprecated -  Use the JSR305 annotations instead.
 * For example, you can use {@link javax.annotation.ParametersAreNonnullByDefault} instead
 * of @DefaultAnnotation(NonNull.class) so that method parameters are nonnull by default in the annotated
 * element. You can also use {@link javax.annotation.meta.TypeQualifierDefault}
 * in general to define your own annotation that specifies a default type qualifier. For example,
 * 

 * {@link Nonnegative}
 * {@link TypeQualifierDefault}({@link ElementType#PARAMETER})
 * public @interface ParametersAreNonnegativeByDefault {}
 * 
 *
 * The JSR305 {@link javax.annotation.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.
 *
 * @author William Pugh
 */

@Documented
@Target({ ElementType.TYPE, ElementType.PACKAGE })
@Retention(RetentionPolicy.CLASS)
@Deprecated
public @interface DefaultAnnotation {
    Class[] value();

    @Deprecated
    Priority priority() default Priority.MEDIUM;

    Confidence confidence() default Confidence.MEDIUM;
}