1 /*
2  * Copyright (C) 2018 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 libcore.api;
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.TYPE;
24 
25 import java.lang.annotation.Retention;
26 import java.lang.annotation.RetentionPolicy;
27 import java.lang.annotation.Target;
28 
29 /**
30  * Indicates an API is part of a contract provided by the "core" set of
31  * libraries to select parts of the Android software stack.
32  *
33  * <p>This annotation should only appear on either (a) classes that are hidden by <pre>@hide</pre>
34  * javadoc tags or equivalent annotations, or (b) members of such classes. It is for use with
35  * metalava's {@code --show-single-annotation} option and so must be applied at the class level and
36  * applied again each member that is to be made part of the API. Members that are not part of the
37  * API do not have to be explicitly hidden.
38  *
39  * @hide
40  */
41 @IntraCoreApi
42 @Target({TYPE, FIELD, METHOD, CONSTRUCTOR, ANNOTATION_TYPE})
43 @Retention(RetentionPolicy.SOURCE)
44 public @interface CorePlatformApi {
45 }
46