author | darcy |
Mon, 24 Jun 2013 23:40:31 -0700 | |
changeset 18546 | 862067c6481c |
parent 16026 | 91424708dab5 |
permissions | -rw-r--r-- |
2 | 1 |
/* |
16026
91424708dab5
6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents:
8161
diff
changeset
|
2 |
* Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved. |
2 | 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 |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 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 |
* |
|
5506 | 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. |
|
2 | 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 |
* |
|
39 |
* <p>As a matter of style, programmers should always use this annotation |
|
40 |
* on the most deeply nested element where it is effective. If you want to |
|
41 |
* suppress a warning in a particular method, you should annotate that |
|
42 |
* method rather than its class. |
|
43 |
* |
|
16026
91424708dab5
6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents:
8161
diff
changeset
|
44 |
* @author Josh Bloch |
2 | 45 |
* @since 1.5 |
16026
91424708dab5
6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents:
8161
diff
changeset
|
46 |
* @jls 4.8 Raw Types |
91424708dab5
6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents:
8161
diff
changeset
|
47 |
* @jls 4.12.2 Variables of Reference Type |
91424708dab5
6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents:
8161
diff
changeset
|
48 |
* @jls 5.1.9 Unchecked Conversion |
91424708dab5
6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents:
8161
diff
changeset
|
49 |
* @jls 5.5.2 Checked Casts and Unchecked Casts |
91424708dab5
6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents:
8161
diff
changeset
|
50 |
* @jls 9.6.3.5 @SuppressWarnings |
2 | 51 |
*/ |
8161 | 52 |
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) |
2 | 53 |
@Retention(RetentionPolicy.SOURCE) |
54 |
public @interface SuppressWarnings { |
|
55 |
/** |
|
56 |
* The set of warnings that are to be suppressed by the compiler in the |
|
57 |
* annotated element. Duplicate names are permitted. The second and |
|
58 |
* successive occurrences of a name are ignored. The presence of |
|
59 |
* unrecognized warning names is <i>not</i> an error: Compilers must |
|
60 |
* ignore any warning names they do not recognize. They are, however, |
|
61 |
* free to emit a warning if an annotation contains an unrecognized |
|
62 |
* warning name. |
|
63 |
* |
|
16026
91424708dab5
6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents:
8161
diff
changeset
|
64 |
* <p> The string {@code "unchecked"} is used to suppress |
91424708dab5
6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents:
8161
diff
changeset
|
65 |
* unchecked warnings. Compiler vendors should document the |
91424708dab5
6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents:
8161
diff
changeset
|
66 |
* additional warning names they support in conjunction with this |
91424708dab5
6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents:
8161
diff
changeset
|
67 |
* annotation type. They are encouraged to cooperate to ensure |
91424708dab5
6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents:
8161
diff
changeset
|
68 |
* that the same names work across multiple compilers. |
18546
862067c6481c
8017550: Fix doclint issues in java.lang and subpackages
darcy
parents:
16026
diff
changeset
|
69 |
* @return the set of warnings to be suppressed |
2 | 70 |
*/ |
71 |
String[] value(); |
|
72 |
} |