Package io.grpc
Annotation Type ExperimentalApi
-
@Retention(CLASS) @Target({ANNOTATION_TYPE,CONSTRUCTOR,FIELD,METHOD,PACKAGE,TYPE}) @Documented public @interface ExperimentalApi
Indicates a public API that can change at any time, and has no guarantee of API stability and backward-compatibility. If users want stabilization or signature change of a specific API that is currently annotated@ExperimentalApi
, please comment on its tracking issue on github with rationale, usecase, and so forth, so that the gRPC team may prioritize the process toward stabilization of the API.Usage guidelines:
- This annotation is used only on public API. Internal interfaces should not use it.
- After gRPC has gained API stability, this annotation can only be added to new API. Adding it to an existing API is considered API-breaking.
- Removing this annotation from an API gives it stable status.
Note: This annotation is intended only for gRPC library code. Users should not attach this annotation to their own code.
See: grpc-java-api-checker, an Error Prone plugin to automatically check for usages of this API.
-
-
Element Detail
-
value
String value
Context information such as links to discussion thread, tracking issue etc.
-
-