org.bukkit.craftbukkit.metadata.BlockMetadataStore Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of walk-server Show documentation
A spigot fork to kotlin structure and news.
There is a newer version: 2.4.0
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 implements MetadataStore {

  private final 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.
   *
   * @param block       the block
   * @param metadataKey The name identifying the metadata value
   * @return a unique metadata key
   * @see MetadataStoreBase#disambiguate(Object, String)
   */
  @Override
  protected String disambiguate(Block block, String metadataKey) {
    return block.getX() + ":" + block.getY() + ":" + 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 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, 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, 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());
    }
  }
}