Package io.papermc.paper.registry

Interface TypedKey<T>

Type Parameters:

T - the value type for the registry

All Superinterfaces:

Comparable<Key>, net.kyori.examination.Examinable, Key, Keyed, Namespaced

@Experimental
@NullMarked
public sealed interface TypedKey<T>
extends Key

Represents a key for a value in a specific registry.

Field Summary

Fields inherited from interface net.kyori.adventure.key.Key

DEFAULT_SEPARATOR, MINECRAFT_NAMESPACE

Method Summary

Modifier and Type	Method	Description
static <T> TypedKey<T>	create(RegistryKey<T> registryKey, String key)	Create a typed key from a string and a registry key.
static <T> TypedKey<T>	create(RegistryKey<T> registryKey, Key key)	Create a typed key from a key and a registry key.
Key	key()	Gets the key for the value in the registry.
RegistryKey<T>	registryKey()	Gets the registry key for the value this key represents.

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examine

Methods inherited from interface net.kyori.adventure.key.Key

asMinimalString, asString, compareTo, examinableProperties, namespace, value

Method Details

key

Key key()

Gets the key for the value in the registry.

Specified by:

key in interface Key

Specified by:

key in interface Keyed

Returns:

the value's key

registryKey

RegistryKey<T> registryKey()

Gets the registry key for the value this key represents.

Returns:

the registry key

create

@Experimental
static <T> TypedKey<T> create(RegistryKey<T> registryKey,
 Key key)

Create a typed key from a key and a registry key.

Type Parameters:

T - value type

Parameters:

registryKey - the registry this key is for

key - the key for the value in the registry

Returns:

a new key for the value key and registry key

create

@Experimental
static <T> TypedKey<T> create(RegistryKey<T> registryKey,
 @KeyPattern
 String key)

Create a typed key from a string and a registry key.

Type Parameters:

T - value type

Parameters:

registryKey - the registry this key is for

key - the string version of a Key that will be passed to Key.key(String) for parsing.

Returns:

a new key for the value key and registry key

See Also:

• Key.key(String)