Package io.artificial.enchantments.internal

Class EnchantmentDefinitionBuilder

java.lang.Object

io.artificial.enchantments.internal.EnchantmentDefinitionBuilder

All Implemented Interfaces:

EnchantmentDefinition.Builder

public final class EnchantmentDefinitionBuilder
extends Object
implements EnchantmentDefinition.Builder

Internal implementation of the EnchantmentDefinition.Builder interface.

This builder provides comprehensive validation for enchantment definitions including level bounds, material sets, conflicts, and cross-property validation. It creates immutable EnchantmentDefinitionImpl instances.

Since:

0.2.0

Constructor Summary

Constructors

Constructor	Description
EnchantmentDefinitionBuilder()	Creates a new enchantment definition builder.

Method Summary

Modifier and Type	Method	Description
EnchantmentDefinition.Builder	applicable(@NotNull Set<org.bukkit.Material> materials)	Sets applicable materials from a set.
EnchantmentDefinition.Builder	applicable(@NotNull org.bukkit.Material... materials)	Sets applicable materials from a varargs list.
@NotNull EnchantmentDefinition	build()	Builds and returns the enchantment definition.
EnchantmentDefinition.Builder	conflictsWith(@NotNull org.bukkit.NamespacedKey key)	Adds a conflicting enchantment key.
EnchantmentDefinition.Builder	conflictsWith(@NotNull org.bukkit.NamespacedKey... keys)	Adds multiple conflicting enchantment keys.
EnchantmentDefinition.Builder	curse()	Marks this enchantment as a curse (convenience method).
EnchantmentDefinition.Builder	curse(boolean curse)	Sets whether this is a curse enchantment.
EnchantmentDefinition.Builder	description(@Nullable net.kyori.adventure.text.Component description)	Sets the optional description for lore display.
EnchantmentDefinition.Builder	discoverable(boolean discoverable)	Sets whether this enchantment appears in loot tables.
EnchantmentDefinition.Builder	displayName(@NotNull net.kyori.adventure.text.Component name)	Sets the display name shown to players.
EnchantmentDefinition.Builder	effectHandler(@Nullable EnchantmentEffectHandler handler)	Sets the effect handler for this enchantment.
@NotNull List<String>	getValidationErrors()	Gets all validation errors for the current builder state.
EnchantmentDefinition.Builder	key(@NotNull org.bukkit.NamespacedKey key)	Sets the unique namespaced key for this enchantment.
EnchantmentDefinition.Builder	maxLevel(int maxLevel)	Sets the maximum valid level.
EnchantmentDefinition.Builder	minLevel(int minLevel)	Sets the minimum valid level.
EnchantmentDefinition.Builder	rarity(EnchantmentDefinition.Rarity rarity)	Sets the rarity tier.
EnchantmentDefinition.Builder	scaling(@NotNull LevelScaling scaling)	Sets the scaling formula using a LevelScaling instance.
EnchantmentDefinition.Builder	scaling(@NotNull String algorithmName, double... params)	Sets the scaling formula using a registered algorithm by name.
EnchantmentDefinition.Builder	scaling(@NotNull Function<Integer,Double> formula)	Sets a custom scaling formula using a lambda.
EnchantmentDefinition.Builder	tradeable(boolean tradeable)	Sets whether this enchantment is tradeable with villagers.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.artificial.enchantments.api.EnchantmentDefinition.Builder

isValid, validate

Constructor Details

EnchantmentDefinitionBuilder

public EnchantmentDefinitionBuilder()

Creates a new enchantment definition builder.

Since:

0.2.0

Method Details

key

@NotNull
public EnchantmentDefinition.Builder key(@NotNull
 @NotNull org.bukkit.NamespacedKey key)

Description copied from interface: EnchantmentDefinition.Builder

Sets the unique namespaced key for this enchantment.

Specified by:

key in interface EnchantmentDefinition.Builder

Parameters:

key - the enchantment key (must not be null)

Returns:

this builder for chaining

displayName

