From eec9aca6913d5673c41ada6e207e0d9a0a598a63 Mon Sep 17 00:00:00 2001
From: Nassim Jahnke <nassim@njahnke.dev>
Date: Sat, 10 Feb 2024 20:43:36 +0100
Subject: [PATCH] 4.2.0: More helpers, deprecate primitive setValue methods In
 anticipation of value classes existing before I die of age, the primitive
 wrappers (and only those) will become immutable in the future.

---
 pom.xml                                       |  2 +-
 .../opennbt/tag/builtin/ByteTag.java          |  2 ++
 .../opennbt/tag/builtin/CompoundTag.java      | 21 +++++++++++++++++++
 .../opennbt/tag/builtin/DoubleTag.java        |  2 ++
 .../opennbt/tag/builtin/FloatTag.java         |  2 ++
 .../opennbt/tag/builtin/IntTag.java           |  2 ++
 .../opennbt/tag/builtin/LongTag.java          |  2 ++
 .../opennbt/tag/builtin/ShortTag.java         |  2 ++
 .../steveice10/opennbt/tag/builtin/Tag.java   |  2 ++
 9 files changed, 36 insertions(+), 1 deletion(-)

diff --git a/pom.xml b/pom.xml
index f52fb51..a5c83bf 100644
--- a/pom.xml
+++ b/pom.xml
@@ -5,7 +5,7 @@
 
     <groupId>com.viaversion</groupId>
     <artifactId>nbt</artifactId>
-    <version>4.1.0</version>
+    <version>4.2.0</version>
     <packaging>jar</packaging>
 
     <name>ViaNBT</name>
