1 /*
2  * Copyright (c) 2004, 2019, 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 // Android-changed: Remove @Target(MODULE) until it's needed. ART doesn't support the module system.
32 /**
33  * Indicates that the named compiler warnings should be suppressed in the
34  * annotated element (and in all program elements contained in the annotated
35  * element).  Note that the set of warnings suppressed in a given element is
36  * a superset of the warnings suppressed in all containing elements.  For
37  * example, if you annotate a class to suppress one warning and annotate a
38  * method to suppress another, both warnings will be suppressed in the method.
39  *
40  * <p>As a matter of style, programmers should always use this annotation
41  * on the most deeply nested element where it is effective.  If you want to
42  * suppress a warning in a particular method, you should annotate that
43  * method rather than its class.
44  *
45  * @author Josh Bloch
46  * @since 1.5
47  * @jls 4.8 Raw Types
48  * @jls 4.12.2 Variables of Reference Type
49  * @jls 5.1.9 Unchecked Conversion
50  * @jls 5.5 Casting Contexts
51  * @jls 9.6.4.5 @SuppressWarnings
52  */
53 @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
54 @Retention(RetentionPolicy.SOURCE)
55 public @interface SuppressWarnings {
56     /**
57      * The set of warnings that are to be suppressed by the compiler in the
58      * annotated element.  Duplicate names are permitted.  The second and
59      * successive occurrences of a name are ignored.  The presence of
60      * unrecognized warning names is <i>not</i> an error: Compilers must
61      * ignore any warning names they do not recognize.  They are, however,
62      * free to emit a warning if an annotation contains an unrecognized
63      * warning name.
64      *
65      * <p> The string {@code "unchecked"} is used to suppress
66      * unchecked warnings. Compiler vendors should document the
67      * additional warning names they support in conjunction with this
68      * annotation type. They are encouraged to cooperate to ensure
69      * that the same names work across multiple compilers.
70      * @return the set of warnings to be suppressed
71      */
value()72     String[] value();
73 }
74