Made the NBT part better

broken1arrow · broken1arrow · commit 81650e28451e · 2025-11-16T13:36:44.000+01:00
Also  improve the javadocs
diff --git a/Item Creator/src/main/java/org/broken/arrow/library/itemcreator/CreateItemStack.java b/Item Creator/src/main/java/org/broken/arrow/library/itemcreator/CreateItemStack.java
@@ -10,6 +10,7 @@
 import org.broken.arrow.library.itemcreator.utility.ConvertToItemStack;
 import org.broken.arrow.library.itemcreator.utility.Tuple;
 import org.broken.arrow.library.itemcreator.utility.builders.ItemBuilder;
+import org.broken.arrow.library.itemcreator.utility.nbt.NBTDataWriter;
 import org.broken.arrow.library.logging.Logging;
 import org.broken.arrow.library.logging.Validate;
 import org.broken.arrow.library.nbt.RegisterNbtAPI;
@@ -461,59 +462,89 @@ else if (enchant instanceof Enchantment)
     }
 
     /**
-     * Set custom nbt data on item.
+     * Sets a custom NBT application function to be used when applying NBT data.
+     * Compared to {@link #setItemMetaData(String, Object, boolean)} and
+     * {@link #setItemMetaData(String, Object)}, this gives you greater control over
+     * which metadata is applied and also allows removing keys.
      *
-     * @param itemMetaKey   key for get value.
-     * @param itemMetaValue value you want to set.
-     * @return this class.
+     * @param function a consumer that modifies the provided {@link NBTDataWriter}
+     * @return this instance
      */
