eu.wauz.wauzcore.items.util

Class ItemUtils

java.lang.Object

eu.wauz.wauzcore.items.util.ItemUtils

public class ItemUtils
extends java.lang.Object

An util class for reading and writing item stack properties.

Author:

Wauzmons

See Also:

EquipmentUtils, FoodUtils, PetEggUtils

Constructor Summary

Constructors

Constructor and Description
ItemUtils()

Method Summary

Modifier and Type	Method and Description
static int	countSpecificStackableItems(org.bukkit.inventory.Inventory inventory, org.bukkit.inventory.ItemStack itemStack) Counts the total amount of the given item stack inside an inventory.
static boolean	doesLoreContain(org.bukkit.inventory.ItemStack itemStack, java.lang.String content) Checks if the lore of the item stack contains the given string.
static boolean	fitsInInventory(org.bukkit.inventory.Inventory inventory, org.bukkit.inventory.ItemStack itemStack) Checks if enough space is left in an inventory, to fit in the given item stack.
private static int	getAmountOfStacks(int maxStackSize, int itemAmount) Counts how many stacks are needed to fit the given amount of items.
static int	getArrowCount(org.bukkit.inventory.ItemStack itemStack) Gets the amount of arrows from an item stack, based on lore.
static java.lang.String	getDisplayName(org.bukkit.inventory.ItemStack itemStack) Gets the display name of the given item stack.
static java.lang.String	getInstanceMapType(org.bukkit.inventory.ItemStack itemStack) Gets the map type of an item stack, based on lore.
static int	getIntegerBetweenFromLore(org.bukkit.inventory.ItemStack itemStack, java.lang.String before, java.lang.String after) Finds an int between two strings somewhere inside an item's lore.
static int	getIntegerFromLore(org.bukkit.inventory.ItemStack itemStack, java.lang.String content, int index) Gets an integer from an item stack's lore, based on line content and word index.
static int	getIntegerSumBetweenFromLore(org.bukkit.inventory.ItemStack itemStack, java.lang.String before, java.lang.String after) Finds the sum of all integers between all occurances of two strings somewhere inside an item's lore.
static long	getLongFromLore(org.bukkit.inventory.ItemStack itemStack, java.lang.String content, int index) Gets a long from an item stack's lore, based on line content and word index.
static int	getSellValue(org.bukkit.inventory.ItemStack itemStack) Gets the sell value of an item stack, based on lore.
static java.lang.String	getStringBetweenFromLore(org.bukkit.inventory.ItemStack itemStack, java.lang.String before, java.lang.String after) Finds a string between two other strings somewhere inside an item's lore.
static java.lang.String	getStringFromLore(org.bukkit.inventory.ItemStack itemStack, java.lang.String content, int index) Gets a string from an item stack's lore, based on line content and word index.
static boolean	hasColoredName(org.bukkit.inventory.ItemStack itemStack, org.bukkit.ChatColor chatColor) Checks if the given color is contained in an item stack's display name.
static boolean	hasDisplayName(org.bukkit.inventory.ItemStack itemStack) Checks if the given item stack has a display name.
static boolean	hasEqualLore(org.bukkit.inventory.ItemStack itemStackA, org.bukkit.inventory.ItemStack itemStackB) Checks if the given item stacks have the same lore.
static boolean	hasLore(org.bukkit.inventory.ItemStack itemStack) Checks if the given item has a lore.
static boolean	isAmmoItem(org.bukkit.inventory.ItemStack itemStack) Checks if an item stack is an ammo item, based on lore.
static boolean	isBanner(org.bukkit.inventory.ItemStack itemStack) Checks if an item stack possesses a banner meta.
static boolean	isBoughtItem(org.bukkit.inventory.ItemStack itemStack) Checks if an item stack is a bought item, based on lore.
static boolean	isInstanceMap(org.bukkit.inventory.ItemStack itemStack) Checks if the item stack is an instance map, based on lore.
static boolean	isMaterial(org.bukkit.inventory.ItemStack itemStack, org.bukkit.Material material) Checks if the item stack is not null and made out of a given material.
static boolean	isMaterialItem(org.bukkit.inventory.ItemStack itemStack) Checks if an item stack is a material, based on lore.
static boolean	isNotAir(org.bukkit.inventory.ItemStack itemStack) Checks if an item stack is neither null or air.
static boolean	isQuestItem(org.bukkit.inventory.ItemStack itemStack) Checks if an item stack is a quest item, based on lore.
static boolean	isSpecificItem(org.bukkit.inventory.ItemStack itemStack, java.lang.String itemName) Checks if an item stack is a specific item, based on display name.
static boolean	replaceStringFromLore(org.bukkit.inventory.ItemStack itemStack, java.lang.String content, int index, java.lang.String replacement) Replaces a substring with given word index in all occurances of a string inside an item's lore.
static boolean	replaceStringFromLore(org.bukkit.inventory.ItemStack itemStack, java.lang.String content, java.lang.String replacement) Replaces all occurances of a line inside an item stack's lore.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemUtils

public ItemUtils()

Method Detail

isNotAir

public static boolean isNotAir(org.bukkit.inventory.ItemStack itemStack)

Checks if an item stack is neither null or air.

Parameters:

itemStack - The item stack to check.

Returns:

If the item is not air.

isMaterial

public static boolean isMaterial(org.bukkit.inventory.ItemStack itemStack,
                                 org.bukkit.Material material)

Checks if the item stack is not null and made out of a given material.

Parameters:

itemStack - The item stack to check.

material - The material to check for.

Returns:

If the item is made out of that material.

fitsInInventory

public static boolean fitsInInventory(org.bukkit.inventory.Inventory inventory,
                                      org.bukkit.inventory.ItemStack itemStack)

Checks if enough space is left in an inventory, to fit in the given item stack. This is done by checking, if a free slot is available. If not, it is checked, if the items can be stacked with an already existing item stack.

Parameters:

inventory - The inventory to iterate through.

itemStack - The item stack to check for.

Returns:

If the item stack fits inside the inventory.

See Also:

countSpecificStackableItems(Inventory, ItemStack), getAmountOfStacks(int, int)

getAmountOfStacks

private static int getAmountOfStacks(int maxStackSize,
                                     int itemAmount)

Counts how many stacks are needed to fit the given amount of items.

Parameters:

maxStackSize - The maximum stack size of that item.

itemAmount - The amount of items.

Returns:

How man stacks are needed to fit the items.

countSpecificStackableItems

public static int countSpecificStackableItems(org.bukkit.inventory.Inventory inventory,
                                              org.bukkit.inventory.ItemStack itemStack)

Counts the total amount of the given item stack inside an inventory.

Parameters:

inventory - The inventory to iterate through.

itemStack - The item stack to check for.

Returns:

The amount of times, the item was found inside the inventory.

See Also:

isSpecificItem(ItemStack, String)

isSpecificItem

public static boolean isSpecificItem(org.bukkit.inventory.ItemStack itemStack,
                                     java.lang.String itemName)

Checks if an item stack is a specific item, based on display name. Includes null check.

Parameters:

itemStack - The item stack to check.

itemName - The item name to check for.

Returns:

If the item has exactly the specified name.

isBanner

public static boolean isBanner(org.bukkit.inventory.ItemStack itemStack)

Checks if an item stack possesses a banner meta. Includes null check.

Parameters:

itemStack - The item stack to check.

Returns:

If the item is a banner.

isMaterialItem

public static boolean isMaterialItem(org.bukkit.inventory.ItemStack itemStack)

Checks if an item stack is a material, based on lore. Includes null check.

Parameters:

itemStack - The item stack to check.

Returns:

If the item is a material.

isQuestItem

public static boolean isQuestItem(org.bukkit.inventory.ItemStack itemStack)

Checks if an item stack is a quest item, based on lore. Includes null check.

Parameters:

itemStack - The item stack to check.

Returns:

If the item is a quest item.

isAmmoItem

public static boolean isAmmoItem(org.bukkit.inventory.ItemStack itemStack)

Checks if an item stack is an ammo item, based on lore. Includes null check.

Parameters:

itemStack - The item stack to check.

Returns:

If the item is an ammo item.

See Also:

getArrowCount(ItemStack)

isBoughtItem

public static boolean isBoughtItem(org.bukkit.inventory.ItemStack itemStack)

Checks if an item stack is a bought item, based on lore. Includes null check.

Parameters:

itemStack - The item stack to check.

Returns:

If the item is a bought item.

See Also:

getSellValue(ItemStack)

getArrowCount

public static int getArrowCount(org.bukkit.inventory.ItemStack itemStack)

Gets the amount of arrows from an item stack, based on lore. Includes null check.

Parameters:

itemStack - The item stack to check.

Returns:

The amount of arrows.

See Also:

isAmmoItem(ItemStack)

getSellValue

public static int getSellValue(org.bukkit.inventory.ItemStack itemStack)

Gets the sell value of an item stack, based on lore. Includes null check.

Parameters:

itemStack - The item stack to check.

Returns:

The sell value.

See Also:

isBoughtItem(ItemStack)

isInstanceMap

public static boolean isInstanceMap(org.bukkit.inventory.ItemStack itemStack)

Checks if the item stack is an instance map, based on lore. Includes null check.

Parameters:

itemStack - The item stack to check.

Returns:

If the item is an instance map.

See Also:

isInstanceMap(ItemStack)

getInstanceMapType

public static java.lang.String getInstanceMapType(org.bukkit.inventory.ItemStack itemStack)

Gets the map type of an item stack, based on lore. Does NOT include null check.

Parameters:

itemStack - The item stack to check.

Returns:

The instance map type.

See Also:

isInstanceMap(ItemStack)

hasColoredName

public static boolean hasColoredName(org.bukkit.inventory.ItemStack itemStack,
                                     org.bukkit.ChatColor chatColor)