@NotNull
public EnchantmentDefinition.Builder displayName(@NotNull
 @NotNull net.kyori.adventure.text.Component name)

Description copied from interface: EnchantmentDefinition.Builder

Sets the display name shown to players.

Specified by:

displayName in interface EnchantmentDefinition.Builder

Parameters:

name - the display name (must not be null)

Returns:

this builder for chaining

description

@NotNull
public EnchantmentDefinition.Builder description(@Nullable
 @Nullable net.kyori.adventure.text.Component description)

Description copied from interface: EnchantmentDefinition.Builder

Sets the optional description for lore display.

Specified by:

description in interface EnchantmentDefinition.Builder

Parameters:

description - the description, or null for none

Returns:

this builder for chaining

minLevel

@NotNull
public EnchantmentDefinition.Builder minLevel(int minLevel)

Description copied from interface: EnchantmentDefinition.Builder

Sets the minimum valid level.

Specified by:

minLevel in interface EnchantmentDefinition.Builder

Parameters:

minLevel - the minimum level (must be >= 1)

Returns:

this builder for chaining

maxLevel

@NotNull
public EnchantmentDefinition.Builder maxLevel(int maxLevel)

Description copied from interface: EnchantmentDefinition.Builder

Sets the maximum valid level.

Specified by:

maxLevel in interface EnchantmentDefinition.Builder

Parameters:

maxLevel - the maximum level (must be >= minLevel)

Returns:

this builder for chaining

scaling

@NotNull
public EnchantmentDefinition.Builder scaling(@NotNull
 @NotNull LevelScaling scaling)

Description copied from interface: EnchantmentDefinition.Builder

Sets the scaling formula using a LevelScaling instance.

Specified by:

scaling in interface EnchantmentDefinition.Builder

Parameters:

scaling - the scaling formula (must not be null)

Returns:

this builder for chaining

scaling

@NotNull
public EnchantmentDefinition.Builder scaling(@NotNull
 @NotNull Function<Integer,Double> formula)

Description copied from interface: EnchantmentDefinition.Builder

Sets a custom scaling formula using a lambda.

Specified by:

scaling in interface EnchantmentDefinition.Builder

Parameters:

formula - the formula function (must not be null)

Returns:

this builder for chaining

scaling

@NotNull
public EnchantmentDefinition.Builder scaling(@NotNull
 @NotNull String algorithmName,
 double... params)

Description copied from interface: EnchantmentDefinition.Builder

Sets the scaling formula using a registered algorithm by name.

Uses the ScalingAlgorithmRegistry to look up the algorithm and create a configured LevelScaling instance.

Example:

 .scaling("LINEAR", 1.0, 0.5)        // base=1.0, increment=0.5
 .scaling("EXPONENTIAL", 1.0, 1.2)   // base=1.0, multiplier=1.2
 .scaling("CONSTANT", 5.0)           // value=5.0 at all levels
 

Specified by:

scaling in interface EnchantmentDefinition.Builder

Parameters:

algorithmName - the algorithm name (must not be null, case-insensitive)

params - the algorithm-specific parameters

Returns:

this builder for chaining

See Also:

• ScalingAlgorithmRegistry

applicable

@NotNull
public EnchantmentDefinition.Builder applicable(@NotNull
 @NotNull org.bukkit.Material... materials)

Description copied from interface: EnchantmentDefinition.Builder

Sets applicable materials from a varargs list.

Specified by:

applicable in interface EnchantmentDefinition.Builder

Parameters:

materials - the materials (must not be null)

Returns:

this builder for chaining

applicable

@NotNull
public EnchantmentDefinition.Builder applicable(@NotNull
 @NotNull Set<org.bukkit.Material> materials)

Description copied from interface: EnchantmentDefinition.Builder

Sets applicable materials from a set.

Specified by:

applicable in interface EnchantmentDefinition.Builder

Parameters:

materials - the material set (must not be null)

Returns:

this builder for chaining

curse

@NotNull
public EnchantmentDefinition.Builder curse(boolean curse)

