-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce an annotation to mark a feature as tech preview
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
1 parent
e6756ee
commit 5a6f03c
Showing
2 changed files
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
annotation/src/main/java/io/smallrye/common/annotation/TechPreview.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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(); | ||
} |