Package org.bukkit

Interface Registry<T extends Keyed>

Type Parameters:

T - type of item in the registry

All Superinterfaces:

Iterable<T>

@NullMarked
public interface Registry<T extends Keyed>
extends Iterable<T>

Represents a registry of Bukkit objects that may be retrieved by NamespacedKey.

Field Summary

Fields

Modifier and Type	Field	Description
static final Registry<Advancement>	ADVANCEMENT	Deprecated, for removal: This API element is subject to removal in a future version. use Bukkit.getAdvancement(NamespacedKey) and Bukkit.advancementIterator()
static final Registry<Art>	ART	Deprecated. use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.PAINTING_VARIANT
static final Registry<Attribute>	ATTRIBUTE	Attribute.
static final Registry<PatternType>	BANNER_PATTERN	Deprecated. use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.BANNER_PATTERN
static final Registry<Biome>	BIOME	Deprecated. use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.BIOME
static final Registry<BlockType>	BLOCK	Server block types.
static final Registry<KeyedBossBar>	BOSS_BARS	Deprecated, for removal: This API element is subject to removal in a future version. use Bukkit.getBossBar(NamespacedKey) and Bukkit.getBossBars()
static final Registry<Cat.Type>	CAT_VARIANT	Deprecated. use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.CAT_VARIANT
static final Registry<DamageType>	DAMAGE_TYPE	Deprecated. use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.DAMAGE_TYPE
static final Registry<DataComponentType>	DATA_COMPONENT_TYPE	Data component types.
static final Registry<Enchantment>	ENCHANTMENT	Deprecated. use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.ENCHANTMENT
static final Registry<EntityType>	ENTITY_TYPE	Server entity types.
static final Registry<Fluid>	FLUID	Server fluids.
static final Registry<Frog.Variant>	FROG_VARIANT	Deprecated. use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.FROG_VARIANT
static final Registry<GameEvent>	GAME_EVENT	Game events.
static final Registry<MusicInstrument>	INSTRUMENT	Deprecated. use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.INSTRUMENT
static final Registry<ItemType>	ITEM	Server item types.
static final Registry<JukeboxSong>	JUKEBOX_SONG	Deprecated. use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.JUKEBOX_SONG
static final Registry<LootTables>	LOOT_TABLES	Default server loot tables.
static final Registry<MapCursor.Type>	MAP_DECORATION_TYPE	Map cursor types.
static final Registry<Material>	MATERIAL	Server materials.
static final Registry<MemoryKey<?>>	MEMORY_MODULE_TYPE	Memory Keys.
static final Registry<MenuType>	MENU	Server menus.
static final Registry<PotionEffectType>	MOB_EFFECT	Server mob effects.
static final Registry<Particle>	PARTICLE_TYPE	Server particles.
static final Registry<PotionType>	POTION	Server potions.
static final Registry<Sound>	SOUND_EVENT	Sound events.
static final Registry<Statistic>	STATISTIC	Server statistics.
static final Registry<Structure>	STRUCTURE	Deprecated. use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.STRUCTURE
static final Registry<StructureType>	STRUCTURE_TYPE	Server structure types.
static final Registry<TrimMaterial>	TRIM_MATERIAL	Deprecated. use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.TRIM_MATERIAL
static final Registry<TrimPattern>	TRIM_PATTERN	Deprecated. use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.TRIM_PATTERN
static final Registry<Villager.Profession>	VILLAGER_PROFESSION	Villager profession.
static final Registry<Villager.Type>	VILLAGER_TYPE	Villager type.
static final Registry<Wolf.Variant>	WOLF_VARIANT	Deprecated. use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.WOLF_VARIANT

Method Summary

