com.codelanx.codelanxlib.inventory

Class ItemStackBuilder

java.lang.Object

com.codelanx.codelanxlib.inventory.ItemStackBuilder

public class ItemStackBuilder
extends Object

Allows for the full creation of an ItemStack within a static context. All color codes using '&' can be automatically converted

Since:

0.0.1

Version:

0.0.1

Author:

1Rogue

Field Summary

Fields

Modifier and Type	Field and Description
protected int	amount The amount of items in the ItemStack
protected boolean	autoTranslate Specifies whether or not to automatically translate color codes
static String	DEFAULT_PREFIX Prefix for lore items because purple is ugly
protected short	durability The durability of the ItemStack
protected Map<Enchantment,Integer>	enchantments A mapping of Enchantments to their levels
protected List<String>	lore The lore for the ItemStack
protected String	lorePrefix A prefix that can be set for all lore
protected String	name The name for the ItemStack
protected Material	type The type for the ItemStack

Constructor Summary

Constructors

Constructor and Description
ItemStackBuilder()

Method Summary

Modifier and Type	Method and Description
ItemStackBuilder	addEnchantment(Enchantment ench, int level) Adds an enchantment to the ItemStack
ItemStackBuilder	addLore(String lore) Adds lore to the ItemStack
ItemStackBuilder	amount(int amount) Sets the amount of items in the ItemStack
ItemStackBuilder	autoTranslateColors(boolean autoTranslate) Sets whether or not to automatically translate color codes
ItemStack	build() Builds the ItemStack object and returns it
ItemStackBuilder	durability(short durability) Sets the durability to apply to the ItemStack
ItemStackBuilder	lorePrefix(String prefix) Sets the prefix to use for all lore items
ItemStackBuilder	name(String name) Sets the display name for the ItemStack
ItemStackBuilder	type(Material type) Sets the Material type for the ItemStack

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PREFIX

public static final String DEFAULT_PREFIX

Prefix for lore items because purple is ugly

lorePrefix

protected String lorePrefix

A prefix that can be set for all lore

name

protected String name

The name for the ItemStack

lore

protected List<String> lore

The lore for the ItemStack

enchantments

protected Map<Enchantment,Integer> enchantments

A mapping of Enchantments to their levels

type

protected Material type

The type for the ItemStack

amount

protected int amount

The amount of items in the ItemStack

durability

protected short durability

The durability of the ItemStack

autoTranslate

protected boolean autoTranslate

Specifies whether or not to automatically translate color codes

Constructor Detail

ItemStackBuilder

public ItemStackBuilder()

Method Detail

name

public ItemStackBuilder name(String name)

Sets the display name for the ItemStack

Parameters:

name - The display name

Returns:

This instance (chained)

Since:

0.0.1

addLore

public ItemStackBuilder addLore(String lore)

Adds lore to the ItemStack

Parameters:

lore - The lore to add

Returns:

This instance (chained)

Since:

0.0.1

lorePrefix

public ItemStackBuilder lorePrefix(String prefix)

Sets the prefix to use for all lore items

Parameters:

prefix - The prefix to set

Returns:

This instance (chained)

Since:

0.1.0

durability

public ItemStackBuilder durability(short durability)

Sets the durability to apply to the ItemStack

Parameters:

durability - The durability to use (can also be a data value)

Returns:

This instance (chained)

Since:

0.1.0

autoTranslateColors

public ItemStackBuilder autoTranslateColors(boolean autoTranslate)

Sets whether or not to automatically translate color codes

Parameters:

autoTranslate - true to automatically translate '&'

Returns:

This instance (chained)

Since:

0.1.0

addEnchantment

public ItemStackBuilder addEnchantment(Enchantment ench,
                                       int level)

Adds an enchantment to the ItemStack

Parameters:

ench - The Enchantment to add

level - The level of the enchantment

Returns:

This instance (chained)

Since:

0.0.1

type

public ItemStackBuilder type(Material type)

Sets the Material type for the ItemStack

Parameters:

type - The Material type to set

Returns:

This instance (chained)

Since:

0.0.1

amount

public ItemStackBuilder amount(int amount)

Sets the amount of items in the ItemStack

Parameters:

amount - The amount to set

Returns:

This instance (chained)

Since:

0.0.1

build

public ItemStack build()

Builds the ItemStack object and returns it

Returns:

The new ItemStack

Throws:

IllegalArgumentException - If type is null, amount <= 0, or amount > Material.getMaxStackSize()

Since:

0.0.1