1 /*
   2  * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.lang;
  27 
  28 import java.lang.annotation.*;
  29 import static java.lang.annotation.ElementType.*;
  30 
  31 /**
  32  * Indicates that the named compiler warnings should be suppressed in the
  33  * annotated element (and in all program elements contained in the annotated
  34  * element).  Note that the set of warnings suppressed in a given element is
  35  * a superset of the warnings suppressed in all containing elements.  For
  36  * example, if you annotate a class to suppress one warning and annotate a
  37  * method to suppress another, both warnings will be suppressed in the method.
  38  * However, note that if a warning is suppressed in a {@code
  39  * module-info} file, the suppression applies to elements within the
  40  * file and <em>not</em> to types contained within the module.
  41  *
  42  * <p>As a matter of style, programmers should always use this annotation
  43  * on the most deeply nested element where it is effective.  If you want to
  44  * suppress a warning in a particular method, you should annotate that
  45  * method rather than its class.
  46  *
  47  * @author Josh Bloch
  48  * @since 1.5
  49  * @jls 4.8 Raw Types
  50  * @jls 4.12.2 Variables of Reference Type
  51  * @jls 5.1.9 Unchecked Conversion
  52  * @jls 5.5 Casting Contexts
  53  * @jls 9.6.4.5 @SuppressWarnings
  54  */
  55 @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, MODULE})
  56 @Retention(RetentionPolicy.SOURCE)
  57 public @interface SuppressWarnings {
  58     /**
  59      * The set of warnings that are to be suppressed by the compiler in the
  60      * annotated element.  Duplicate names are permitted.  The second and
  61      * successive occurrences of a name are ignored.  The presence of
  62      * unrecognized warning names is <i>not</i> an error: Compilers must
  63      * ignore any warning names they do not recognize.  They are, however,
  64      * free to emit a warning if an annotation contains an unrecognized
  65      * warning name.
  66      *
  67      * <p> The string {@code "unchecked"} is used to suppress
  68      * unchecked warnings. Compiler vendors should document the
  69      * additional warning names they support in conjunction with this
  70      * annotation type. They are encouraged to cooperate to ensure
  71      * that the same names work across multiple compilers.
  72      * @return the set of warnings to be suppressed
  73      */
  74     String[] value();
  75 }