Beta.java revision 7dd252788645e940eada959bdde927426e2531c9
1/*
2 * Copyright (C) 2010 The Guava 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
17package com.google.common.annotations;
18
19import java.lang.annotation.Documented;
20import java.lang.annotation.ElementType;
21import java.lang.annotation.Retention;
22import java.lang.annotation.RetentionPolicy;
23import java.lang.annotation.Target;
24
25/**
26 * Signifies that a public API (public class, method or field) is subject to
27 * incompatible changes, or even removal, in a future release. An API bearing
28 * this annotation is exempt from any compatibility guarantees made by its
29 * containing library. Note that the presence of this annotation implies nothing
30 * about the quality or performance of the API in question, only the fact that
31 * it is not "API-frozen."
32 *
33 * <p>It is generally safe for <i>applications</i> to depend on beta APIs, at
34 * the cost of some extra work during upgrades. However it is generally
35 * inadvisable for <i>libraries</i> (which get included on users' CLASSPATHs,
36 * outside the library developers' control) to do so.
37 *
38 *
39 * @author Kevin Bourrillion
40 */
41@Retention(RetentionPolicy.CLASS)
42@Target({ ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.FIELD,
43    ElementType.METHOD, ElementType.TYPE })
44@Documented
45@GwtCompatible
46public @interface Beta {
47}
48