clarify contract for mutable pairs

GTNewHorizons · Jan 7, 2025 · 95ba69c · 95ba69c
1 parent 65ec57c
commit 95ba69c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/src/main/java/com/gtnewhorizon/gtnhlib/util/data/BlockMeta.java b/src/main/java/com/gtnewhorizon/gtnhlib/util/data/BlockMeta.java
@@ -6,7 +6,8 @@
 
 /**
  * A mutable implementation of {@link ImmutableBlockMeta}. Must follow the same contracts as the immutable version. If
- * your API should return a mutable pair, return this instead.
+ * your API should return a mutable pair, return this instead. If this type is exposed instead of the immutable
+ * interface, assume that the contained values can change.
  */
 public class BlockMeta implements ImmutableBlockMeta {
 

diff --git a/src/main/java/com/gtnewhorizon/gtnhlib/util/data/ItemMeta.java b/src/main/java/com/gtnewhorizon/gtnhlib/util/data/ItemMeta.java
@@ -6,7 +6,8 @@
 
 /**
  * A mutable implementation of {@link ImmutableItemMeta}. Must follow the same contracts as the immutable version. If
- * your API should return a mutable pair, return this instead.
+ * your API should return a mutable pair, return this instead. If this type is exposed instead of the immutable
+ * interface, assume that the contained values can change.
  */
 public class ItemMeta implements ImmutableItemMeta {