jdk/src/share/classes/java/lang/SuppressWarnings.java
author ohair
Tue, 28 Dec 2010 15:53:50 -0800
changeset 7668 d4a77089c587
parent 5506 202f599c92aa
child 8161 c64f086785d9
permissions -rw-r--r--
6962318: Update copyright year Reviewed-by: xdono
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
7668
d4a77089c587 6962318: Update copyright year
ohair
parents: 5506
diff changeset
     2
 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4672
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4672
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4672
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4672
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4672
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.lang;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.lang.annotation.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import static java.lang.annotation.ElementType.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * Indicates that the named compiler warnings should be suppressed in the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * annotated element (and in all program elements contained in the annotated
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * element).  Note that the set of warnings suppressed in a given element is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * a superset of the warnings suppressed in all containing elements.  For
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * example, if you annotate a class to suppress one warning and annotate a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * method to suppress another, both warnings will be suppressed in the method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * <p>As a matter of style, programmers should always use this annotation
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * on the most deeply nested element where it is effective.  If you want to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * suppress a warning in a particular method, you should annotate that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * method rather than its class.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * @author Josh Bloch
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 */
4672
ca386fa28a62 6908218: java.lang.Deprecated should have explicit @Target meta-annotation.
darcy
parents: 2
diff changeset
    47
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE, TYPE_PARAMETER})
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
@Retention(RetentionPolicy.SOURCE)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
public @interface SuppressWarnings {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
     * The set of warnings that are to be suppressed by the compiler in the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     * annotated element.  Duplicate names are permitted.  The second and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     * successive occurrences of a name are ignored.  The presence of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     * unrecognized warning names is <i>not</i> an error: Compilers must
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     * ignore any warning names they do not recognize.  They are, however,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     * free to emit a warning if an annotation contains an unrecognized
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     * warning name.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     * <p>Compiler vendors should document the warning names they support in
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     * conjunction with this annotation type. They are encouraged to cooperate
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     * to ensure that the same names work across multiple compilers.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    String[] value();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
}