sample/java.lang.SuppressWarnings.txt

   1 *java.lang.SuppressWarnings* *SuppressWarnings* Indicates that the named compile
   2
   3 public interface interface SuppressWarnings
   4
   5   implements |java.lang.annotation.Annotation|
   6
   7 |java.lang.SuppressWarnings_Description|
   8 |java.lang.SuppressWarnings_Fields|
   9 |java.lang.SuppressWarnings_Constructors|
  10 |java.lang.SuppressWarnings_Methods|
  11
  12 ================================================================================
  13
  14 *java.lang.SuppressWarnings_Methods*
  15 |java.lang.SuppressWarnings.value()|The set of warnings that are to be suppress
  16
  17 *java.lang.SuppressWarnings_Description*
  18
  19 Indicates that the named compiler warnings should be suppressed in the
  20 annotated element (and in all program elements contained in the annotated
  21 element). Note that the set of warnings suppressed in a given element is a
  22 superset of the warnings suppressed in all containing elements. For example, if
  23 you annotate a class to suppress one warning and annotate a method to suppress
  24 another, both warnings will be suppressed in the method.
  25
  26 As a matter of style, programmers should always use this annotation on the most
  27 deeply nested element where it is effective. If you want to suppress a warning
  28 in a particular method, you should annotate that method rather than its class.
  29
  30
  31 *java.lang.SuppressWarnings.value()*
  32
  33 public |java.lang.String| value()
  34
  35 The set of warnings that are to be suppressed by the compiler in the annotated
  36 element. Duplicate names are permitted. The second and successive occurrences
  37 of a name are ignored. The presence of unrecognized warning names is not an
  38 error: Compilers must ignore any warning names they do not recognize. They are,
  39 however, free to emit a warning if an annotation contains an unrecognized
  40 warning name.
  41
  42 Compiler vendors should document the warning names they support in conjunction
  43 with this annotation type. They are encouraged to cooperate to ensure that the
  44 same names work across multiple compilers.
  45
  46
  47