org.bukkit.inventory.meta.ItemMeta Maven / Gradle / Ivy
package org.bukkit.inventory.meta;
import org.bukkit.configuration.serialization.ConfigurationSerializable;
import org.bukkit.enchantments.Enchantment;
import org.bukkit.inventory.ItemFlag;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* This type represents the storage mechanism for auxiliary item data.
*
* An implementation will handle the creation and application for ItemMeta.
* This class should not be implemented by a plugin in a live environment.
*/
public interface ItemMeta extends Cloneable, ConfigurationSerializable {
/**
* Checks for existence of a display name.
*
* @return true if this has a display name
*/
boolean hasDisplayName();
/**
* Gets the display name that is set.
*
* Plugins should check that hasDisplayName() returns true
* before calling this method.
*
* @return the display name that is set
*/
String getDisplayName();
/**
* Sets the display name.
*
* @param name the name to set
*/
void setDisplayName(String name);
/**
* Checks for existence of lore.
*
* @return true if this has lore
*/
boolean hasLore();
/**
* Gets the lore that is set.
*
* Plugins should check if hasLore() returns true before
* calling this method.
*
* @return a list of lore that is set
*/
List getLore();
/**
* Sets the lore for this item.
* Removes lore when given null.
*
* @param lore the lore that will be set
*/
void setLore(List lore);
/**
* Checks for the existence of any enchantments.
*
* @return true if an enchantment exists on this meta
*/
boolean hasEnchants();
/**
* Checks for existence of the specified enchantment.
*
* @param ench enchantment to check
* @return true if this enchantment exists for this meta
*/
boolean hasEnchant(Enchantment ench);
/**
* Checks for the level of the specified enchantment.
*
* @param ench enchantment to check
* @return The level that the specified enchantment has, or 0 if none
*/
int getEnchantLevel(Enchantment ench);
/**
* Returns a copy the enchantments in this ItemMeta.
* Returns an empty map if none.
*
* @return An immutable copy of the enchantments
*/
Map getEnchants();
/**
* Adds the specified enchantment to this item meta.
*
* @param ench Enchantment to add
* @param level Level for the enchantment
* @param ignoreLevelRestriction this indicates the enchantment should be
* applied, ignoring the level limit
* @return true if the item meta changed as a result of this call, false
* otherwise
*/
boolean addEnchant(Enchantment ench, int level, boolean ignoreLevelRestriction);
/**
* Removes the specified enchantment from this item meta.
*
* @param ench Enchantment to remove
* @return true if the item meta changed as a result of this call, false
* otherwise
*/
boolean removeEnchant(Enchantment ench);
/**
* Checks if the specified enchantment conflicts with any enchantments in
* this ItemMeta.
*
* @param ench enchantment to test
* @return true if the enchantment conflicts, false otherwise
*/
boolean hasConflictingEnchant(Enchantment ench);
/**
* Set itemflags which should be ignored when rendering a ItemStack in the Client. This Method does silently ignore double set itemFlags.
*
* @param itemFlags The hideflags which shouldn't be rendered
*/
void addItemFlags(ItemFlag... itemFlags);
/**
* Remove specific set of itemFlags. This tells the Client it should render it again. This Method does silently ignore double removed itemFlags.
*
* @param itemFlags Hideflags which should be removed
*/
void removeItemFlags(ItemFlag... itemFlags);
/**
* Get current set itemFlags. The collection returned is unmodifiable.
*
* @return A set of all itemFlags set
*/
Set getItemFlags();
/**
* Check if the specified flag is present on this item.
*
* @param flag the flag to check
* @return if it is present
*/
boolean hasItemFlag(ItemFlag flag);
@SuppressWarnings("javadoc")
ItemMeta clone();
Spigot spigot();
// Spigot start
class Spigot {
/**
* Return if the unbreakable tag is true
*
* @return true if the unbreakable tag is true
*/
public boolean isUnbreakable() {
throw new UnsupportedOperationException("Not supported yet.");
}
/**
* Sets the unbreakable tag
*
* @param unbreakable true if set unbreakable
*/
public void setUnbreakable(boolean unbreakable) {
throw new UnsupportedOperationException("Not supported yet.");
}
}
// Spigot end
}