1 /* 2 * Copyright (C) 2023 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 package android.annotation; 17 18 import static java.lang.annotation.ElementType.CONSTRUCTOR; 19 import static java.lang.annotation.ElementType.FIELD; 20 import static java.lang.annotation.ElementType.METHOD; 21 import static java.lang.annotation.ElementType.PACKAGE; 22 import static java.lang.annotation.ElementType.TYPE; 23 import static java.lang.annotation.RetentionPolicy.CLASS; 24 25 import java.lang.annotation.Documented; 26 import java.lang.annotation.Retention; 27 import java.lang.annotation.Target; 28 29 /** 30 * Denotes that the annotated element should only be called on the given API level or higher. 31 * 32 * <p>This is similar in purpose to the older {@code @TargetApi} annotation, but more clearly 33 * expresses that this is a requirement on the caller, rather than being used to "suppress" warnings 34 * within the method that exceed the {@code minSdkVersion}. 35 * 36 * @hide 37 */ 38 @Documented 39 @Retention(CLASS) 40 @Target({TYPE, METHOD, CONSTRUCTOR, FIELD, PACKAGE}) 41 public @interface RequiresApi { 42 /** 43 * The API level to require. Alias for {@link #api} which allows you to leave out the {@code 44 * api=} part. 45 */ 46 @IntRange(from = 1) value()47 int value() default 1; 48 49 /** The API level to require */ 50 @IntRange(from = 1) api()51 int api() default 1; 52 } 53