diff --git a/src/main/java/com/github/steveice10/opennbt/tag/builtin/ByteTag.java b/src/main/java/com/github/steveice10/opennbt/tag/builtin/ByteTag.java
index 306e75b..024acca 100644
--- a/src/main/java/com/github/steveice10/opennbt/tag/builtin/ByteTag.java
+++ b/src/main/java/com/github/steveice10/opennbt/tag/builtin/ByteTag.java
@@ -51,7 +51,9 @@ public class ByteTag extends NumberTag {
      * Sets the value of this tag.
      *
      * @param value New value of this tag.
+     * @deprecated number tags will be immutable in the future
      */
+    @Deprecated
     public void setValue(byte value) {
         this.value = value;
     }
diff --git a/src/main/java/com/github/steveice10/opennbt/tag/builtin/CompoundTag.java b/src/main/java/com/github/steveice10/opennbt/tag/builtin/CompoundTag.java
index d4ac747..dcc4db0 100644
--- a/src/main/java/com/github/steveice10/opennbt/tag/builtin/CompoundTag.java
+++ b/src/main/java/com/github/steveice10/opennbt/tag/builtin/CompoundTag.java
@@ -130,6 +130,8 @@ public class CompoundTag extends Tag implements Iterable<Entry<String, Tag>> {
 
     /**
      * Gets the tag.
+     * <p>
+     * <b>This will have its generic removed and instead return a raw tag in the future.</b>
      *
      * @param <T>     Type of tag to get.
      * @param tagName Name of the tag.
@@ -160,8 +162,25 @@ public class CompoundTag extends Tag implements Iterable<Entry<String, Tag>> {
         return tag instanceof NumberTag ? (NumberTag) tag : null;
     }
 
+    public @Nullable ByteArrayTag getByteArrayTag(String tagName) {
+        final Tag tag = this.value.get(tagName);
+        return tag instanceof ByteArrayTag ? (ByteArrayTag) tag : null;
+    }
+
+    public @Nullable IntArrayTag getIntArrayTag(String tagName) {
+        final Tag tag = this.value.get(tagName);
+        return tag instanceof IntArrayTag ? (IntArrayTag) tag : null;
+    }
+
+    public @Nullable LongArrayTag getLongArrayTag(String tagName) {
+        final Tag tag = this.value.get(tagName);
+        return tag instanceof LongArrayTag ? (LongArrayTag) tag : null;
+    }
+
     /**
      * Puts the tag into this compound tag.
+     * <p>
+     * <b>This will have its generic removed and instead return a raw tag in the future.</b>
      *
      * @param <T>     Type of tag to put.
      * @param tagName Name of the tag.
@@ -211,6 +230,8 @@ public class CompoundTag extends Tag implements Iterable<Entry<String, Tag>> {
 
     /**
      * Removes a tag from this compound tag.
+     * <p>
+     * <b>This will have its generic removed and instead return a raw tag in the future.</b>
      *
      * @param <T>     Type of tag to remove.
      * @param tagName Name of the tag to remove.
diff --git a/src/main/java/com/github/steveice10/opennbt/tag/builtin/DoubleTag.java b/src/main/java/com/github/steveice10/opennbt/tag/builtin/DoubleTag.java
index 5bc3b9e..17ab142 100644
--- a/src/main/java/com/github/steveice10/opennbt/tag/builtin/DoubleTag.java
+++ b/src/main/java/com/github/steveice10/opennbt/tag/builtin/DoubleTag.java
@@ -51,7 +51,9 @@ public class DoubleTag extends NumberTag {
      * Sets the value of this tag.
      *
      * @param value New value of this tag.
+     * @deprecated number tags will be immutable in the future
      */
+    @Deprecated
     public void setValue(double value) {
         this.value = value;
     }
diff --git a/src/main/java/com/github/steveice10/opennbt/tag/builtin/FloatTag.java b/src/main/java/com/github/steveice10/opennbt/tag/builtin/FloatTag.java
index 09443f8..41afba4 100644
--- a/src/main/java/com/github/steveice10/opennbt/tag/builtin/FloatTag.java
+++ b/src/main/java/com/github/steveice10/opennbt/tag/builtin/FloatTag.java
@@ -51,7 +51,9 @@ public class FloatTag extends NumberTag {
      * Sets the value of this tag.
      *
      * @param value New value of this tag.
+     * @deprecated number tags will be immutable in the future
      */
+    @Deprecated
     public void setValue(float value) {
         this.value = value;
     }
diff --git a/src/main/java/com/github/steveice10/opennbt/tag/builtin/IntTag.java b/src/main/java/com/github/steveice10/opennbt/tag/builtin/IntTag.java
index 6aa884c..ba1c1fa 100644
--- a/src/main/java/com/github/steveice10/opennbt/tag/builtin/IntTag.java
+++ b/src/main/java/com/github/steveice10/opennbt/tag/builtin/IntTag.java
@@ -51,7 +51,9 @@ public class IntTag extends NumberTag {
      * Sets the value of this tag.
      *
      * @param value New value of this tag.
+     * @deprecated number tags will be immutable in the future
      */
+    @Deprecated
     public void setValue(int value) {
         this.value = value;
     }
diff --git a/src/main/java/com/github/steveice10/opennbt/tag/builtin/LongTag.java b/src/main/java/com/github/steveice10/opennbt/tag/builtin/LongTag.java
index a51d9d5..bd5ee72 100644
--- a/src/main/java/com/github/steveice10/opennbt/tag/builtin/LongTag.java
+++ b/src/main/java/com/github/steveice10/opennbt/tag/builtin/LongTag.java
@@ -51,7 +51,9 @@ public class LongTag extends NumberTag {
      * Sets the value of this tag.
      *
      * @param value New value of this tag.
+     * @deprecated number tags will be immutable in the future
      */
+    @Deprecated
     public void setValue(long value) {
         this.value = value;
     }
diff --git a/src/main/java/com/github/steveice10/opennbt/tag/builtin/ShortTag.java b/src/main/java/com/github/steveice10/opennbt/tag/builtin/ShortTag.java
index e1234ef..09d4e14 100644
--- a/src/main/java/com/github/steveice10/opennbt/tag/builtin/ShortTag.java
+++ b/src/main/java/com/github/steveice10/opennbt/tag/builtin/ShortTag.java
@@ -51,7 +51,9 @@ public class ShortTag extends NumberTag {
      * Sets the value of this tag.
      *
      * @param value New value of this tag.
+     * @deprecated number tags will be immutable in the future
      */
+    @Deprecated
     public void setValue(short value) {
         this.value = value;
     }
diff --git a/src/main/java/com/github/steveice10/opennbt/tag/builtin/Tag.java b/src/main/java/com/github/steveice10/opennbt/tag/builtin/Tag.java
index 1d5ae4d..80c9ecb 100644
--- a/src/main/java/com/github/steveice10/opennbt/tag/builtin/Tag.java
+++ b/src/main/java/com/github/steveice10/opennbt/tag/builtin/Tag.java
@@ -28,6 +28,8 @@ public abstract class Tag {
 
     /**
      * Returns the unchecked value of this tag.
+     * <p>
+     * <b>The generic of this method might be removed in a later version</b>
      *
      * @param <T> expected type
      * @return unchecked value of this tag