1 /* 2 * Copyright 2004 Sun Microsystems, Inc. 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. Sun designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 22 * CA 95054 USA or visit www.sun.com if you need additional information or 23 * have any questions. 24 */ 25 26 package java.lang; 27 28 import java.lang.annotation.*; 29 import java.lang.annotation.ElementType; 30 import static java.lang.annotation.ElementType.*; 31 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 * @since 1.5 46 * @author Josh Bloch 47 */ 48 @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) 49 @Retention(RetentionPolicy.SOURCE) 50 public @interface SuppressWarnings { 51 /** 52 * The set of warnings that are to be suppressed by the compiler in the 53 * annotated element. Duplicate names are permitted. The second and 54 * successive occurrences of a name are ignored. The presence of 55 * unrecognized warning names is <i>not</i> an error: Compilers must 56 * ignore any warning names they do not recognize. They are, however, 57 * free to emit a warning if an annotation contains an unrecognized 58 * warning name. 59 * 60 * <p>Compiler vendors should document the warning names they support in 61 * conjunction with this annotation type. They are encouraged to cooperate 62 * to ensure that the same names work across multiple compilers. 63 */ 64 String[] value(); 65 }