Modifier and Type	Method	Description
default @Nullable T	get(TypedKey<T> typedKey)	Get the object by its typed key.
default @Nullable T	get(Key key)	Get the object by its key.
@Nullable T	get(NamespacedKey key)	Get the object by its key.
@Nullable NamespacedKey	getKey(T value)	Get the key for this object.
default NamespacedKey	getKeyOrThrow(T value)	Gets the key for this object or throws if it doesn't exist.
default T	getOrThrow(TypedKey<T> key)	Gets the object by its key or throws if it doesn't exist.
default T	getOrThrow(Key key)	Gets the object by its key or throws if it doesn't exist.
default T	getOrThrow(NamespacedKey key)	Get the object by its key.
Tag<T>	getTag(TagKey<T> key)	Gets the named registry set (tag) for the given key.
Collection<Tag<T>>	getTags()	Gets all the tags in this registry.
default Collection<T>	getTagValues(TagKey<T> key)	Gets the named registry set (tag) for the given key and resolves it with this registry.
boolean	hasTag(TagKey<T> key)	Checks if this registry has a tag with the given key.
Stream<NamespacedKey>	keyStream()	Returns a new stream, which contains all registry keys, which are registered to the registry.
default @Nullable T	match(String input)	Deprecated, for removal: This API element is subject to removal in a future version. this method's behavior is broken and not useful.
int	size()	Gets the size of the registry.
Stream<T>	stream()	Returns a new stream, which contains all registry items, which are registered to the registry.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Details

ADVANCEMENT

@Deprecated(since="1.21.4",
            forRemoval=true)
static final Registry<Advancement> ADVANCEMENT

Deprecated, for removal: This API element is subject to removal in a future version.

use Bukkit.getAdvancement(NamespacedKey) and Bukkit.advancementIterator()

Server advancements.

See Also:

• Bukkit.getAdvancement(NamespacedKey)
• Bukkit.advancementIterator()

ART

@Deprecated(since="1.21.3")
static final Registry<Art> ART

Deprecated.

use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.PAINTING_VARIANT

Server art.

See Also:

• Art

ATTRIBUTE

static final Registry<Attribute> ATTRIBUTE

Attribute.

See Also:

• Attribute

BANNER_PATTERN

@Deprecated(since="1.21")
static final Registry<PatternType> BANNER_PATTERN

Deprecated.

use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.BANNER_PATTERN

Server banner patterns.

See Also:

• PatternType

BIOME

@Deprecated(since="1.21.3")
static final Registry<Biome> BIOME

Deprecated.

use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.BIOME

Server biomes.

See Also:

• Biome

BLOCK

static final Registry<BlockType> BLOCK

Server block types.

See Also:

• BlockType

BOSS_BARS

@Deprecated(since="1.21.4",
            forRemoval=true)
static final Registry<KeyedBossBar> BOSS_BARS

Deprecated, for removal: This API element is subject to removal in a future version.

use Bukkit.getBossBar(NamespacedKey) and Bukkit.getBossBars()

Custom boss bars.

See Also:

• Bukkit.getBossBar(org.bukkit.NamespacedKey)
• Bukkit.getBossBars()

CAT_VARIANT

@Deprecated(since="1.21.5")
static final Registry<Cat.Type> CAT_VARIANT

Deprecated.

use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.CAT_VARIANT

Server cat types.

See Also:

• Cat.Type

ENCHANTMENT

@Deprecated(since="1.21")
static final Registry<Enchantment> ENCHANTMENT

Deprecated.

use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.ENCHANTMENT

Server enchantments.

See Also:

• Enchantment

ENTITY_TYPE

static final Registry<EntityType> ENTITY_TYPE

Server entity types.

See Also:

• EntityType

INSTRUMENT

@Deprecated(since="1.21.2")
static final Registry<MusicInstrument> INSTRUMENT

Deprecated.

use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.INSTRUMENT

Server instruments.

See Also:

• MusicInstrument

ITEM

static final Registry<ItemType> ITEM

Server item types.

See Also:

• ItemType

LOOT_TABLES

static final Registry<LootTables> LOOT_TABLES

Default server loot tables.

See Also:

• LootTables

MATERIAL

