Package dev.oumaimaa.kawaiiapi.items

Class ItemUtils.ItemBuilder

java.lang.Object

dev.oumaimaa.kawaiiapi.items.ItemUtils.ItemBuilder

Enclosing class:

ItemUtils

public static final class ItemUtils.ItemBuilder
extends Object

Builder class for creating complex items with a fluent API. Provides method chaining for convenient item construction.

Constructor Summary

Constructors

Constructor	Description
ItemBuilder(@NotNull org.bukkit.Material material)	Creates a new ItemBuilder.
ItemBuilder(@NotNull org.bukkit.inventory.ItemStack item)	Creates a new ItemBuilder from an existing item.

Method Summary

Modifier and Type	Method	Description
@NotNull ItemUtils.ItemBuilder	addLore(@NotNull String... lines)	Adds lines to existing lore.
@NotNull ItemUtils.ItemBuilder	amount(int amount)	Sets the amount of the item.
@NotNull org.bukkit.inventory.ItemStack	build()	Builds and returns the final ItemStack.
@NotNull ItemUtils.ItemBuilder	customModelData(int data)	Sets custom model data.
@NotNull ItemUtils.ItemBuilder	enchant(@NotNull org.bukkit.enchantments.Enchantment enchantment, int level)	Adds an enchantment to the item.
@NotNull ItemUtils.ItemBuilder	glow()	Adds a glow effect.
@NotNull ItemUtils.ItemBuilder	hideFlags()	Hides all item flags.
@NotNull ItemUtils.ItemBuilder	hideFlags(@NotNull org.bukkit.inventory.ItemFlag... flags)	Hides specific item flags.
@NotNull ItemUtils.ItemBuilder	lore(@NotNull String... lore)	Sets the lore using color codes.
@NotNull ItemUtils.ItemBuilder	lore(@NotNull List<net.kyori.adventure.text.Component> lore)	Sets the lore using Components.
@NotNull ItemUtils.ItemBuilder	name(@NotNull String name)	Sets the display name using color codes.
@NotNull ItemUtils.ItemBuilder	name(@NotNull net.kyori.adventure.text.Component name)	Sets the display name using a Component.
@NotNull ItemUtils.ItemBuilder	unbreakable()	Makes the item unbreakable.

Methods inherited from class java.lang.Object

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

Constructor Details

ItemBuilder

public ItemBuilder(@NotNull
 @NotNull org.bukkit.Material material)

Creates a new ItemBuilder.

Parameters:

material - The material for the item

ItemBuilder

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

Creates a new ItemBuilder from an existing item.

Parameters:

item - The item to base this builder on

Method Details

amount

@NotNull
public @NotNull ItemUtils.ItemBuilder amount(int amount)

Sets the amount of the item.

Parameters:

amount - The amount (automatically clamped to valid range)

Returns:

This builder instance

name

@NotNull
public @NotNull ItemUtils.ItemBuilder name(@NotNull
 @NotNull String name)

Sets the display name using color codes.

Parameters:

name - The display name (supports & and invalid input: '&#'RRGGBB)

Returns:

This builder instance

name

@NotNull
public @NotNull ItemUtils.ItemBuilder name(@NotNull
 @NotNull net.kyori.adventure.text.Component name)

Sets the display name using a Component.

Parameters:

name - The display name Component

Returns:

This builder instance

lore

@NotNull
public @NotNull ItemUtils.ItemBuilder lore(@NotNull
 @NotNull String... lore)

Sets the lore using color codes.

Parameters:

lore - The lore lines (supports & and invalid input: '&#'RRGGBB)

Returns:

This builder instance

lore

@NotNull
public @NotNull ItemUtils.ItemBuilder lore(@NotNull
 @NotNull List<net.kyori.adventure.text.Component> lore)

Sets the lore using Components.

Parameters:

lore - The lore Components

Returns:

This builder instance

addLore

@NotNull
public @NotNull ItemUtils.ItemBuilder addLore(@NotNull
 @NotNull String... lines)

Adds lines to existing lore.

Parameters:

lines - The lines to add

Returns:

This builder instance

glow

@NotNull
public @NotNull ItemUtils.ItemBuilder glow()

Adds a glow effect.

Returns:

This builder instance

unbreakable

@NotNull
public @NotNull ItemUtils.ItemBuilder unbreakable()

Makes the item unbreakable.

Returns:

This builder instance

customModelData

@NotNull
public @NotNull ItemUtils.ItemBuilder customModelData(int data)

Sets custom model data.

Parameters:

data - The custom model data value

Returns:

This builder instance

hideFlags

@NotNull
public @NotNull ItemUtils.ItemBuilder hideFlags()

Hides all item flags.

Returns:

This builder instance

hideFlags

@NotNull
public @NotNull ItemUtils.ItemBuilder hideFlags(@NotNull
 @NotNull org.bukkit.inventory.ItemFlag... flags)

Hides specific item flags.

Parameters:

flags - The flags to hide

Returns:

This builder instance

enchant

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

Adds an enchantment to the item.

Parameters:

enchantment - The enchantment to add

level - The enchantment level

Returns:

This builder instance

build

@NotNull
public @NotNull org.bukkit.inventory.ItemStack build()

Builds and returns the final ItemStack.

Returns:

The constructed ItemStack