[Bleeding] Implement Metadata framework for Entities, Blocks, and Worlds

By: rmichela <deltahat@gmail.com>

paper-server/src/main/java/org/bukkit/craftbukkit/metadata/BlockMetadataStore.java

@@ -0,0 +1,94 @@
+package org.bukkit.craftbukkit.metadata;
+
+import org.bukkit.World;
+import org.bukkit.block.Block;
+import org.bukkit.metadata.MetadataStore;
+import org.bukkit.metadata.MetadataStoreBase;
+import org.bukkit.metadata.MetadataValue;
+import org.bukkit.plugin.Plugin;
+
+import java.util.List;
+
+/**
+ * A BlockMetadataStore stores metadata values for {@link Block} objects.
+ */
+public class BlockMetadataStore extends MetadataStoreBase<Block> implements MetadataStore<Block> {
+
+    private World owningWorld;
+
+    /**
+     * Initializes a BlockMetadataStore.
+     * @param owningWorld The world to which this BlockMetadataStore belongs.
+     */
+    public BlockMetadataStore(World owningWorld) {
+        this.owningWorld = owningWorld;
+    }
+
+    /**
+     * Generates a unique metadata key for a {@link Block} object based on its coordinates in the world.
+     * @see MetadataStoreBase#disambiguate(Object, String)
+     * @param block the block
+     * @param metadataKey The name identifying the metadata value
+     * @return a unique metadata key
+     */
+    @Override
+    protected String disambiguate(Block block, String metadataKey) {
+        return Integer.toString(block.getX()) + ":" + Integer.toString(block.getY()) + ":"  + Integer.toString(block.getZ()) + ":"  + metadataKey;
+    }
+
+    /**
+     * Retrieves the metadata for a {@link Block}, ensuring the block being asked for actually belongs to this BlockMetadataStore's
+     * owning world.
+     * @see MetadataStoreBase#getMetadata(Object, String)
+     */
+    @Override
+    public List<MetadataValue> getMetadata(Block block, String metadataKey) {
+        if(block.getWorld() == owningWorld) {
+            return super.getMetadata(block, metadataKey);
+        } else {
+            throw new IllegalArgumentException("Block does not belong to world " + owningWorld.getName());
+        }
+    }
+
+    /**
+     * Tests to see if a metadata value has been added to a {@link Block}, ensuring the block being interrogated belongs
+     * to this BlockMetadataStore's owning world.
+     * @see MetadataStoreBase#hasMetadata(Object, String)
+     */
+    @Override
+    public boolean hasMetadata(Block block, String metadataKey) {
+        if(block.getWorld() == owningWorld) {
+            return super.hasMetadata(block, metadataKey);
+        } else {
+            throw new IllegalArgumentException("Block does not belong to world " + owningWorld.getName());
+        }
+    }
+
+    /**
+     * Removes metadata from from a {@link Block} belonging to a given {@link Plugin}, ensuring the block being deleted from belongs
+     * to this BlockMetadataStore's owning world.
+     * @see MetadataStoreBase#removeMetadata(Object, String, org.bukkit.plugin.Plugin)
+     */
+    @Override
+    public void removeMetadata(Block block, String metadataKey, Plugin owningPlugin) {
+        if(block.getWorld() == owningWorld) {
+            super.removeMetadata(block, metadataKey, owningPlugin);
+        } else {
+            throw new IllegalArgumentException("Block does not belong to world " + owningWorld.getName());
+        }
+    }
+
+    /**
+     * Sets or overwrites a metadata value on a {@link Block} from a given {@link Plugin}, ensuring the target block belongs
+     * to this BlockMetadataStore's owning world.
+     * @see MetadataStoreBase#setMetadata(Object, String, org.bukkit.metadata.MetadataValue)
+     */
+    @Override
+    public void setMetadata(Block block, String metadataKey, MetadataValue newMetadataValue) {
+        if(block.getWorld() == owningWorld) {
+            super.setMetadata(block, metadataKey, newMetadataValue);
+        } else {
+            throw new IllegalArgumentException("Block does not belong to world " + owningWorld.getName());
+        }
+    }
+}

paper-server/src/main/java/org/bukkit/craftbukkit/metadata/EntityMetadataStore.java

@@ -0,0 +1,22 @@
+package org.bukkit.craftbukkit.metadata;
+
+import org.bukkit.entity.Entity;
+import org.bukkit.metadata.MetadataStore;
+import org.bukkit.metadata.MetadataStoreBase;
+
+/**
+ * An EntityMetadataStore stores metadata values for all {@link Entity} classes an their descendants.
+ */
+public class EntityMetadataStore extends MetadataStoreBase<Entity> implements MetadataStore<Entity> {
+    /**
+     * Generates a unique metadata key for an {@link Entity} entity ID.
+     * @see MetadataStoreBase#disambiguate(Object, String)
+     * @param entity the entity
+     * @param metadataKey The name identifying the metadata value
+     * @return a unique metadata key
+     */
+    @Override
+    protected String disambiguate(Entity entity, String metadataKey) {
+        return Integer.toString(entity.getEntityId()) + ":" + metadataKey;
+    }
+}

paper-server/src/main/java/org/bukkit/craftbukkit/metadata/PlayerMetadataStore.java

@@ -0,0 +1,23 @@
+package org.bukkit.craftbukkit.metadata;
+
+import org.bukkit.OfflinePlayer;
+import org.bukkit.metadata.MetadataStore;
+import org.bukkit.metadata.MetadataStoreBase;
+
+/**
+ * A PlayerMetadataStore stores metadata for {@link org.bukkit.entity.Player} and {@link OfflinePlayer} objects.
+ */
+public class PlayerMetadataStore extends MetadataStoreBase<OfflinePlayer> implements MetadataStore<OfflinePlayer> {
+    /**
+     * Generates a unique metadata key for {@link org.bukkit.entity.Player} and {@link OfflinePlayer} using the player
+     * name.
+     * @see MetadataStoreBase#disambiguate(Object, String)
+     * @param player the player
+     * @param metadataKey The name identifying the metadata value
+     * @return a unique metadata key
+     */
+    @Override
+    protected String disambiguate(OfflinePlayer player, String metadataKey) {
+        return player.getName().toLowerCase() + ":" + metadataKey;
+    }
+}

paper-server/src/main/java/org/bukkit/craftbukkit/metadata/WorldMetadataStore.java

@@ -0,0 +1,22 @@
+package org.bukkit.craftbukkit.metadata;
+
+import org.bukkit.World;
+import org.bukkit.metadata.MetadataStore;
+import org.bukkit.metadata.MetadataStoreBase;
+
+/**
+ * An WorldMetadataStore stores metadata values for {@link World} objects.
+ */
+public class WorldMetadataStore extends MetadataStoreBase<World> implements MetadataStore<World> {
+    /**
+     * Generates a unique metadata key for a {@link World} object based on the world UID.
+     * @see WorldMetadataStore#disambiguate(Object, String)
+     * @param world the world
+     * @param metadataKey The name identifying the metadata value
+     * @return a unique metadata key
+     */
+    @Override
+    protected String disambiguate(World world, String metadataKey) {
+        return world.getUID().toString() + ":" + metadataKey;
+    }
+}