• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2017 Google Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //      http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 //
15 ////////////////////////////////////////////////////////////////////////////////
16 
17 package com.google.crypto.tink.annotations;
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  * Signifies that a public API (public class, method or field) is subject to incompatible changes,
27  * or even removal, in a future release.
28  *
29  * <p>An API bearing this annotation is exempt from any compatibility guarantees made by Tink.
30  *
31  * <p>The presence of this annotation might also indicate that the quality or performance of
32  * the API in question not ready for production.
33  *
34  * <p>It is <b>unsafe</b> to depend on alpha APIs.
35  *
36  */
37 @Retention(RetentionPolicy.CLASS)
38 @Target({
39   ElementType.ANNOTATION_TYPE,
40   ElementType.CONSTRUCTOR,
41   ElementType.FIELD,
42   ElementType.METHOD,
43   ElementType.TYPE
44 })
45 @Documented
46 public @interface Alpha {}
47