jaroslav@557: /*
jaroslav@557:  * Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
jaroslav@557:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jaroslav@557:  *
jaroslav@557:  * This code is free software; you can redistribute it and/or modify it
jaroslav@557:  * under the terms of the GNU General Public License version 2 only, as
jaroslav@557:  * published by the Free Software Foundation.  Oracle designates this
jaroslav@557:  * particular file as subject to the "Classpath" exception as provided
jaroslav@557:  * by Oracle in the LICENSE file that accompanied this code.
jaroslav@557:  *
jaroslav@557:  * This code is distributed in the hope that it will be useful, but WITHOUT
jaroslav@557:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jaroslav@557:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jaroslav@557:  * version 2 for more details (a copy is included in the LICENSE file that
jaroslav@557:  * accompanied this code).
jaroslav@557:  *
jaroslav@557:  * You should have received a copy of the GNU General Public License version
jaroslav@557:  * 2 along with this work; if not, write to the Free Software Foundation,
jaroslav@557:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jaroslav@557:  *
jaroslav@557:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jaroslav@557:  * or visit www.oracle.com if you need additional information or have any
jaroslav@557:  * questions.
jaroslav@557:  */
jaroslav@557: 
jaroslav@557: package java.lang;
jaroslav@557: 
jaroslav@557: import java.lang.annotation.*;
jaroslav@557: import static java.lang.annotation.ElementType.*;
jaroslav@557: 
jaroslav@557: /**
jaroslav@557:  * Indicates that the named compiler warnings should be suppressed in the
jaroslav@557:  * annotated element (and in all program elements contained in the annotated
jaroslav@557:  * element).  Note that the set of warnings suppressed in a given element is
jaroslav@557:  * a superset of the warnings suppressed in all containing elements.  For
jaroslav@557:  * example, if you annotate a class to suppress one warning and annotate a
jaroslav@557:  * method to suppress another, both warnings will be suppressed in the method.
jaroslav@557:  *
jaroslav@557:  * <p>As a matter of style, programmers should always use this annotation
jaroslav@557:  * on the most deeply nested element where it is effective.  If you want to
jaroslav@557:  * suppress a warning in a particular method, you should annotate that
jaroslav@557:  * method rather than its class.
jaroslav@557:  *
jaroslav@557:  * @since 1.5
jaroslav@557:  * @author Josh Bloch
jaroslav@557:  */
jaroslav@557: @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
jaroslav@557: @Retention(RetentionPolicy.SOURCE)
jaroslav@557: public @interface SuppressWarnings {
jaroslav@557:     /**
jaroslav@557:      * The set of warnings that are to be suppressed by the compiler in the
jaroslav@557:      * annotated element.  Duplicate names are permitted.  The second and
jaroslav@557:      * successive occurrences of a name are ignored.  The presence of
jaroslav@557:      * unrecognized warning names is <i>not</i> an error: Compilers must
jaroslav@557:      * ignore any warning names they do not recognize.  They are, however,
jaroslav@557:      * free to emit a warning if an annotation contains an unrecognized
jaroslav@557:      * warning name.
jaroslav@557:      *
jaroslav@557:      * <p>Compiler vendors should document the warning names they support in
jaroslav@557:      * conjunction with this annotation type. They are encouraged to cooperate
jaroslav@557:      * to ensure that the same names work across multiple compilers.
jaroslav@557:      */
jaroslav@557:     String[] value();
jaroslav@557: }