Home | History | Annotate | Download | only in conscrypt
      1 /*
      2  * Copyright (C) 2017 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 org.conscrypt;
     17 
     18 import java.lang.annotation.Documented;
     19 import java.lang.annotation.ElementType;
     20 import java.lang.annotation.Retention;
     21 import java.lang.annotation.RetentionPolicy;
     22 import java.lang.annotation.Target;
     23 
     24 /**
     25  * Indicates a public API that can change at any time, and has no guarantee of API stability and
     26  * backward-compatibility.
     27  *
     28  * <p>Usage guidelines:
     29  * <ol>
     30  * <li>This annotation is used only on public API. Internal interfaces should not use it.</li>
     31  * <li>This annotation should only be added to new APIs. Adding it to an existing API is
     32  * considered API-breaking.</li>
     33  * <li>Removing this annotation from an API gives it stable status.</li>
     34  * </ol>
     35  */
     36 @Internal
     37 @Retention(RetentionPolicy.SOURCE)
     38 @Target({
     39         ElementType.ANNOTATION_TYPE,
     40         ElementType.CONSTRUCTOR,
     41         ElementType.FIELD,
     42         ElementType.METHOD,
     43         ElementType.PACKAGE,
     44         ElementType.TYPE})
     45 @Documented
     46 public @interface ExperimentalApi {
     47     /**
     48      * Context information such as links to discussion thread, tracking issue etc.
     49      */
     50     String value() default "";
     51 }
     52