1 /*
2  * Copyright (C) 2019 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 
17 package android.annotation;
18 
19 import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
20 import static java.lang.annotation.ElementType.CONSTRUCTOR;
21 import static java.lang.annotation.ElementType.FIELD;
22 import static java.lang.annotation.ElementType.METHOD;
23 import static java.lang.annotation.ElementType.PACKAGE;
24 import static java.lang.annotation.ElementType.TYPE;
25 
26 import java.lang.annotation.Retention;
27 import java.lang.annotation.RetentionPolicy;
28 import java.lang.annotation.Target;
29 
30 /**
31  * Indicates that an API is hidden by default, in a similar fashion to the
32  * <pre>@hide</pre> javadoc tag.
33  *
34  * <p>Note that, in order for this to work, metalava has to be invoked with
35  * the flag {@code --hide-annotation android.annotation.Hide}.
36  * @hide
37  */
38 @Target({TYPE, FIELD, METHOD, CONSTRUCTOR, ANNOTATION_TYPE, PACKAGE})
39 @Retention(RetentionPolicy.CLASS)
40 public @interface Hide {
41 }
42