Hide NBTFile/NBTContainer fully behind NBT. Update tests to new forma…

…t. Add missing addCompound(ReadableNBT comp) to ReadWriteNBTCompoundList
tr7zw · Oct 22, 2024 · 3de6ed8 · 3de6ed8
1 parent e5bdce7
commit 3de6ed8
Show file tree

Hide file tree

Showing 16 changed files with 212 additions and 103 deletions.
diff --git a/item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/NBT.java b/item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/NBT.java
@@ -1,5 +1,8 @@
 package de.tr7zw.changeme.nbtapi;
 
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
 import java.util.function.Consumer;
 import java.util.function.Function;
 import java.util.logging.Level;
@@ -12,6 +15,7 @@
 
 import com.mojang.authlib.GameProfile;
 
+import de.tr7zw.changeme.nbtapi.iface.NBTFileHandle;
 import de.tr7zw.changeme.nbtapi.iface.ReadWriteItemNBT;
 import de.tr7zw.changeme.nbtapi.iface.ReadWriteNBT;
 import de.tr7zw.changeme.nbtapi.iface.ReadableItemNBT;
@@ -200,9 +204,9 @@ public static <T> T getPersistentData(Entity entity, Function<ReadableNBT, T> ge
     }
 
     /**
-     * It takes a block entity and a function that takes a ReadableNBT and returns
-     * a generic type T, and returns the result of the function, applied to the
-     * block entities persistent data container
+     * It takes a block entity and a function that takes a ReadableNBT and returns a
+     * generic type T, and returns the result of the function, applied to the block
+     * entities persistent data container
      * 
      * @param blockState The block state of the block you want to get the data from.
      * @param getter     A function that takes a ReadableNBT and returns a value of
@@ -269,7 +273,7 @@ public static <T> T modify(Entity entity, Function<ReadWriteNBT, T> function) {
         nbtEnt.setClosed();
         return ret;
     }
-    
+
     /**
      * It takes an ItemStack and a Consumer&lt;ReadWriteNBT&gt;, and then applies
      * the Consumer to the ItemStacks Components as NBT. This is for 1.20.5+ only.
@@ -279,15 +283,15 @@ public static <T> T modify(Entity entity, Function<ReadWriteNBT, T> function) {
      * @param consumer The consumer that will be used to modify the components.
      */
     public static void modifyComponents(ItemStack item, Consumer<ReadWriteNBT> consumer) {
-        if(!MinecraftVersion.isAtLeastVersion(MinecraftVersion.MC1_20_R4)) {
+        if (!MinecraftVersion.isAtLeastVersion(MinecraftVersion.MC1_20_R4)) {
             throw new NbtApiException("This method only works for 1.20.5+!");
         }
         ReadWriteNBT nbti = NBT.itemStackToNBT(item);
         consumer.accept(nbti.getOrCreateCompound("components"));
         ItemStack tmp = NBT.itemStackFromNBT(nbti);
         item.setItemMeta(tmp.getItemMeta());
     }
-    
+
     /**
      * It takes an ItemStack and a Consumer&lt;ReadWriteNBT&gt;, and then applies
      * the Consumer to the ItemStacks Components as NBT. This is for 1.20.5+ only.
@@ -298,7 +302,7 @@ public static void modifyComponents(ItemStack item, Consumer<ReadWriteNBT> consu
      * @return The return type is the same as the return type of the function.
      */
     public static <T> T modifyComponents(ItemStack item, Function<ReadWriteNBT, T> function) {
-        if(!MinecraftVersion.isAtLeastVersion(MinecraftVersion.MC1_20_R4)) {
+        if (!MinecraftVersion.isAtLeastVersion(MinecraftVersion.MC1_20_R4)) {
             throw new NbtApiException("This method only works for 1.20.5+!");
         }
         ReadWriteNBT nbti = NBT.itemStackToNBT(item);
@@ -307,7 +311,7 @@ public static <T> T modifyComponents(ItemStack item, Function<ReadWriteNBT, T> f
         item.setItemMeta(tmp.getItemMeta());
         return ret;
     }
-    
+
     /**
      * It takes an ItemStack and a Consumer&lt;ReadWriteNBT&gt;, and then applies
      * the Consumer to the ItemStacks Components as NBT. This is for 1.20.5+ only.
@@ -317,13 +321,13 @@ public static <T> T modifyComponents(ItemStack item, Function<ReadWriteNBT, T> f
      * @param consumer The consumer that will be used to read the components.
      */
     public static void getComponents(ItemStack item, Consumer<ReadableNBT> consumer) {
-        if(!MinecraftVersion.isAtLeastVersion(MinecraftVersion.MC1_20_R4)) {
+        if (!MinecraftVersion.isAtLeastVersion(MinecraftVersion.MC1_20_R4)) {
             throw new NbtApiException("This method only works for 1.20.5+!");
         }
         ReadWriteNBT nbti = NBT.itemStackToNBT(item);
         consumer.accept(nbti.getOrCreateCompound("components"));
     }
-    
+
     /**
      * It takes an ItemStack and a Consumer&lt;ReadWriteNBT&gt;, and then applies
      * the Consumer to the ItemStacks Components as NBT. This is for 1.20.5+ only.
@@ -334,7 +338,7 @@ public static void getComponents(ItemStack item, Consumer<ReadableNBT> consumer)
      * @return The return type is the same as the return type of the function.
      */
     public static <T> T getComponents(ItemStack item, Function<ReadableNBT, T> function) {
-        if(!MinecraftVersion.isAtLeastVersion(MinecraftVersion.MC1_20_R4)) {
+        if (!MinecraftVersion.isAtLeastVersion(MinecraftVersion.MC1_20_R4)) {
             throw new NbtApiException("This method only works for 1.20.5+!");
         }
         ReadWriteNBT nbti = NBT.itemStackToNBT(item);
@@ -525,12 +529,70 @@ public static ReadWriteNBT createNBTObject() {
      * It takes a nbt json string, and returns a ReadWriteNBT object
      * 
      * @param nbtString The NBT string to parse.
-     * @return A new NBTContainer object.
+     * @return A new ReadWriteNBT object.
      */
     public static ReadWriteNBT parseNBT(String nbtString) {
         return new NBTContainer(nbtString);
     }
 
+    /**
+     * Reads in an NBT stream and returns a ReadWriteNBT object
+     * 
+     * @param stream The NBT stream to read.
+     * @return A new ReadWriteNBT object.
+     */
+    public static ReadWriteNBT readNBT(InputStream stream) {
+        return new NBTContainer(stream);
+    }
+
+    /**
+     * Helper method for other developers using NMS. Allows to wrap any
+     * net.minecraft.nbt.CompoundTag to a NBTAPI ReadWriteNBT object.
+     * 
+     * @param nmsNbtTag Needs to be a valid net.minecraft.nbt.CompoundTag
+     * @return A new ReadWriteNBT object.
+     */
+    public static ReadWriteNBT wrapNMSTag(Object nmsNbtTag) {
+        return new NBTContainer(nmsNbtTag);
+    }
+
+    /**
+     * Creates a NBTFileHandle that uses @param file to store its data. If this file
+     * exists, the data will be loaded, otherwise a new file gets created.
+     * 
+     * @param file
+     * @throws IOException
+     */
+    public static NBTFileHandle getFileHandle(File file) throws IOException {
+        return new NBTFile(file);
+    }
+
+    /**
+     * Reads NBT data from the provided file.
+     * <p>
+     * Returns an empty tag if the file does not exist.
+     *
+     * @param file file to read
+     * @return ReadWriteNBT of the files data
+     * @throws IOException exception
+     */
+    public static ReadWriteNBT readFile(File file) throws IOException {
+        return NBTFile.readFrom(file);
+    }
+
+    /**
+     * Saves NBT data to the provided file.
+     * <p>
+     * Will fully override the file if it already exists.
+     *
+     * @param file file
+     * @param nbt  NBT data
+     * @throws IOException exception
+     */
+    public static void writeFile(File file, ReadWriteNBT nbt) throws IOException {
+        NBTFile.saveTo(file, (NBTCompound) nbt);
+    }
+
     /**
      * Create a read only proxy class for NBT, given an annotated interface.
      * 

diff --git a/item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/NBTCompoundList.java b/item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/NBTCompoundList.java
@@ -2,6 +2,7 @@
 
 import de.tr7zw.changeme.nbtapi.iface.ReadWriteNBT;
 import de.tr7zw.changeme.nbtapi.iface.ReadWriteNBTCompoundList;
+import de.tr7zw.changeme.nbtapi.iface.ReadableNBT;
 import de.tr7zw.changeme.nbtapi.utils.MinecraftVersion;
 import de.tr7zw.changeme.nbtapi.utils.nmsmappings.ClassWrapper;
 import de.tr7zw.changeme.nbtapi.utils.nmsmappings.ReflectionMethod;
@@ -56,7 +57,8 @@ public NBTCompound addCompound(NBTCompound comp) {
         }
     }
 
-    public NBTCompound addCompound(ReadWriteNBT comp) {
+    @Override
+    public ReadWriteNBT addCompound(ReadableNBT comp) {
         if (comp instanceof NBTCompound) {
             return addCompound((NBTCompound) comp);
         }

diff --git a/item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/NBTContainer.java b/item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/NBTContainer.java
@@ -22,6 +22,7 @@ public class NBTContainer extends NBTCompound {
     /**
      * Creates an empty, standalone NBTCompound
      */
+    @Deprecated
     public NBTContainer() {
         super(null, null);
         nbt = ObjectCreator.NMS_NBTTAGCOMPOUND.getInstance();
@@ -31,7 +32,9 @@ public NBTContainer() {
      * Takes in any NMS Compound to wrap it
      * 
      * @param nbt
+     * @deprecated Use NBT.wrapNMSTag
      */
+    @Deprecated
     public NBTContainer(Object nbt) {
         super(null, null);
         if (nbt == null) {
@@ -47,7 +50,9 @@ public NBTContainer(Object nbt) {
      * Reads in a NBT InputStream
      * 
      * @param inputsteam
+     * @deprecated Use NBT.readNBT
      */
+    @Deprecated
     public NBTContainer(InputStream inputsteam) {
         super(null, null);
         this.nbt = NBTReflectionUtil.readNBT(inputsteam);
@@ -58,7 +63,9 @@ public NBTContainer(InputStream inputsteam) {
      * {@link NbtApiException} in case something goes wrong.
      * 
      * @param nbtString
+     * @deprecated Use NBT.parseNBT
      */
+    @Deprecated
     public NBTContainer(String nbtString) {
         super(null, null);
         if (nbtString == null) {

diff --git a/item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/NBTFile.java b/item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/NBTFile.java
@@ -4,6 +4,7 @@
 import java.io.IOException;
 import java.nio.file.Files;
 
+import de.tr7zw.changeme.nbtapi.iface.NBTFileHandle;
 import de.tr7zw.changeme.nbtapi.utils.nmsmappings.ObjectCreator;
 
 /**
@@ -12,7 +13,7 @@
  * @author tr7zw
  *
  */
-public class NBTFile extends NBTCompound {
+public class NBTFile extends NBTCompound implements NBTFileHandle {
 
     private final File file;
     private Object nbt;
@@ -23,7 +24,9 @@ public class NBTFile extends NBTCompound {
      * 
      * @param file
      * @throws IOException
+     * @deprecated Use NBT.getFileHandle(file)
      */
+    @Deprecated
     public NBTFile(File file) throws IOException {
         super(null, null);
         if (file == null) {
@@ -43,6 +46,7 @@ public NBTFile(File file) throws IOException {
      * 
      * @throws IOException
      */
+    @Override
     public void save() throws IOException {
         try {
             getWriteLock().lock();
@@ -55,6 +59,7 @@ public void save() throws IOException {
     /**
      * @return The File used to store the data
      */
+    @Override
     public File getFile() {
         return file;
     }
@@ -77,7 +82,9 @@ protected void setCompound(Object compound) {
      * @param file file to read
      * @return NBTCompound holding file's nbt data
      * @throws IOException exception
+     * @deprecated Use NBT.readFile(file)
      */
+    @Deprecated
     public static NBTCompound readFrom(File file) throws IOException {
         if (!file.exists())
             return new NBTContainer();
@@ -92,7 +99,9 @@ public static NBTCompound readFrom(File file) throws IOException {
      * @param file file
      * @param nbt  NBT data
      * @throws IOException exception
+     * @deprecated Use NBT.writeFile(file, nbt)
      */
+    @Deprecated
     public static void saveTo(File file, NBTCompound nbt) throws IOException {
         if (!file.exists()) {
             file.getParentFile().mkdirs();

diff --git a/item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/iface/NBTFileHandle.java b/item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/iface/NBTFileHandle.java
@@ -0,0 +1,20 @@
+package de.tr7zw.changeme.nbtapi.iface;
+
+import java.io.File;
+import java.io.IOException;
+
+public interface NBTFileHandle extends ReadWriteNBT {
+
+    /**
+     * Saves the data to the file
+     * 
+     * @throws IOException
+     */
+    void save() throws IOException;
+
+    /**
+     * @return The File used to store the data
+     */
+    File getFile();
+
+}
diff --git a/item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/iface/ReadWriteNBTCompoundList.java b/item-nbt-api/src/main/java/de/tr7zw/changeme/nbtapi/iface/ReadWriteNBTCompoundList.java
@@ -10,6 +10,15 @@ public interface ReadWriteNBTCompoundList extends ReadableNBTList<ReadWriteNBT>
      * @return A new instance of the class.
      */
     ReadWriteNBT addCompound();
+
+    /**
+     * Adds a copy of the Compound to the end of the List and returns it. When null
+     * is given, a new Compound will be created
+     * 
+     * @param comp
+     * @return
+     */
+    ReadWriteNBT addCompound(ReadableNBT comp);
 
     /**
      * Removes the element at the specified position in this list

diff --git a/item-nbt-plugin/src/main/java/de/tr7zw/nbtapi/plugin/tests/GameprofileTest.java b/item-nbt-plugin/src/main/java/de/tr7zw/nbtapi/plugin/tests/GameprofileTest.java
@@ -4,19 +4,19 @@
 
 import com.mojang.authlib.GameProfile;
 
-import de.tr7zw.changeme.nbtapi.NBTCompound;
-import de.tr7zw.changeme.nbtapi.NBTGameProfile;
+import de.tr7zw.changeme.nbtapi.NBT;
 import de.tr7zw.changeme.nbtapi.NbtApiException;
+import de.tr7zw.changeme.nbtapi.iface.ReadWriteNBT;
 
 public class GameprofileTest implements Test {
 
     @Override
     public void test() throws Exception {
         UUID uuid = UUID.randomUUID();
         GameProfile profile = new GameProfile(uuid, "random");
-        NBTCompound nbt = NBTGameProfile.toNBT(profile);
+        ReadWriteNBT nbt = NBT.gameProfileToNBT(profile);
         profile = null;
-        profile = NBTGameProfile.fromNBT(nbt);
+        profile = NBT.gameProfileFromNBT(nbt);
         if (profile == null || !profile.getId().equals(uuid)) {
             throw new NbtApiException("Error when converting a GameProfile from/to NBT!");
         }