Package org.spongepowered.api.item.enchantment

Interface Enchantment

All Superinterfaces:

DataSerializable

public interface Enchantment
extends DataSerializable

Represents an EnchantmentType on an ItemStack that is paired with a level.

The contract of enchantments is that their level will always be between Short.MIN_VALUE and Short.MAX_VALUE, but it is not guaranteed they will work properly outside of EnchantmentType.minimumLevel() and EnchantmentType.maximumLevel().

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Enchantment.Builder	Represents a builder interface which can be used to create a Enchantment.
static interface	Enchantment.RandomListBuilder	Represents a builder interface which can be used to create a Enchantment.

Method Summary

Modifier and Type	Method	Description
static Enchantment.Builder	builder()	Creates a new Enchantment.Builder to create an Enchantment.
int	level()	Gets the level of this enchantment.
static Enchantment	of(java.util.function.Supplier<? extends EnchantmentType> enchantmentType, int level)	Creates a new Enchantment with the provided EnchantmentType and level.
static Enchantment	of(EnchantmentType enchantmentType, int level)	Creates a new Enchantment with the provided EnchantmentType and level.
static Enchantment.RandomListBuilder	randomListBuilder()	Creates a new Enchantment.RandomListBuilder to create a random list of Enchantments.
EnchantmentType	type()	Gets the EnchantmentType for this enchantment.

Methods inherited from interface org.spongepowered.api.data.persistence.DataSerializable

contentVersion, toContainer

Method Detail

builder

static Enchantment.Builder builder()

Creates a new Enchantment.Builder to create an Enchantment.

Returns:

The new builder

randomListBuilder

static Enchantment.RandomListBuilder randomListBuilder()

Creates a new Enchantment.RandomListBuilder to create a random list of Enchantments.

Returns:

The new random list builder

of

static Enchantment of(java.util.function.Supplier<? extends EnchantmentType> enchantmentType,
                      int level)
               throws java.lang.IllegalArgumentException

Creates a new Enchantment with the provided EnchantmentType and level.

Parameters:

enchantmentType - The enchantment type

level - The enchantment level

Returns:

The created enchantment

Throws:

java.lang.IllegalArgumentException - If the level is smaller than Short.MIN_VALUE or larger than Short.MAX_VALUE

of

static Enchantment of(EnchantmentType enchantmentType,
                      int level)
               throws java.lang.IllegalArgumentException

Creates a new Enchantment with the provided EnchantmentType and level.

Parameters:

enchantmentType - The enchantment type

level - The enchantment level

Returns:

The created enchantment

Throws:

java.lang.IllegalArgumentException - If the level is smaller than Short.MIN_VALUE or larger than Short.MAX_VALUE

type

EnchantmentType type()

Gets the EnchantmentType for this enchantment.

Returns:

The enchantment type of this enchantment

level

int level()

Gets the level of this enchantment.

Returns:

The level of this enchantment