Description copied from interface: EnchantmentDefinition.Builder

Sets whether this is a curse enchantment.

Specified by:

curse in interface EnchantmentDefinition.Builder

Parameters:

curse - true for curse enchantments

Returns:

this builder for chaining

curse

@NotNull
public EnchantmentDefinition.Builder curse()

Description copied from interface: EnchantmentDefinition.Builder

Marks this enchantment as a curse (convenience method).

Specified by:

curse in interface EnchantmentDefinition.Builder

Returns:

this builder for chaining

tradeable

@NotNull
public EnchantmentDefinition.Builder tradeable(boolean tradeable)

Description copied from interface: EnchantmentDefinition.Builder

Sets whether this enchantment is tradeable with villagers.

Specified by:

tradeable in interface EnchantmentDefinition.Builder

Parameters:

tradeable - true if tradeable

Returns:

this builder for chaining

discoverable

@NotNull
public EnchantmentDefinition.Builder discoverable(boolean discoverable)

Description copied from interface: EnchantmentDefinition.Builder

Sets whether this enchantment appears in loot tables.

Specified by:

discoverable in interface EnchantmentDefinition.Builder

Parameters:

discoverable - true if discoverable

Returns:

this builder for chaining

rarity

@NotNull
public EnchantmentDefinition.Builder rarity(@NotNull
 EnchantmentDefinition.Rarity rarity)

Description copied from interface: EnchantmentDefinition.Builder

Sets the rarity tier.

Specified by:

rarity in interface EnchantmentDefinition.Builder

Parameters:

rarity - the rarity (must not be null)

Returns:

this builder for chaining

effectHandler

@NotNull
public EnchantmentDefinition.Builder effectHandler(@Nullable
 @Nullable EnchantmentEffectHandler handler)

Description copied from interface: EnchantmentDefinition.Builder

Sets the effect handler for this enchantment.

Specified by:

effectHandler in interface EnchantmentDefinition.Builder

Parameters:

handler - the effect handler, or null for no effects

Returns:

this builder for chaining

conflictsWith

@NotNull
public EnchantmentDefinition.Builder conflictsWith(@NotNull
 @NotNull org.bukkit.NamespacedKey key)

Description copied from interface: EnchantmentDefinition.Builder

Adds a conflicting enchantment key.

Specified by:

conflictsWith in interface EnchantmentDefinition.Builder

Parameters:

key - the conflicting enchantment key (must not be null)

Returns:

this builder for chaining

conflictsWith

@NotNull
public EnchantmentDefinition.Builder conflictsWith(@NotNull
 @NotNull org.bukkit.NamespacedKey... keys)

Description copied from interface: EnchantmentDefinition.Builder

Adds multiple conflicting enchantment keys.

Specified by:

conflictsWith in interface EnchantmentDefinition.Builder

Parameters:

keys - the conflicting keys (must not be null)

Returns:

this builder for chaining

getValidationErrors

@NotNull
public @NotNull List<String> getValidationErrors()

Description copied from interface: EnchantmentDefinition.Builder

Gets all validation errors for the current builder state.

Returns a list of detailed error messages describing what validation rules are currently violated. An empty list indicates the builder is in a valid state.

Validation checks include:

• Required fields: key, displayName, scaling, applicable materials
• Level bounds: minLevel >= 1, maxLevel >= minLevel
• Material set: non-empty set of applicable materials
• Conflicts: no self-conflicts (enchantment cannot conflict with itself)
• Cross-property: warnings for curse + tradeable combinations

Default Behavior: Returns an empty list. Override in implementations to provide actual validation logic.

Specified by:

getValidationErrors in interface EnchantmentDefinition.Builder

Returns:

unmodifiable list of validation error and warning messages (empty if valid)

build

@NotNull
public @NotNull EnchantmentDefinition build()

Description copied from interface: EnchantmentDefinition.Builder

Builds and returns the enchantment definition.

Specified by:

build in interface EnchantmentDefinition.Builder

Returns:

the completed definition