Package net.pinger.disguise.item

Class ItemBuilder

java.lang.Object

net.pinger.disguise.item.ItemBuilder

public class ItemBuilder
extends Object

This class is a utility class mainly used for easier creation of different ItemStacks.

Using this class, you can make your code even more readable and also do it in as little operations as possible.

Since:

2.0

Author:

Pinger

Constructor Summary

Constructors

Constructor	Description
ItemBuilder(XMaterial material)	Constructs a new ItemBuilder with the given XMaterial.
ItemBuilder(org.bukkit.inventory.ItemStack item)	Constructs a new ItemBuilder with the given ItemStack to modify.
ItemBuilder(org.bukkit.Material material)	Constructs a new ItemBuilder with the given material.
ItemBuilder(org.bukkit.Material material, int amount)	Constructs a new ItemBuilder with the given material and its' amount.
ItemBuilder(org.bukkit.Material material, int amount, short data)	Constructs a new ItemBuilder with the given ItemStack contents.
ItemBuilder(org.bukkit.Material material, short data)	Constructs a new ItemBuilder with the given material and the material data.

Method Summary

Modifier and Type	Method	Description
ItemBuilder	addLore(String... lore)	This method adds lore to the current lore of the ItemStack.
ItemBuilder	addLore(List<String> lore)	This method adds lore to the current lore of the ItemStack.
org.bukkit.inventory.ItemStack	build()	This method builds this ItemBuilder into a ItemStack instance while taking all specified fields into account.
ItemBuilder	enchant(org.bukkit.enchantments.Enchantment enchantment)	This method adds an enchantment to the ItemStack.
ItemBuilder	enchant(org.bukkit.enchantments.Enchantment enchantment, int level)	This method adds a leveled enchantment to the ItemStack.
ItemBuilder	flag()	This method adds all flags from the ItemFlag enum to the item.
ItemBuilder	flag(org.bukkit.inventory.ItemFlag... flags)	This method adds flags to the ItemStack.
ItemBuilder	lore(String... lore)	This method overrides the lore of the ItemStack with the specified lore.
ItemBuilder	lore(List<String> lore)	This method overrides the lore of the ItemStack with the specified lore.
ItemBuilder	name(String displayName)	This method sets the display name of the ItemStack instance.

Methods inherited from class java.lang.Object

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

Constructor Details

ItemBuilder

public ItemBuilder(@Nonnull
 org.bukkit.inventory.ItemStack item)

Constructs a new ItemBuilder with the given ItemStack to modify.

Parameters:

item - the item to modify

ItemBuilder

public ItemBuilder(org.bukkit.Material material,
 int amount,
 short data)

Constructs a new ItemBuilder with the given ItemStack contents.

Parameters:

material - the material type

amount - the amount of the ItemStack

data - the data of the ItemStack

ItemBuilder

public ItemBuilder(org.bukkit.Material material,
 int amount)

Constructs a new ItemBuilder with the given material and its' amount.

Parameters:

material - the material

amount - the amount

ItemBuilder

public ItemBuilder(org.bukkit.Material material,
 short data)

Constructs a new ItemBuilder with the given material and the material data.

Parameters:

material - the material

data - the material data

ItemBuilder

public ItemBuilder(org.bukkit.Material material)

Constructs a new ItemBuilder with the given material.

Parameters:

material - the material

ItemBuilder

public ItemBuilder(XMaterial material)

Constructs a new ItemBuilder with the given XMaterial.

Parameters:

material - the material

Method Details

name

public ItemBuilder name(String displayName)

This method sets the display name of the ItemStack instance.

Parameters:

displayName - the display name

Returns:

this instance

lore

public ItemBuilder lore(String... lore)

This method overrides the lore of the ItemStack with the specified lore.

Parameters:

lore - the lore to override

Returns:

this instance

lore

public ItemBuilder lore(List<String> lore)

This method overrides the lore of the ItemStack with the specified lore.

Parameters:

lore - the lore to override

Returns:

this instance

addLore

public ItemBuilder addLore(List<String> lore)

This method adds lore to the current lore of the ItemStack.

Parameters:

lore - the lore to add

Returns:

this instance

addLore

public ItemBuilder addLore(String... lore)

This method adds lore to the current lore of the ItemStack.

Parameters:

lore - the lore to add

Returns:

this instance

flag

public ItemBuilder flag(org.bukkit.inventory.ItemFlag... flags)

This method adds flags to the ItemStack.

Parameters:

flags - the flags to add

Returns:

this instance

flag

public ItemBuilder flag()

This method adds all flags from the ItemFlag enum to the item.

Returns:

this instance

enchant

public ItemBuilder enchant(org.bukkit.enchantments.Enchantment enchantment,
 int level)

This method adds a leveled enchantment to the ItemStack.

Parameters:

enchantment - the enchantment to add

level - the level of the enchantment

Returns:

this instance

enchant

public ItemBuilder enchant(org.bukkit.enchantments.Enchantment enchantment)

This method adds an enchantment to the ItemStack.

Parameters:

enchantment - the enchantment to add

Returns:

this instance

build

public org.bukkit.inventory.ItemStack build()

This method builds this ItemBuilder into a ItemStack instance while taking all specified fields into account.

Returns:

the built ItemStack