1 /* 2 * Copyright 2015 The gRPC Authors 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 17 package io.grpc; 18 19 import java.lang.annotation.Documented; 20 import java.lang.annotation.ElementType; 21 import java.lang.annotation.Retention; 22 import java.lang.annotation.RetentionPolicy; 23 import java.lang.annotation.Target; 24 25 /** 26 * Indicates a public API that can change at any time, and has no guarantee of API stability and 27 * backward-compatibility. 28 * 29 * <p>Usage guidelines: 30 * <ol> 31 * <li>This annotation is used only on public API. Internal interfaces should not use it.</li> 32 * <li>After gRPC has gained API stability, this annotation can only be added to new API. Adding it 33 * to an existing API is considered API-breaking.</li> 34 * <li>Removing this annotation from an API gives it stable status.</li> 35 * </ol> 36 * 37 * <p>Note: This annotation is intended only for gRPC library code. Users should not attach this 38 * annotation to their own code. 39 * 40 * <p>See: <a href="https://github.com/grpc/grpc-java-api-checker">grpc-java-api-checker</a>, an 41 * Error Prone plugin to automatically check for usages of this API. 42 */ 43 @Retention(RetentionPolicy.CLASS) 44 @Target({ 45 ElementType.ANNOTATION_TYPE, 46 ElementType.CONSTRUCTOR, 47 ElementType.FIELD, 48 ElementType.METHOD, 49 ElementType.PACKAGE, 50 ElementType.TYPE}) 51 @Documented 52 public @interface ExperimentalApi { 53 /** 54 * Context information such as links to discussion thread, tracking issue etc. 55 */ value()56 String value(); 57 } 58