1/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package java.lang;
18
19import static java.lang.annotation.ElementType.CONSTRUCTOR;
20import static java.lang.annotation.ElementType.FIELD;
21import static java.lang.annotation.ElementType.LOCAL_VARIABLE;
22import static java.lang.annotation.ElementType.METHOD;
23import static java.lang.annotation.ElementType.PARAMETER;
24import static java.lang.annotation.ElementType.TYPE;
25import java.lang.annotation.Retention;
26import static java.lang.annotation.RetentionPolicy.CLASS;
27import java.lang.annotation.Target;
28
29/**
30 * Suppress FindBugs warnings on the annotated element. FindBugs will recognize
31 * any annotation that has class retention and whose name ends with
32 * "SuppressWarnings".
33 *
34 * @hide
35 */
36@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
37@Retention(CLASS)
38public @interface FindBugsSuppressWarnings {
39
40    /**
41     * The <a href="http://findbugs.sourceforge.net/bugDescriptions.html">FindBugs
42     * Patterns</a> to suppress, such as {@code SE_TRANSIENT_FIELD_NOT_RESTORED}
43     * or {@code Se}. Full, upper case names are preferred.
44     */
45    String[] value();
46}
47