Package arez.annotations
Annotation Interface SuppressArezWarnings
@Target({TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE})
@Retention(CLASS)
public @interface SuppressArezWarnings
Indicate that the named Arez compiler warnings should be suppressed in the
annotated element (and in all program elements contained 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. For
example, if you annotate a class to suppress one warning and annotate a
method to suppress another, both warnings will be suppressed in the method.
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.
This class may be used instead of SuppressWarnings
when the compiler
is passed compiled classes. The SuppressWarnings
has a source retention
policy and is thus not available when the files are already compiled and is thus
not useful when attempting to suppress warnings in already compiled code.
-
Required Element Summary
-
Element Details
-
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.- Returns:
- the set of warnings to be suppressed
-