com.mongodb.annotations.Alpha Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2008-present MongoDB, Inc.
 * Copyright 2010 The Guava Authors
 * Copyright 2011 The Guava Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.mongodb.annotations;

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

/**
 * Signifies that a public API element is in the early stages of development, subject to
 * incompatible changes, or even removal, in a future release and may lack some intended features.
 * An API bearing this annotation may contain known issues affecting functionality, performance,
 * and stability. It is also exempt from any compatibility guarantees made by its containing library.
 *
 * It is inadvisable for applications to use Alpha APIs in production environments or
 * for libraries (which get included on users' CLASSPATHs, outside the library developers'
 * control) to depend on these APIs. Alpha APIs are intended for experimental purposes only.
 */
@Retention(RetentionPolicy.CLASS)
@Target({
        ElementType.ANNOTATION_TYPE,
        ElementType.CONSTRUCTOR,
        ElementType.FIELD,
        ElementType.METHOD,
        ElementType.PACKAGE,
        ElementType.TYPE })
@Documented
@Beta(Reason.CLIENT)
public @interface Alpha {
    /**
     * @return The reason an API element is marked with {@link Alpha}.
     */
    Reason[] value();
}