1 /*
2  * Copyright (C) 2024 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 // @exportToFramework:skipFile()
17 package androidx.appsearch.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 androidx.annotation.RestrictTo;
27 
28 import java.lang.annotation.Retention;
29 import java.lang.annotation.RetentionPolicy;
30 import java.lang.annotation.Target;
31 
32 /**
33  * Indicates an API is exposed for use by bundled system applications.
34  *
35  * <p>These APIs are not guaranteed to remain consistent release-to-release,
36  * and are not for use by apps linking against the Android SDK.
37  *
38  * <p>This annotation should only appear on API that is already marked @<pre>hide</pre>.
39  */
40 @Target({TYPE, FIELD, METHOD, CONSTRUCTOR, ANNOTATION_TYPE, PACKAGE})
41 @Retention(RetentionPolicy.RUNTIME)
42 @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
43 public @interface SystemApi {
44     enum Client {
45         /**
46          * Specifies that the intended clients of a SystemApi are privileged apps.
47          * This is the default value for {@link #client}.
48          */
49         PRIVILEGED_APPS,
50 
51         /**
52          * Specifies that the intended clients of a SystemApi are used by classes in
53          * <pre>BOOTCLASSPATH</pre> in mainline modules. Mainline modules can also expose
54          * this type of system APIs too when they're used only by the non-updatable
55          * platform code.
56          */
57         MODULE_LIBRARIES,
58 
59         /**
60          * Specifies that the system API is available only in the system server process.
61          * Use this to expose APIs from code loaded by the system server process <em>but</em>
62          * not in <pre>BOOTCLASSPATH</pre>.
63          */
64         SYSTEM_SERVER
65     }
66 
67     /**
68      * The intended client of this SystemAPI.
69      */
client()70     Client client() default Client.PRIVILEGED_APPS;
71 
72     /**
73      * Container for {@link SystemApi} that allows it to be applied repeatedly to types.
74      */
75     @Retention(RetentionPolicy.RUNTIME)
76     @Target(TYPE)
77     @interface Container {
value()78         SystemApi[] value();
79     }
80 }
81