SPIGOT-4347: Add API to allow storing arbitrary values on ItemStacks
By: Bjarne Koll <LynxPlay101@gmail.com>
This commit is contained in:
CraftBukkit/Spigot
@@ -0,0 +1,302 @@
|
||||
package org.bukkit.craftbukkit.inventory;
|
||||
|
||||
import java.io.StringReader;
|
||||
import java.lang.reflect.Array;
|
||||
import java.nio.ByteBuffer;
|
||||
import java.util.Arrays;
|
||||
import java.util.Map;
|
||||
import java.util.UUID;
|
||||
import net.minecraft.server.NBTBase;
|
||||
import net.minecraft.server.NBTTagCompound;
|
||||
import net.minecraft.server.NBTTagIntArray;
|
||||
import net.minecraft.server.NBTTagList;
|
||||
import org.bukkit.Bukkit;
|
||||
import org.bukkit.Material;
|
||||
import org.bukkit.NamespacedKey;
|
||||
import org.bukkit.configuration.file.YamlConfiguration;
|
||||
import org.bukkit.craftbukkit.inventory.tags.CraftCustomItemTagContainer;
|
||||
import org.bukkit.inventory.ItemStack;
|
||||
import org.bukkit.inventory.meta.ItemMeta;
|
||||
import org.bukkit.inventory.meta.tags.CustomItemTagContainer;
|
||||
import org.bukkit.inventory.meta.tags.ItemTagAdapterContext;
|
||||
import org.bukkit.inventory.meta.tags.ItemTagType;
|
||||
import org.bukkit.support.AbstractTestingBase;
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertFalse;
|
||||
import static org.junit.Assert.assertNotEquals;
|
||||
import static org.junit.Assert.assertTrue;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
|
||||
public class ItemMetaCustomValueTest extends AbstractTestingBase {
|
||||
|
||||
private static NamespacedKey VALID_KEY;
|
||||
|
||||
@Before
|
||||
public void setup() {
|
||||
VALID_KEY = new NamespacedKey("test", "validkey");
|
||||
}
|
||||
|
||||
/*
|
||||
Sets a test
|
||||
*/
|
||||
@Test(expected = IllegalArgumentException.class)
|
||||
public void testSetNoAdapter() {
|
||||
ItemMeta itemMeta = createNewItemMeta();
|
||||
itemMeta.getCustomTagContainer().setCustomTag(VALID_KEY, new PrimitiveTagType<>(boolean.class), true);
|
||||
}
|
||||
|
||||
/*
|
||||
Contains a tag
|
||||
*/
|
||||
@Test(expected = IllegalArgumentException.class)
|
||||
public void testHasNoAdapter() {
|
||||
ItemMeta itemMeta = createNewItemMeta();
|
||||
itemMeta.getCustomTagContainer().setCustomTag(VALID_KEY, ItemTagType.INTEGER, 1); // We gotta set this so we at least try to compare it
|
||||
itemMeta.getCustomTagContainer().hasCustomTag(VALID_KEY, new PrimitiveTagType<>(boolean.class));
|
||||
}
|
||||
|
||||
/*
|
||||
Getting a tag
|
||||
*/
|
||||
@Test(expected = IllegalArgumentException.class)
|
||||
public void testGetNoAdapter() {
|
||||
ItemMeta itemMeta = createNewItemMeta();
|
||||
itemMeta.getCustomTagContainer().setCustomTag(VALID_KEY, ItemTagType.INTEGER, 1); //We gotta set this so we at least try to compare it
|
||||
itemMeta.getCustomTagContainer().getCustomTag(VALID_KEY, new PrimitiveTagType<>(boolean.class));
|
||||
}
|
||||
|
||||
@Test(expected = IllegalArgumentException.class)
|
||||
public void testGetWrongType() {
|
||||
ItemMeta itemMeta = createNewItemMeta();
|
||||
itemMeta.getCustomTagContainer().setCustomTag(VALID_KEY, ItemTagType.INTEGER, 1);
|
||||
itemMeta.getCustomTagContainer().getCustomTag(VALID_KEY, ItemTagType.STRING);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testDifferentNamespace() {
|
||||
NamespacedKey namespacedKeyA = new NamespacedKey("plugin-a", "damage");
|
||||
NamespacedKey namespacedKeyB = new NamespacedKey("plugin-b", "damage");
|
||||
|
||||
ItemMeta meta = createNewItemMeta();
|
||||
meta.getCustomTagContainer().setCustomTag(namespacedKeyA, ItemTagType.LONG, 15L);
|
||||
meta.getCustomTagContainer().setCustomTag(namespacedKeyB, ItemTagType.LONG, 160L);
|
||||
|
||||
assertEquals(15L, (long) meta.getCustomTagContainer().getCustomTag(namespacedKeyA, ItemTagType.LONG));
|
||||
assertEquals(160L, (long) meta.getCustomTagContainer().getCustomTag(namespacedKeyB, ItemTagType.LONG));
|
||||
}
|
||||
|
||||
private ItemMeta createNewItemMeta() {
|
||||
return Bukkit.getItemFactory().getItemMeta(Material.DIAMOND_PICKAXE);
|
||||
}
|
||||
|
||||
private NamespacedKey requestKey(String keyName) {
|
||||
return new NamespacedKey("test-plugin", keyName.toLowerCase());
|
||||
}
|
||||
|
||||
/*
|
||||
Removing a tag
|
||||
*/
|
||||
@Test
|
||||
public void testNBTTagStoring() {
|
||||
CraftMetaItem itemMeta = createComplexItemMeta();
|
||||
|
||||
NBTTagCompound compound = new NBTTagCompound();
|
||||
itemMeta.applyToItem(compound);
|
||||
|
||||
assertEquals(itemMeta, new CraftMetaItem(compound));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testMapStoring() {
|
||||
CraftMetaItem itemMeta = createComplexItemMeta();
|
||||
|
||||
Map<String, Object> serialize = itemMeta.serialize();
|
||||
assertEquals(itemMeta, new CraftMetaItem(serialize));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testYAMLStoring() {
|
||||
ItemStack stack = new ItemStack(Material.DIAMOND);
|
||||
CraftMetaItem meta = createComplexItemMeta();
|
||||
stack.setItemMeta(meta);
|
||||
|
||||
YamlConfiguration configuration = new YamlConfiguration();
|
||||
configuration.set("testpath", stack);
|
||||
|
||||
String configValue = configuration.saveToString();
|
||||
YamlConfiguration loadedConfig = YamlConfiguration.loadConfiguration(new StringReader(configValue));
|
||||
|
||||
assertEquals(stack, loadedConfig.getSerializable("testpath", ItemStack.class));
|
||||
assertNotEquals(new ItemStack(Material.DIAMOND), loadedConfig.getSerializable("testpath", ItemStack.class));
|
||||
}
|
||||
|
||||
private CraftMetaItem createComplexItemMeta() {
|
||||
CraftMetaItem itemMeta = (CraftMetaItem) createNewItemMeta();
|
||||
itemMeta.setDisplayName("Item Display Name");
|
||||
|
||||
itemMeta.getCustomTagContainer().setCustomTag(requestKey("custom-long"), ItemTagType.LONG, 4L); //Add random primitive values
|
||||
itemMeta.getCustomTagContainer().setCustomTag(requestKey("custom-byte-array"), ItemTagType.BYTE_ARRAY, new byte[]{
|
||||
0, 1, 2, 10
|
||||
});
|
||||
itemMeta.getCustomTagContainer().setCustomTag(requestKey("custom-string"), ItemTagType.STRING, "Hello there world");
|
||||
|
||||
CustomItemTagContainer innerContainer = itemMeta.getCustomTagContainer().getAdapterContext().newTagContainer(); //Add a inner container
|
||||
innerContainer.setCustomTag(VALID_KEY, ItemTagType.LONG, 5L);
|
||||
itemMeta.getCustomTagContainer().setCustomTag(requestKey("custom-inner-compound"), ItemTagType.TAG_CONTAINER, innerContainer);
|
||||
|
||||
Map<String, NBTBase> rawMap = ((CraftCustomItemTagContainer) itemMeta.getCustomTagContainer()).getRaw(); //Adds a tag list as well (even tho is has no API yet)
|
||||
NBTTagList nbtList = new NBTTagList();
|
||||
nbtList.add(new NBTTagIntArray(Arrays.asList(1, 5, 3)));
|
||||
nbtList.add(new NBTTagIntArray(Arrays.asList(42, 51)));
|
||||
rawMap.put("nbttaglist", nbtList);
|
||||
return itemMeta;
|
||||
}
|
||||
|
||||
/*
|
||||
Test complex object storage
|
||||
*/
|
||||
@Test
|
||||
public void storeUUIDOnItemTest() {
|
||||
ItemMeta itemMeta = createNewItemMeta();
|
||||
UUIDItemTagType uuidItemTagType = new UUIDItemTagType();
|
||||
UUID uuid = UUID.fromString("434eea72-22a6-4c61-b5ef-945874a5c478");
|
||||
|
||||
itemMeta.getCustomTagContainer().setCustomTag(VALID_KEY, uuidItemTagType, uuid);
|
||||
assertTrue(itemMeta.getCustomTagContainer().hasCustomTag(VALID_KEY, uuidItemTagType));
|
||||
assertEquals(uuid, itemMeta.getCustomTagContainer().getCustomTag(VALID_KEY, uuidItemTagType));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void encapsulatedContainers() {
|
||||
NamespacedKey innerKey = new NamespacedKey("plugin-a", "inner");
|
||||
|
||||
ItemMeta meta = createNewItemMeta();
|
||||
ItemTagAdapterContext context = meta.getCustomTagContainer().getAdapterContext();
|
||||
|
||||
CustomItemTagContainer thirdContainer = context.newTagContainer();
|
||||
thirdContainer.setCustomTag(VALID_KEY, ItemTagType.LONG, 3L);
|
||||
|
||||
CustomItemTagContainer secondContainer = context.newTagContainer();
|
||||
secondContainer.setCustomTag(VALID_KEY, ItemTagType.LONG, 2L);
|
||||
secondContainer.setCustomTag(innerKey, ItemTagType.TAG_CONTAINER, thirdContainer);
|
||||
|
||||
meta.getCustomTagContainer().setCustomTag(VALID_KEY, ItemTagType.LONG, 1L);
|
||||
meta.getCustomTagContainer().setCustomTag(innerKey, ItemTagType.TAG_CONTAINER, secondContainer);
|
||||
|
||||
assertEquals(3L, meta.getCustomTagContainer()
|
||||
.getCustomTag(innerKey, ItemTagType.TAG_CONTAINER)
|
||||
.getCustomTag(innerKey, ItemTagType.TAG_CONTAINER)
|
||||
.getCustomTag(VALID_KEY, ItemTagType.LONG).longValue());
|
||||
|
||||
assertEquals(2L, meta.getCustomTagContainer()
|
||||
.getCustomTag(innerKey, ItemTagType.TAG_CONTAINER)
|
||||
.getCustomTag(VALID_KEY, ItemTagType.LONG).longValue());
|
||||
|
||||
assertEquals(1L, meta.getCustomTagContainer()
|
||||
.getCustomTag(VALID_KEY, ItemTagType.LONG).longValue());
|
||||
}
|
||||
|
||||
class UUIDItemTagType implements ItemTagType<byte[], UUID> {
|
||||
|
||||
@Override
|
||||
public Class<byte[]> getPrimitiveType() {
|
||||
return byte[].class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<UUID> getComplexType() {
|
||||
return UUID.class;
|
||||
}
|
||||
|
||||
@Override
|
||||
public byte[] toPrimitive(UUID complex, ItemTagAdapterContext context) {
|
||||
ByteBuffer bb = ByteBuffer.wrap(new byte[16]);
|
||||
bb.putLong(complex.getMostSignificantBits());
|
||||
bb.putLong(complex.getLeastSignificantBits());
|
||||
return bb.array();
|
||||
}
|
||||
|
||||
@Override
|
||||
public UUID fromPrimitive(byte[] primitive, ItemTagAdapterContext context) {
|
||||
ByteBuffer bb = ByteBuffer.wrap(primitive);
|
||||
long firstLong = bb.getLong();
|
||||
long secondLong = bb.getLong();
|
||||
return new UUID(firstLong, secondLong);
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testPrimitiveCustomTags() {
|
||||
ItemMeta itemMeta = createNewItemMeta();
|
||||
|
||||
testPrimitiveCustomTag(itemMeta, ItemTagType.BYTE, (byte) 1);
|
||||
testPrimitiveCustomTag(itemMeta, ItemTagType.SHORT, (short) 1);
|
||||
testPrimitiveCustomTag(itemMeta, ItemTagType.INTEGER, 1);
|
||||
testPrimitiveCustomTag(itemMeta, ItemTagType.LONG, 1L);
|
||||
testPrimitiveCustomTag(itemMeta, ItemTagType.FLOAT, 1.34F);
|
||||
testPrimitiveCustomTag(itemMeta, ItemTagType.DOUBLE, 151.123);
|
||||
|
||||
testPrimitiveCustomTag(itemMeta, ItemTagType.STRING, "test");
|
||||
|
||||
testPrimitiveCustomTag(itemMeta, ItemTagType.BYTE_ARRAY, new byte[]{
|
||||
1, 4, 2, Byte.MAX_VALUE
|
||||
});
|
||||
testPrimitiveCustomTag(itemMeta, ItemTagType.INTEGER_ARRAY, new int[]{
|
||||
1, 4, 2, Integer.MAX_VALUE
|
||||
});
|
||||
testPrimitiveCustomTag(itemMeta, ItemTagType.LONG_ARRAY, new long[]{
|
||||
1L, 4L, 2L, Long.MAX_VALUE
|
||||
});
|
||||
}
|
||||
|
||||
private <T, Z> void testPrimitiveCustomTag(ItemMeta meta, ItemTagType<T, Z> type, Z value) {
|
||||
NamespacedKey tagKey = new NamespacedKey("test", String.valueOf(type.hashCode()));
|
||||
|
||||
meta.getCustomTagContainer().setCustomTag(tagKey, type, value);
|
||||
assertTrue(meta.getCustomTagContainer().hasCustomTag(tagKey, type));
|
||||
|
||||
Z foundValue = meta.getCustomTagContainer().getCustomTag(tagKey, type);
|
||||
if (foundValue.getClass().isArray()) { // Compare arrays using reflection access
|
||||
int length = Array.getLength(foundValue);
|
||||
int originalLength = Array.getLength(value);
|
||||
for (int i = 0; i < length && i < originalLength; i++) {
|
||||
assertEquals(Array.get(value, i), Array.get(foundValue, i));
|
||||
}
|
||||
} else {
|
||||
assertEquals(foundValue, value);
|
||||
}
|
||||
|
||||
meta.getCustomTagContainer().removeCustomTag(tagKey);
|
||||
assertFalse(meta.getCustomTagContainer().hasCustomTag(tagKey, type));
|
||||
}
|
||||
|
||||
class PrimitiveTagType<T> implements ItemTagType<T, T> {
|
||||
|
||||
private final Class<T> primitiveType;
|
||||
|
||||
PrimitiveTagType(Class<T> primitiveType) {
|
||||
this.primitiveType = primitiveType;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<T> getPrimitiveType() {
|
||||
return primitiveType;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Class<T> getComplexType() {
|
||||
return primitiveType;
|
||||
}
|
||||
|
||||
@Override
|
||||
public T toPrimitive(T complex, ItemTagAdapterContext context) {
|
||||
return complex;
|
||||
}
|
||||
|
||||
@Override
|
||||
public T fromPrimitive(T primitive, ItemTagAdapterContext context) {
|
||||
return primitive;
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user