static final Registry<Material> MATERIAL

Server materials.

See Also:

• Material

MENU

@Experimental
static final Registry<MenuType> MENU

Server menus.

See Also:

• MenuType

MOB_EFFECT

static final Registry<PotionEffectType> MOB_EFFECT

Server mob effects.

See Also:

• PotionEffectType

PARTICLE_TYPE

static final Registry<Particle> PARTICLE_TYPE

Server particles.

See Also:

• Particle

POTION

static final Registry<PotionType> POTION

Server potions.

See Also:

• PotionType

STATISTIC

static final Registry<Statistic> STATISTIC

Server statistics.

See Also:

• Statistic

STRUCTURE

@Deprecated(since="1.20.6")
static final Registry<Structure> STRUCTURE

Deprecated.

use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.STRUCTURE

Server structures.

See Also:

• Structure

STRUCTURE_TYPE

static final Registry<StructureType> STRUCTURE_TYPE

Server structure types.

See Also:

• StructureType

SOUND_EVENT

static final Registry<Sound> SOUND_EVENT

Sound events.

See Also:

• Sound

TRIM_MATERIAL

@Deprecated(since="1.20.6")
static final Registry<TrimMaterial> TRIM_MATERIAL

Deprecated.

use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.TRIM_MATERIAL

Trim materials.

See Also:

• TrimMaterial

TRIM_PATTERN

@Deprecated(since="1.20.6")
static final Registry<TrimPattern> TRIM_PATTERN

Deprecated.

use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.TRIM_PATTERN

Trim patterns.

See Also:

• TrimPattern

DAMAGE_TYPE

@Deprecated(since="1.20.6")
static final Registry<DamageType> DAMAGE_TYPE

Deprecated.

use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.DAMAGE_TYPE

Damage types.

See Also:

• DamageType

JUKEBOX_SONG

@Deprecated(since="1.21")
static final Registry<JukeboxSong> JUKEBOX_SONG

Deprecated.

use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.JUKEBOX_SONG

Jukebox songs.

See Also:

• JukeboxSong

VILLAGER_PROFESSION

static final Registry<Villager.Profession> VILLAGER_PROFESSION

Villager profession.

See Also:

• Villager.Profession

VILLAGER_TYPE

static final Registry<Villager.Type> VILLAGER_TYPE

Villager type.

See Also:

• Villager.Type

MEMORY_MODULE_TYPE

static final Registry<MemoryKey<?>> MEMORY_MODULE_TYPE

Memory Keys.

See Also:

• MemoryKey

FLUID

static final Registry<Fluid> FLUID

Server fluids.

See Also:

• Fluid

FROG_VARIANT

@Deprecated(since="1.21.5")
static final Registry<Frog.Variant> FROG_VARIANT

Deprecated.

use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.FROG_VARIANT

Frog variants.

See Also:

• Frog.Variant

WOLF_VARIANT

@Deprecated(since="1.20.6")
static final Registry<Wolf.Variant> WOLF_VARIANT

Deprecated.

use RegistryAccess.getRegistry(RegistryKey) with RegistryKey.WOLF_VARIANT

Wolf variants.

See Also:

• Wolf.Variant

MAP_DECORATION_TYPE

static final Registry<MapCursor.Type> MAP_DECORATION_TYPE

Map cursor types.

See Also:

• MapCursor.Type

GAME_EVENT

static final Registry<GameEvent> GAME_EVENT

Game events.

See Also:

• GameEvent
• RegistryEvents.GAME_EVENT

DATA_COMPONENT_TYPE

static final Registry<DataComponentType> DATA_COMPONENT_TYPE

Data component types.

See Also:

• DataComponentType

Method Details

get

@Nullable T get(NamespacedKey key)

Get the object by its key.

Parameters:

key - non-null key

Returns:

item or null if it does not exist

get

default @Nullable T get(Key key)

Get the object by its key.

Parameters:

key - non-null key

Returns:

item or null if it does not exist

