de.otto.edison.annotations.Beta Maven / Gradle / Ivy

Go to download
package de.otto.edison.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.CLASS;

/**
 * Signifies that a public API (public class, method or field) is subject to incompatible changes,
 * or even removal, in a future release. An API bearing this annotation is exempt from any
 * compatibility guarantees made by its containing library.
 *
 * Note that the presence of this annotation implies nothing about the quality or performance of
 * the API in question, only the fact that it is not "API-frozen."
 *
 * It is generally safe for applications to depend on beta APIs, at the cost of some extra work
 * during upgrades. However it is generally inadvisable for libraries (which get included on
 * users' CLASSPATHs, outside the library developers' control) to do so.
 *
 * @author Guido Steinacker on
 * @since 1.0.0
 */
@Retention(value= CLASS)
@Target(value={ANNOTATION_TYPE, CONSTRUCTOR, FIELD, METHOD, TYPE})
@Documented
public @interface Beta {

}