com.moderocky.mask.gui

Class ItemFactory

java.lang.Object

com.moderocky.mask.gui.ItemFactory

public class ItemFactory
extends Object

An item-creating factory to allow for easy itemstack creation/manipulation within a single object. This makes use of chain methods as well as consumers to simplify the process.

Constructor Summary

Constructors

Constructor and Description
ItemFactory() Creates a default factory for an Air item.
ItemFactory(@NotNull ItemStack itemStack) Creates an item factory based on the given item.
ItemFactory(@NotNull Material material) Creates an item factory for the given material.
ItemFactory(@NotNull Material material, @NotNull Consumer<ItemMeta> consumer) Creates an item factory for the given material.
ItemFactory(@NotNull Material material, int amount) Creates an item factory for the given material.
ItemFactory(@NotNull Material material, int amount, @NotNull Consumer<ItemMeta> consumer) Creates an item factory for the given material.

Method Summary

Modifier and Type	Method and Description
ItemFactory	addConsumer(Consumer<ItemMeta> consumer) Adds a consumer that can be run on the meta upon creation or application.
ItemFactory	apply(ItemStack itemStack) Applies this factory to an existing item.
@NotNull ItemStack	create() This creates a new item given the provided material and amounts.
@NotNull ItemMeta	getItemMeta()
@NotNull Material	getMaterial()
ItemFactory	setAmount(int i) Set the final amount.
ItemFactory	setMaterial(@NotNull Material material) Re-sets the material.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemFactory

public ItemFactory()

Creates a default factory for an Air item.

ItemFactory

public ItemFactory(@NotNull
                   @NotNull Material material)

Creates an item factory for the given material.

Parameters:

material - Material

ItemFactory

public ItemFactory(@NotNull
                   @NotNull Material material,
                   int amount)

Creates an item factory for the given material.

Parameters:

material - Material

amount - Amount

ItemFactory

public ItemFactory(@NotNull
                   @NotNull Material material,
                   @NotNull
                   @NotNull Consumer<ItemMeta> consumer)

Creates an item factory for the given material.

Parameters:

material - Material

consumer - A consumer to be performed on the item when create() is used.

ItemFactory

public ItemFactory(@NotNull
                   @NotNull Material material,
                   int amount,
                   @NotNull
                   @NotNull Consumer<ItemMeta> consumer)

Creates an item factory for the given material.

Parameters:

material - Material

amount - Amount

consumer - A consumer to be performed on the item's meta when create() is used.

ItemFactory

public ItemFactory(@NotNull
                   @NotNull ItemStack itemStack)

Creates an item factory based on the given item. Remember: any edits will not be applied to this item.

You can use apply(ItemStack) to apply the edits to an item.

Parameters:

itemStack - The template item stack to use.

Method Detail

setAmount

public ItemFactory setAmount(int i)

Set the final amount. This will be bounded between 0 and 127 inclusively.

Parameters:

i - Amount

Returns:

Chain

addConsumer

public ItemFactory addConsumer(Consumer<ItemMeta> consumer)

Adds a consumer that can be run on the meta upon creation or application. An unlimited number of consumers can be added here.

Parameters:

consumer - A consumer to be run on the item meta

Returns:

Chain

apply

public ItemFactory apply(ItemStack itemStack)

Applies this factory to an existing item. If the material differs, the meta will be converted to match this new item.

The material of an existing item cannot be changed.

Parameters:

itemStack - An item

Returns:

Chain

getMaterial

@NotNull
public @NotNull Material getMaterial()

Returns:

The given material

setMaterial

public ItemFactory setMaterial(@NotNull
                               @NotNull Material material)

Re-sets the material. Will attempt to convert the existing item meta to match the new material. If the meta cannot be converted, it will be ignored.

Parameters:

material - A material

Returns:

Chain

getItemMeta

@NotNull
public @NotNull ItemMeta getItemMeta()

Returns:

The meta, with any given consumers applied

create

@NotNull
public @NotNull ItemStack create()

This creates a new item given the provided material and amounts. Any consumers will then be applied to its meta, and the meta will be applied to the item.

Where possible, any invalid meta edits will be skipped to preserve the process.

Returns:

The newly-created item