-    public CreateItemStack setItemMetaData(final String itemMetaKey, final Object itemMetaValue) {
-        return setItemMetaData(itemMetaKey, itemMetaValue, false);
+    public CreateItemStack setItemNBT(Consumer<NBTDataWriter> function) {
+        createNBTWrapperIfMissing();
+        nbtDataWrapper.applyNBT(function);
+        return this;
     }
-
+    
     /**
-     * Set custom nbt data on item.
+     * Sets custom NBT data on the item.
      *
-     * @param itemMetaKey   key for get value.
-     * @param itemMetaValue value you want to set.
-     * @param keepClazz     true if it shall keep all data on the item or false to convert value to string.
-     * @return this class.
+     * <p><b>Note:</b> This method is less flexible and the naming is misleading, and it may be
+     * removed in the future. Prefer {@link #setItemNBT(java.util.function.Consumer)} when
+     * working with multiple values, custom logic, or when you need to remove keys.</p>
+     *
+     * @param itemMetaKey   the key used to retrieve the value
+     * @param itemMetaValue the value to set
+     * @return this instance
      */
-    public CreateItemStack setItemMetaData(final String itemMetaKey, final Object itemMetaValue, final boolean keepClazz) {
-        nbtDataWrapper = NBTDataWrapper.of(this.itemCreator).add(itemMetaKey, itemMetaValue, keepClazz);
-        return this;
+    public CreateItemStack setItemMetaData(final String itemMetaKey, final Object itemMetaValue) {
+        return setItemMetaData(itemMetaKey, itemMetaValue, false);
     }
 
     /**
-     * Set your metadata on the item. Use {@link NBTDataWrapper} class.
-     * To set key and value.
+     * Sets custom NBT data on the item.
      *
-     * @param wrapper values from MetaDataWrapper.
-     * @return this class.
+     * <p><b>Note:</b> This method is less flexible and the naming is misleading, and it may be
+     * removed in the future. Prefer {@link #setItemNBT(java.util.function.Consumer)} when
+     * working with multiple values, custom logic, or when you need to remove keys.</p>
+     *
+     * @param itemMetaKey   the key used to retrieve the value
+     * @param itemMetaValue the value to set
+     * @param keepClazz     {@code true} to keep the original value type, or {@code false} to convert
+     *                      the value to a string
+     * @return this instance
      */
-    public CreateItemStack setItemMetaDataList(final NBTDataWrapper wrapper) {
-        nbtDataWrapper = wrapper;
+    public CreateItemStack setItemMetaData(final String itemMetaKey, final Object itemMetaValue, final boolean keepClazz) {
+        createNBTWrapperIfMissing();
+        nbtDataWrapper.add(itemMetaKey, itemMetaValue, keepClazz);
         return this;
     }
 
     /**
      * Map list of metadata you want to set on a item.
-     * It use map key and value form the map.
+     * It uses map key and value form the map.
+     *
+     * <p><b>Note:</b> This method is less flexible and the naming is misleading, and it may be
+     * removed in the future. Prefer {@link #setItemNBT(java.util.function.Consumer)} when
+     * working with multiple values, custom logic, or when you need to remove keys.</p>
      *
      * @param itemMetaMap map of values.
      * @return this class.
      */
     public CreateItemStack setItemMetaDataList(final Map<String, Object> itemMetaMap) {
         if (itemMetaMap != null && !itemMetaMap.isEmpty()) {
-            final NBTDataWrapper wrapper = NBTDataWrapper.of(this.itemCreator);
+            createNBTWrapperIfMissing();
+            final NBTDataWrapper wrapper = this.nbtDataWrapper;
             for (final Map.Entry<String, Object> itemData : itemMetaMap.entrySet()) {
                 wrapper.add(itemData.getKey(), itemData.getValue());
             }
-            nbtDataWrapper = wrapper;
         }
         return this;
     }
 
+    /**
+     * Set your metadata on the item. Use {@link NBTDataWrapper} class.
+     * To set key and value.
+     *
+     * @param wrapper values from MetaDataWrapper.
+     * @return this class.
+     */
+    public CreateItemStack setItemMetaDataList(final NBTDataWrapper wrapper) {
+        nbtDataWrapper = wrapper;
+        return this;
+    }
+
+
     /**
      * if this item is unbreakable or not
      *
@@ -939,7 +970,7 @@ private ItemStack checkTypeOfItem(final Object object) {
         return getConvertItems().checkItem(object);
     }
 
-    private void addItemMeta(@Nonnull final ItemStack itemStack,@Nonnull final ItemMeta itemMeta) {
+    private void addItemMeta(@Nonnull final ItemStack itemStack, @Nonnull final ItemMeta itemMeta) {
         this.setDamageMeta(itemStack, itemMeta);
         if (this.serverVersion > 10.0F)
             setUnbreakableMeta(itemMeta);
@@ -949,7 +980,7 @@ private void addItemMeta(@Nonnull final ItemStack itemStack,@Nonnull final ItemM
             hideEnchantments(itemMeta);
     }
 
-    private void setDamageMeta(final ItemStack itemStack,final ItemMeta itemMeta) {
+    private void setDamageMeta(final ItemStack itemStack, final ItemMeta itemMeta) {
         short dmg = getDmg(itemMeta);
         if (dmg > 0) {
             if (serverVersion > 12.2F) {
@@ -1036,5 +1067,10 @@ private Map<String, Object> getNBTdataMap() {
         return new HashMap<>();
     }
 
+    private void createNBTWrapperIfMissing() {
+        if(nbtDataWrapper == null)
+            nbtDataWrapper = NBTDataWrapper.of(this.itemCreator);
+    }
+
 
 }
diff --git a/Item Creator/src/main/java/org/broken/arrow/library/itemcreator/NBTDataWrapper.java b/Item Creator/src/main/java/org/broken/arrow/library/itemcreator/NBTDataWrapper.java
@@ -2,6 +2,7 @@
 
 import com.google.common.reflect.TypeToken;
 import com.google.gson.Gson;
+import de.tr7zw.changeme.nbtapi.iface.ReadWriteNBT;
 import org.broken.arrow.library.itemcreator.utility.nbt.NBTDataWriter;
 import org.broken.arrow.library.itemcreator.utility.nbt.NBTValue;
 import org.broken.arrow.library.nbt.RegisterNbtAPI;
@@ -40,7 +41,6 @@ public final class NBTDataWrapper {
     private final float serverVersion;
     private final Plugin plugin;
     private final PersistentDataUtility persistentData;
-
     private Consumer<NBTDataWriter> consumer;
 
     /**
@@ -65,6 +65,18 @@ public static NBTDataWrapper of(@Nonnull final ItemCreator itemCreator) {
         return new NBTDataWrapper(itemCreator);
     }
 
+    /**
+     * Sets a custom NBT application function to be used when applying NBT data.
+     * Compared to {@link #add(String, Object, boolean)} and
+     * {@link #add(String, Object)}, this gives you greater control over
+     * which metadata is applied and also allows removing keys.
+     *
+     * @param function a consumer that modifies the provided {@link NBTDataWriter}
+     */
+    public void applyNBT(Consumer<NBTDataWriter> function) {
+        this.consumer = function;
+    }
+
     /**
      * Add metadata to your item. To get the metadata with method {@link #getMetaDataMap()}
      * This method will convert value to string always, use {@link #add(String, Object, boolean)}
@@ -100,15 +112,6 @@ public Map<String, Object> getMetaDataMap() {
         return itemMetaMap;
     }
 
-    /**
-     * Sets a custom NBT application function to be used when applying NBT data.
-     *
-     * @param function a consumer that modifies the provided {@link NBTDataWriter}
-     */
-    public void applyNBT(Consumer<NBTDataWriter> function) {
-        this.consumer = function;
-    }
-
     /**
      * Returns the current NBT application consumer.
      *
@@ -130,11 +133,9 @@ public ItemStack applyNBT(ItemStack itemStack) {
         final NBTDataWriter nbtData = new NBTDataWriter();
         apply(nbtData);
         final RegisterNbtAPI nbtApi = this.itemCreator.getNbtApi();
-        final Map<String, NBTValue> nbtCache = nbtData.getNbtCache();
-        final Map<String, Object> metaDataMap = this.getMetaDataMap();
 
         if (nbtApi != null) {
-            return applyNbtToItem(nbtApi,itemStack, nbtData);
+            return applyNbtToItem(nbtApi, itemStack, nbtData);
         } else {
             this.setPersistentData(itemStack, nbtData);
         }
@@ -256,13 +257,18 @@ private ItemStack applyNbtToItem(final RegisterNbtAPI nbtApi, final ItemStack it
                     if (nbtData.isClearNBT())
                         nbtDataWrite.clearNBT();
                     else {
+                        final ReadWriteNBT compound = nbtDataWrite.getCompound();
                         if (!metaDataMap.isEmpty())
                             metaDataMap.forEach((s, nbtValue) ->
-                                    ConvertObjectType.setNBTValue(nbtDataWrite.getCompound(), s, nbtValue)
+                                    ConvertObjectType.setNBTValue(compound, s, nbtValue)
                             );
                         else
                             nbtCache.forEach((key, nbtValue) -> {
-                                ConvertObjectType.setNBTValue(nbtDataWrite.getCompound(), key, nbtValue);
+                                if (nbtValue.isRemoveKey()) {
+                                    compound.removeKey(key);
+                                } else {
+                                    ConvertObjectType.setNBTValue(compound, key, nbtValue.getValue());
+                                }
                             });
                     }
                 });
