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