Home | History | Annotate | Download | only in annotation
      1 /*
      2  * Copyright 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 androidx.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.CLASS;
     23 
     24 import java.lang.annotation.Retention;
     25 import java.lang.annotation.Target;
     26 
     27 /** Stub only annotation. Do not use directly. */
     28 @Retention(CLASS)
     29 @Target({TYPE, FIELD, METHOD, CONSTRUCTOR})
     30 public @interface RequiresFeature {
     31     /** The name of the feature that is required. */
     32     String name();
     33 
     34     /**
     35      * Defines the name of the method that should be called to check whether the feature is
     36      * available, using the same signature format as javadoc. The feature checking method can have
     37      * multiple parameters, but the feature name parameter must be of type String and must also be
     38      * the first String-type parameter.
     39      */
     40     String enforcement();
     41 }
     42