• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2017, Google Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 package com.google.api.core;
31 
32 import java.lang.annotation.Documented;
33 import java.lang.annotation.ElementType;
34 import java.lang.annotation.Retention;
35 import java.lang.annotation.RetentionPolicy;
36 import java.lang.annotation.Target;
37 
38 /**
39  * Indicates a public API that can change at any time, and has no guarantee of API stability and
40  * backward-compatibility.
41  *
42  * <p>Usage guidelines:
43  *
44  * <ol>
45  *   <li>This annotation is used only on APIs with public visibility. Internal interfaces should not
46  *       use it.
47  *   <li>This annotation should only be added to new APIs. Adding it to an existing API is
48  *       considered API-breaking.
49  *   <li>Removing this annotation from an API gives it stable status, assuming the API doesn't have
50  *       other annotations denoting instability (such as {@link InternalApi} or {@link
51  *       InternalExtensionOnly}).
52  * </ol>
53  */
54 @BetaApi
55 @Retention(RetentionPolicy.RUNTIME)
56 @Target({
57   ElementType.ANNOTATION_TYPE,
58   ElementType.CONSTRUCTOR,
59   ElementType.FIELD,
60   ElementType.METHOD,
61   ElementType.PACKAGE,
62   ElementType.TYPE
63 })
64 @Documented
65 public @interface BetaApi {
66   /** Context information such as links to a discussion thread, tracking issue, etc. */
value()67   String value() default "";
68 }
69