get

default @Nullable T get(TypedKey<T> typedKey)

Get the object by its typed key.

Parameters:

typedKey - non-null typed key

Returns:

item or null if it does not exist

getOrThrow

default T getOrThrow(Key key)

Gets the object by its key or throws if it doesn't exist.

Parameters:

key - the key to get the object of in this registry

Returns:

the object for the key

Throws:

NoSuchElementException - if the key doesn't point to an object in the registry

getOrThrow

default T getOrThrow(TypedKey<T> key)

Gets the object by its key or throws if it doesn't exist.

Parameters:

key - the key to get the object of in this registry

Returns:

the object for the key

Throws:

NoSuchElementException - if the key doesn't point to an object in the registry

getKeyOrThrow

default NamespacedKey getKeyOrThrow(T value)

Gets the key for this object or throws if it doesn't exist.

Some types can exist without being in a registry and such will have no key associated with them. This method throw an exception if it isn't in this registry.

Parameters:

value - the value to get the key of in this registry

Returns:

the key for the value

Throws:

NoSuchElementException - if the value doesn't exist in this registry

See Also:

• getKey(Keyed)

getKey

@Nullable NamespacedKey getKey(T value)

Get the key for this object.

Some types can exist without being in a registry and such will have no key associated with them. This method will return null.

Parameters:

value - the value to get the key of in this registry

Returns:

the key for the value or null if not in the registry

See Also:

• getKeyOrThrow(Keyed)

hasTag

boolean hasTag(TagKey<T> key)

Checks if this registry has a tag with the given key.

Parameters:

key - the key to check for

Returns:

true if this registry has a tag with the given key, false otherwise

Throws:

UnsupportedOperationException - if this registry doesn't have or support tags

See Also:

• getTag(TagKey)

getTag

@Experimental
Tag<T> getTag(TagKey<T> key)

Gets the named registry set (tag) for the given key.

Parameters:

key - the key to get the tag for

Returns:

the tag for the key

Throws:

NoSuchElementException - if no tag with the given key is found

UnsupportedOperationException - if this registry doesn't have or support tags

See Also:

• hasTag(TagKey)
• getTagValues(TagKey)

getTagValues

@Experimental
default Collection<T> getTagValues(TagKey<T> key)

Gets the named registry set (tag) for the given key and resolves it with this registry.

Parameters:

key - the key to get the tag for

Returns:

the resolved values

Throws:

NoSuchElementException - if no tag with the given key is found

UnsupportedOperationException - if this registry doesn't have or support tags

See Also:

• getTag(TagKey)
• RegistryKeySet.resolve(Registry)

getTags

@Experimental
Collection<Tag<T>> getTags()

Gets all the tags in this registry.

Returns:

a stream of all tags in this registry

Throws:

UnsupportedOperationException - if this registry doesn't have or support tags

getOrThrow

default T getOrThrow(NamespacedKey key)

Get the object by its key.

If there is no object with the given key, an exception will be thrown.

Parameters:

key - to get the object from

Returns:

object with the given key

Throws:

NoSuchElementException - if there is no object with the given key

stream

Stream<T> stream()

Returns a new stream, which contains all registry items, which are registered to the registry.

Returns:

a stream of all registry items

keyStream

Stream<NamespacedKey> keyStream()

Returns a new stream, which contains all registry keys, which are registered to the registry.

Returns:

a stream of all registry keys

match

@Deprecated(forRemoval=true)
default @Nullable T match(String input)

Deprecated, for removal: This API element is subject to removal in a future version.

this method's behavior is broken and not useful. If you want to get an object based on its vanilla name, or a key, wrap it in a NamespacedKey object and use get(NamespacedKey)

Attempts to match the registered object with the given key.

This will attempt to find a reasonable match based on the provided input and may do so through unspecified means.

Parameters:

input - non-null input

Returns:

registered object or null if does not exist

size

int size()

Gets the size of the registry.

Returns:

the size of the registry