io.smallrye.common.annotation.TechPreview Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smallrye-common-annotation Show documentation

The newest version!

package io.smallrye.common.annotation;

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

/**
 * Annotation that specifies that an element is tech preview and may change in the future.
 * 
 * Annotated elements are feature-complete, but have known limitations, need bake-time or
 * have rough angles. The API is more stable than with {@link Experimental}.
 * 
 * Tech preview API can still be changed, but changes will be communicated.
 *
 * @see Experimental
 */
@Inherited
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.TYPE, ElementType.FIELD, ElementType.PACKAGE })
public @interface TechPreview {
    /**
     * Describes why the annotated element is in tech preview.
     *
     * @return the tech preview description.
     */
    String value();
}