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.getMinimumLevel() and EnchantmentType.getMaximumLevel().

Nested Class Summary

Nested Classes

Modifier and Type	Interface and 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 and Description
static Enchantment.Builder	builder() Creates a new Enchantment.Builder to create an Enchantment.
int	getLevel() Gets the level of this enchantment.
EnchantmentType	getType() Gets the EnchantmentType for this enchantment.
static Enchantment	of(EnchantmentType enchantmentType, int level) Creates a new Enchantment with the provided EnchantmentType and level.
static Enchantment.RandomListBuilder	randomListBuilder()

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

getContentVersion, 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()

of

static Enchantment of(EnchantmentType enchantmentType,
                      int level)
               throws 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:

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

getType

EnchantmentType getType()

Gets the EnchantmentType for this enchantment.

Returns:

The enchantment type of this enchantment

getLevel

int getLevel()

Gets the level of this enchantment.

Returns:

The level of this enchantment