Skip to content

Commit 42bf81f

Browse files
committed
Add comments for Optional annotation
1 parent 4563284 commit 42bf81f

File tree

1 file changed

+10
-1
lines changed
  • openmessaging-api/src/main/java/io/openmessaging/annotation

1 file changed

+10
-1
lines changed

openmessaging-api/src/main/java/io/openmessaging/annotation/Optional.java

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,17 @@
2121
import java.lang.annotation.Retention;
2222
import java.lang.annotation.RetentionPolicy;
2323
import java.lang.annotation.Target;
24+
2425
/**
25-
* A {@code MessageReceipt} is a {@code Message} with a {@code Receipt}.
26+
* <p>
27+
* A {@code Optional} is an annotation to mark some certain methods ,interfaces and etc. this annotation represented
28+
* these methods or interfaces are not mandatory in OpenMessaging.
29+
* </p>
30+
*
31+
* <p>
32+
* If these methods or interfaces adopted by more and more vendors and end users, they may be become the mandatory
33+
* interface in the future. Of course, if they are used very little, they may be removed.
34+
* </p>
2635
*
2736
* @version OMS 1.0.0
2837
* @since OMS 1.0.0

0 commit comments

Comments
 (0)