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