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 * Annotates a program element (class, method, package, etc) which is internal to gRPC, not part of 27 * the public API, and should not be used by users of gRPC. 28 * 29 * <p>However, if you want to implement an alternative transport you may use the internal parts. 30 * Please consult the gRPC team first, because internal APIs don't have the same API stability 31 * guarantee as the public APIs do. 32 * 33 * <p>Note: This annotation is intended only for gRPC library code. Users should not attach this 34 * annotation to their own code. 35 * 36 * <p>See: <a href="https://github.com/grpc/grpc-java-api-checker">grpc-java-api-checker</a>, an 37 * Error Prone plugin to automatically check for usages of this API. 38 */ 39 @Retention(RetentionPolicy.CLASS) 40 @Target({ 41 ElementType.ANNOTATION_TYPE, 42 ElementType.CONSTRUCTOR, 43 ElementType.FIELD, 44 ElementType.METHOD, 45 ElementType.PACKAGE, 46 ElementType.TYPE}) 47 @Documented 48 public @interface Internal { 49 } 50