notice: be aware when changing this interface

nats-io · Sep 8, 2023 · ca22c0d · ca22c0d
1 parent df89f50
commit ca22c0d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/main/java/io/nats/client/Message.java b/src/main/java/io/nats/client/Message.java
@@ -28,6 +28,12 @@
  *
  * <p>The byte[] returned by {@link #getData() getData()} is not shared with any library code
  * and is safe to manipulate.
+ *
+ * NOTICE: This interface is intended only to be implemented internally,
+ * although since it is public it is technically available to anyone and
+ * breaking changes should be avoided. For instance:
+ * - Signatures should not be changed.
+ * - If methods are added, a default implementation should be provided.
  */
 public interface Message {