Skip to content

Commit

Permalink
Introduce an annotation to mark a feature as tech preview
Browse files Browse the repository at this point in the history
Annotated elements are feature-complete, but have known limitations, need bake-time or have rough angles. The API is more stable than with @experimental. Tech preview API can still be changed, but changes will be communicated.
  • Loading branch information
cescoffier committed Oct 7, 2024
1 parent e6756ee commit 5a6f03c
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
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();
}

0 comments on commit 5a6f03c

Please sign in to comment.