net.milkbowl.vault.item

Class Items

java.lang.Object

net.milkbowl.vault.item.Items

public class Items
extends Object

Constructor Summary

Constructors

Constructor and Description
Items()

Method Summary

Modifier and Type	Method and Description
static List<ItemInfo>	getItemList() Returns the list of ItemInfo's registered in Vault as an UnmodifiableList.
static ItemInfo	itemById(int typeId) Deprecated.
static ItemInfo	itemById(int typeId, short subType) Deprecated.
static ItemInfo	itemByItem(ItemInfo item)
static ItemInfo	itemByName(ArrayList<String> search)
static ItemInfo	itemByName(String searchString) Single item search function, for when we only ever want to return 1 result
static ItemInfo[]	itemByNames(ArrayList<String> search, boolean multi)
static ItemInfo	itemByStack(org.bukkit.inventory.ItemStack itemStack) Searchs for an ItemInfo from the given ItemStack
static ItemInfo	itemByString(String string) Search for an item from a given string, useful for user input.
static ItemInfo	itemByType(org.bukkit.Material type) Gets a relevant ItemInfo by it's Material
static ItemInfo	itemByType(org.bukkit.Material type, short subType) Searches for an ItemInfo record by Material and SubTypeID
static ItemInfo[]	itemsByName(String searchString, boolean multi) Multi-Item return search for dumping all items with the search string to the player
static String	join(List<String> list, String glue) Joins elements of a String array with the glue between them into a String.
static String	join(String[] array, String glue) Joins elements of a String array with the glue between them into a String.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Items

public Items()

Method Detail

getItemList

public static List<ItemInfo> getItemList()

Returns the list of ItemInfo's registered in Vault as an UnmodifiableList.

Returns:

list of Items

itemById

@Deprecated
public static ItemInfo itemById(int typeId)

Deprecated.

itemById

@Deprecated
public static ItemInfo itemById(int typeId,
                                            short subType)

Deprecated.

itemByStack

public static ItemInfo itemByStack(org.bukkit.inventory.ItemStack itemStack)

Searchs for an ItemInfo from the given ItemStack

Parameters:

itemStack - to search on

Returns:

ItemInfo found, or null

itemByItem

public static ItemInfo itemByItem(ItemInfo item)

itemByType

public static ItemInfo itemByType(org.bukkit.Material type)

Gets a relevant ItemInfo by it's Material

Parameters:

type - of Material

Returns:

ItemInfo record found or null if none

itemByType

public static ItemInfo itemByType(org.bukkit.Material type,
                                  short subType)

Searches for an ItemInfo record by Material and SubTypeID

Parameters:

type - of Material

subType - to check for

Returns:

ItemInfo record found or null if none

itemByString

public static ItemInfo itemByString(String string)

Search for an item from a given string, useful for user input. Uses 3 different types of reg-exp searching. Checks first for an ItemID. Checks second for ItemID:SubType Last, it will run a by-name item search assuming the string is the name of an item.

Parameters:

string - to parse

Returns:

ItemInfo found or null

itemByName

public static ItemInfo itemByName(ArrayList<String> search)

itemByNames

public static ItemInfo[] itemByNames(ArrayList<String> search,
                                     boolean multi)

itemsByName

public static ItemInfo[] itemsByName(String searchString,
                                     boolean multi)

Multi-Item return search for dumping all items with the search string to the player

Parameters:

searchString - to search for

multi - whether to return a list of items or just the first

Returns:

Array of items found

itemByName

public static ItemInfo itemByName(String searchString)

Single item search function, for when we only ever want to return 1 result

Parameters:

searchString - to search for

Returns:

ItemInfo Object

join

public static String join(String[] array,
                          String glue)

Joins elements of a String array with the glue between them into a String.

Parameters:

array - of elements to join together

glue - what to put between each element

Returns:

Concacted Array combined with glue

join

public static String join(List<String> list,
                          String glue)

Joins elements of a String array with the glue between them into a String.

Parameters:

list - of items to join together

glue - what to put between each element

Returns:

Concacted Array combined with glue