Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce an annotation to mark a feature as tech preview #356

Merged
merged 1 commit into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

/**
* Annotation that specifies that an element is experimental and may change without notice.
*
* @see TechPreview
*/
@Inherited
@Documented
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
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.
* <p>
* 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}.
* <p>
* 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();
}