Checks if the given color is contained in an item stack's display name. Includes null check.

Parameters:

itemStack - The item stack to check.

chatColor - The color to check for.

Returns:

If the color is contained in the name.

hasDisplayName

public static boolean hasDisplayName(org.bukkit.inventory.ItemStack itemStack)

Checks if the given item stack has a display name. Includes null check.

Parameters:

itemStack - The item stack to check.

Returns:

If the item has a name.

getDisplayName

public static java.lang.String getDisplayName(org.bukkit.inventory.ItemStack itemStack)

Gets the display name of the given item stack. Includes partial null check.

Parameters:

itemStack - The item stack to check.

Returns:

The name of the item.

hasLore

public static boolean hasLore(org.bukkit.inventory.ItemStack itemStack)

Checks if the given item has a lore. Includes null check.

Parameters:

itemStack - The item stack to check.

Returns:

If the item has a lore.

hasEqualLore

public static boolean hasEqualLore(org.bukkit.inventory.ItemStack itemStackA,
                                   org.bukkit.inventory.ItemStack itemStackB)

Checks if the given item stacks have the same lore. Includes null check.

Parameters:

itemStackA - The first item stack to check.

itemStackB - The second item stack to check.

Returns:

If the items have equal lore.

doesLoreContain

public static boolean doesLoreContain(org.bukkit.inventory.ItemStack itemStack,
                                      java.lang.String content)

Checks if the lore of the item stack contains the given string. Does NOT include null check.

Parameters:

itemStack - The item stack to check.

content - The string to check for.

Returns:

If the string was found.

getStringFromLore

public static java.lang.String getStringFromLore(org.bukkit.inventory.ItemStack itemStack,
                                                 java.lang.String content,
                                                 int index)

Gets a string from an item stack's lore, based on line content and word index. Does NOT include null check.

Parameters:

itemStack - The item stack to check.

content - The string to identify the line with.

index - The word index inside the found line.

Returns:

The string on the found line, with the given word index.

getStringBetweenFromLore

public static java.lang.String getStringBetweenFromLore(org.bukkit.inventory.ItemStack itemStack,
                                                        java.lang.String before,
                                                        java.lang.String after)

Finds a string between two other strings somewhere inside an item's lore. Does NOT include null check.

Parameters:

itemStack - The item stack to check.

before - The string before the wanted string.

after - The string after the wanted string.

Returns:

The string between the other strings.

getIntegerFromLore

public static int getIntegerFromLore(org.bukkit.inventory.ItemStack itemStack,
                                     java.lang.String content,
                                     int index)

Gets an integer from an item stack's lore, based on line content and word index. Does NOT include null check.

Parameters:

itemStack - The item stack to check.

content - The string to identify the line with.

index - The word index inside the found line.

Returns:

The int on the found line, with the given word index.

getIntegerBetweenFromLore

public static int getIntegerBetweenFromLore(org.bukkit.inventory.ItemStack itemStack,
                                            java.lang.String before,
                                            java.lang.String after)

Finds an int between two strings somewhere inside an item's lore. Does NOT include null check.

Parameters:

itemStack - The item stack to check.

before - The string before the wanted int.

after - The string after the wanted int.

Returns:

The int between the other strings.

getIntegerSumBetweenFromLore

public static int getIntegerSumBetweenFromLore(org.bukkit.inventory.ItemStack itemStack,
                                               java.lang.String before,
                                               java.lang.String after)

Finds the sum of all integers between all occurances of two strings somewhere inside an item's lore. Does NOT include null check.

Parameters:

itemStack - The item stack to check.

before - The string before the wanted int.

after - The string after the wanted int.

Returns:

The sum of all integers between occurances of the two strings.

getLongFromLore

public static long getLongFromLore(org.bukkit.inventory.ItemStack itemStack,
                                   java.lang.String content,
                                   int index)

Gets a long from an item stack's lore, based on line content and word index. Does NOT include null check.

Parameters:

itemStack - The item stack to check.

content - The string to identify the line with.

index - The word index inside the found line.

Returns:

The long on the found line, with the given word index.

replaceStringFromLore

public static boolean replaceStringFromLore(org.bukkit.inventory.ItemStack itemStack,
                                            java.lang.String content,
                                            java.lang.String replacement)

Replaces all occurances of a line inside an item stack's lore. Does NOT include null check.

Parameters:

itemStack - The item stack to edit.

content - The string to identify the line with.

replacement - The replacement of the content.

Returns:

If at least one occurance was replaced.

replaceStringFromLore

public static boolean replaceStringFromLore(org.bukkit.inventory.ItemStack itemStack,
                                            java.lang.String content,
                                            int index,
                                            java.lang.String replacement)

Replaces a substring with given word index in all occurances of a string inside an item's lore. Does NOT include null check.

Parameters:

itemStack - The item stack to edit.

content - The string to identify the line with.

index - The word index of the substring to replace inside the found line.

replacement - The replacement of the content.

Returns:

If at least one occurance was replaced.