SuppressWarnings in java

java.lang.SuppressWarnings

Indicates that the named compiler warnings should be suppressed in the annotated element. Note that the set of warnings suppressed in a given element is a superset of the warnings suppressed in all containing elements.

As a matter of style, programmers should always use this annotation on the most deeply nested element where it is effective. If you want to suppress a warning in a particular method, you should annotate that method rather than its class.

Declaration

import static java.lang.annotation.ElementType.CONSTRUCTOR;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.LOCAL_VARIABLE;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.MODULE;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ TYPE, FIELD, METHOD, PARAMETER, 
   CONSTRUCTOR, LOCAL_VARIABLE, MODULE })
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {

    String[] value();
}

Methods

1. value()

String[] java.lang.SuppressWarnings.value()

The set of warnings that are to be suppressed by the compiler in the annotated element. Duplicate names are permitted.

The second and successive occurrences of a name are ignored. The presence of unrecognized warning names is not an error: Compilers must ignore any warning names they do not recognize.

They are, however, free to emit a warning if an annotation contains an unrecognized warning name.

Returns: the set of warnings to be suppressed.