• 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 is stable for callers to use, but has no guarantee of stability for
40  * extension. Consequently, the API should only be extended within the package containing the API.
41  *
42  * <p>For example:
43  *
44  * <ul>
45  *   <li>An interface marked with this annotation can have new methods added to it.
46  *   <li>A non-final class with this annotation can be marked final.
47  *   <li>A class with this annotation can have new abstract methods added.
48  *   <li>a non-final method with this annotation can be marked final.
49  * </ul>
50  *
51  * <p>The list above is just for illustration purposes and is not exhaustive.
52  *
53  * <p>Adding this annotation to an API is considered API-breaking.
54  */
55 @BetaApi
56 @Retention(RetentionPolicy.RUNTIME)
57 @Target({
58   ElementType.ANNOTATION_TYPE,
59   ElementType.CONSTRUCTOR,
60   ElementType.FIELD,
61   ElementType.METHOD,
62   ElementType.PACKAGE,
63   ElementType.TYPE
64 })
65 @Documented
66 public @interface InternalExtensionOnly {
67   /** Context information on why the interface/class is annotated with InternalExtensionOnly. */
value()68   String value() default "";
69 }
70