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 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.TYPE; 22 import static java.lang.annotation.RetentionPolicy.SOURCE; 23 24 import java.lang.annotation.Retention; 25 import java.lang.annotation.Target; 26 27 /** 28 * Denotes that the annotated element requires one or more device features. This 29 * is used to auto-generate documentation. 30 * 31 * @hide 32 */ 33 @Retention(SOURCE) 34 @Target({TYPE,FIELD,METHOD,CONSTRUCTOR}) 35 public @interface RequiresFeature { 36 /** 37 * The name of the device feature that is required, if precisely one feature 38 * is required. If more than one feature is required, specify either 39 * {@link #allOf()} or {@link #anyOf()} instead. 40 * <p> 41 * If specified, {@link #anyOf()} and {@link #allOf()} must both be null. 42 */ value()43 String value() default ""; 44 45 /** 46 * Specifies a list of feature names that are all required. 47 * <p> 48 * If specified, {@link #anyOf()} and {@link #value()} must both be null. 49 */ allOf()50 String[] allOf() default {}; 51 52 /** 53 * Specifies a list of permission names where at least one is required 54 * <p> 55 * If specified, {@link #allOf()} and {@link #value()} must both be null. 56 */ anyOf()57 String[] anyOf() default {}; 58 59 /** 60 * Defines the name of the method that should be called to check whether the feature is 61 * available, using the same signature format as javadoc. The feature checking method can have 62 * multiple parameters, but the feature name parameter must be of type String and must also be 63 * the first String-type parameter. 64 * <p> 65 * By default, the enforcement is 66 * {@link android.content.pm.PackageManager#hasSystemFeature(String)}. 67 */ enforcement()68 String enforcement() default("android.content.pm.PackageManager#hasSystemFeature"); 69 } 70