Package org.bukkit.inventory

Interface ItemFactory

public interface ItemFactory

An instance of the ItemFactory can be obtained with Server.getItemFactory().

The ItemFactory is solely responsible for creating item meta containers to apply on item stacks.

Method Summary

Modifier and Type	Method	Description
ItemMeta	asMetaFor(ItemMeta meta, ItemStack stack)	Returns an appropriate item meta for the specified stack.
ItemMeta	asMetaFor(ItemMeta meta, Material material)	Returns an appropriate item meta for the specified material.
ItemStack	ensureServerConversions(ItemStack item)	Minecart updates are converting simple item stacks into more complex NBT oriented Item Stacks.
boolean	equals(ItemMeta meta1, ItemMeta meta2)	This method is used to compare two item meta data objects.
Color	getDefaultLeatherColor()	Returns the default color for all leather armor.
String	getI18NDisplayName(ItemStack item)	Gets the Display name as seen in the Client.
ItemMeta	getItemMeta(Material material)	This creates a new item meta for the material.
boolean	isApplicable(ItemMeta meta, ItemStack stack)	This method checks the item meta to confirm that it is applicable (no data lost if applied) to the specified ItemStack.
boolean	isApplicable(ItemMeta meta, Material material)	This method checks the item meta to confirm that it is applicable (no data lost if applied) to the specified Material.
Material	updateMaterial(ItemMeta meta, Material material)	Deprecated. for internal use only

Method Detail

getItemMeta

ItemMeta getItemMeta(@NotNull
                     Material material)

This creates a new item meta for the material.

Parameters:

material - The material to consider as base for the meta

Returns:

a new ItemMeta that could be applied to an item stack of the specified material

isApplicable

boolean isApplicable(@Nullable
                     ItemMeta meta,
                     @Nullable
                     ItemStack stack)
              throws IllegalArgumentException

This method checks the item meta to confirm that it is applicable (no data lost if applied) to the specified ItemStack.

A SkullMeta would not be valid for a sword, but a normal ItemMeta from an enchanted dirt block would.

Parameters:

meta - Meta to check

stack - Item that meta will be applied to

Returns:

true if the meta can be applied without losing data, false otherwise

Throws:

IllegalArgumentException - if the meta was not created by this factory

isApplicable

boolean isApplicable(@Nullable
                     ItemMeta meta,
                     @Nullable
                     Material material)
              throws IllegalArgumentException

This method checks the item meta to confirm that it is applicable (no data lost if applied) to the specified Material.

A SkullMeta would not be valid for a sword, but a normal ItemMeta from an enchanted dirt block would.

Parameters:

meta - Meta to check

material - Material that meta will be applied to

Returns:

true if the meta can be applied without losing data, false otherwise

Throws:

IllegalArgumentException - if the meta was not created by this factory

equals

boolean equals(@Nullable
               ItemMeta meta1,
               @Nullable
               ItemMeta meta2)
        throws IllegalArgumentException

This method is used to compare two item meta data objects.

Parameters:

meta1 - First meta to compare, and may be null to indicate no data

meta2 - Second meta to compare, and may be null to indicate no data

Returns:

false if one of the meta has data the other does not, otherwise true

Throws:

IllegalArgumentException - if either meta was not created by this factory

asMetaFor

@Nullable
ItemMeta asMetaFor(@NotNull
                   ItemMeta meta,
                   @NotNull
                   ItemStack stack)
            throws IllegalArgumentException

Returns an appropriate item meta for the specified stack.

The item meta returned will always be a valid meta for a given ItemStack of the specified material. It may be a more or less specific meta, and could also be the same meta or meta type as the parameter. The item meta returned will also always be the most appropriate meta.

Example, if a SkullMeta is being applied to a book, this method would return a BookMeta containing all information in the specified meta that is applicable to an ItemMeta, the highest common interface.

Parameters:

meta - the meta to convert

stack - the stack to convert the meta for

Returns:

An appropriate item meta for the specified item stack. No guarantees are made as to if a copy is returned. This will be null for a stack of air.

Throws:

IllegalArgumentException - if the specified meta was not created by this factory

asMetaFor

@Nullable
ItemMeta asMetaFor(@NotNull
                   ItemMeta meta,
                   @NotNull
                   Material material)
            throws IllegalArgumentException

Returns an appropriate item meta for the specified material.

The item meta returned will always be a valid meta for a given ItemStack of the specified material. It may be a more or less specific meta, and could also be the same meta or meta type as the parameter. The item meta returned will also always be the most appropriate meta.

Example, if a SkullMeta is being applied to a book, this method would return a BookMeta containing all information in the specified meta that is applicable to an ItemMeta, the highest common interface.

Parameters:

meta - the meta to convert

material - the material to convert the meta for

Returns:

An appropriate item meta for the specified item material. No guarantees are made as to if a copy is returned. This will be null for air.

Throws:

IllegalArgumentException - if the specified meta was not created by this factory

getDefaultLeatherColor

@NotNull
Color getDefaultLeatherColor()

Returns the default color for all leather armor.

Returns:

the default color for leather armor

updateMaterial

@Deprecated
@NotNull
Material updateMaterial(@NotNull
                        ItemMeta meta,
                        @NotNull
                        Material material)
                 throws IllegalArgumentException

Deprecated.

for internal use only

Apply a material change for an item meta. Do not use under any circumstances.

Parameters:

meta - meta

material - material

Returns:

updated material

Throws:

IllegalArgumentException - exception

ensureServerConversions

@NotNull
ItemStack ensureServerConversions(@NotNull
                                  ItemStack item)

Minecart updates are converting simple item stacks into more complex NBT oriented Item Stacks. Use this method to to ensure any desired data conversions are processed. The input itemstack will not be the same as the returned itemstack.

Parameters:

item - The item to process conversions on

Returns:

A potentially Data Converted ItemStack

getI18NDisplayName

@Nullable
String getI18NDisplayName(@Nullable
                          ItemStack item)

Gets the Display name as seen in the Client. Currently the server only supports the English language. To override this, You must replace the language file embedded in the server jar.

Parameters:

item - Item to return Display name of

Returns:

Display name of Item