Package org.geysermc.geyser.session.cache.registry

Record Class JavaRegistryKey<T>

java.lang.Object

java.lang.Record

org.geysermc.geyser.session.cache.registry.JavaRegistryKey<T>

Type Parameters:

T - the object type this registry holds.

Record Components:

registryKey - the registry key, as it appears on Java.

lookup - an implementation of JavaRegistryKey.RegistryLookup that converts an object in this registry to its respective network ID or key, and back.

public record JavaRegistryKey<T>(net.kyori.adventure.key.Key registryKey, JavaRegistryKey.RegistryLookup<T> lookup)
extends Record

Defines a Java registry, which can be hardcoded or data-driven. This class doesn't store registry contents itself, that is handled by RegistryCache in the case of data-driven registries and other classes in the case of hardcoded registries.

This class is used when, for a Java registry, data-driven objects and/or tags need to be loaded. Only one instance of this class should be created for each Java registry. Instances of this class are kept in JavaRegistries, which also has useful methods for creating instances of this class.

This class has a few handy utility methods to convert between the various representations of an object in a registry (network ID, resource location/key, value).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JavaRegistryKey.RegistryLookup<T>	Implementations should look up an element in the given registry by its value, network ID, or registered key.

Constructor Summary

Constructors

Constructor	Description
JavaRegistryKey(net.kyori.adventure.key.Key registryKey, JavaRegistryKey.RegistryLookup<T> lookup)	Creates an instance of a JavaRegistryKey record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable net.kyori.adventure.key.Key	key(JavaRegistryProvider registries, int networkId)	Converts a network ID to its registered key, or null if it is not registered.
@Nullable net.kyori.adventure.key.Key	key(JavaRegistryProvider registries, T object)	Converts an object to its registered key, or null if it is not registered.
@Nullable net.kyori.adventure.key.Key	key(GeyserSession session, int networkId)	Converts a network ID to its registered key, or null if it is not registered.
@Nullable net.kyori.adventure.key.Key	key(GeyserSession session, T object)	Converts an object to its registered key, or null if it is not registered.
JavaRegistryKey.RegistryLookup<T>	lookup()	Returns the value of the lookup record component.
int	networkId(JavaRegistryProvider registries, net.kyori.adventure.key.Key key)	Converts a registered key to its network ID, or -1 if it is not registered.
int	networkId(JavaRegistryProvider registries, T object)	Converts an object to its network ID, or -1 if it is not registered.
int	networkId(GeyserSession session, net.kyori.adventure.key.Key key)	Converts a registered key to its network ID, or -1 if it is not registered.
int	networkId(GeyserSession session, T object)	Converts an object to its network ID, or -1 if it is not registered.
net.kyori.adventure.key.Key	registryKey()	Returns the value of the registryKey record component.
@NonNull String	toString()	Returns a string representation of this record class.
@Nullable T	value(JavaRegistryProvider registries, int networkId)	Converts a network ID to an object in this registry, or null if it is not registered.
@Nullable T	value(JavaRegistryProvider registries, net.kyori.adventure.key.Key key)	Converts a key to an object in this registry, or null if it is not registered.
@Nullable T	value(GeyserSession session, int networkId)	Converts a network ID to an object in this registry, or null if it is not registered.
@Nullable T	value(GeyserSession session, net.kyori.adventure.key.Key key)	Converts a key to an object in this registry, or null if it is not registered.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

JavaRegistryKey

public JavaRegistryKey(net.kyori.adventure.key.Key registryKey,
 JavaRegistryKey.RegistryLookup<T> lookup)

Creates an instance of a JavaRegistryKey record class.

Parameters:

registryKey - the value for the registryKey record component

lookup - the value for the lookup record component

Method Details

networkId

public int networkId(GeyserSession session,
 T object)

Converts an object to its network ID, or -1 if it is not registered.

networkId

public int networkId(JavaRegistryProvider registries,
 T object)

Converts an object to its network ID, or -1 if it is not registered.

networkId

public int networkId(GeyserSession session,
 net.kyori.adventure.key.Key key)

Converts a registered key to its network ID, or -1 if it is not registered.

networkId

public int networkId(JavaRegistryProvider registries,
 net.kyori.adventure.key.Key key)

Converts a registered key to its network ID, or -1 if it is not registered.

key

public @Nullable net.kyori.adventure.key.Key key(GeyserSession session,
 T object)

Converts an object to its registered key, or null if it is not registered.

key

public @Nullable net.kyori.adventure.key.Key key(JavaRegistryProvider registries,
 T object)

Converts an object to its registered key, or null if it is not registered.

key

public @Nullable net.kyori.adventure.key.Key key(GeyserSession session,
 int networkId)

Converts a network ID to its registered key, or null if it is not registered.

key

public @Nullable net.kyori.adventure.key.Key key(JavaRegistryProvider registries,
 int networkId)

Converts a network ID to its registered key, or null if it is not registered.

value

public @Nullable T value(GeyserSession session,
 int networkId)

Converts a network ID to an object in this registry, or null if it is not registered.

value

public @Nullable T value(JavaRegistryProvider registries,
 int networkId)

Converts a network ID to an object in this registry, or null if it is not registered.

value

public @Nullable T value(GeyserSession session,
 net.kyori.adventure.key.Key key)

Converts a key to an object in this registry, or null if it is not registered.

value

public @Nullable T value(JavaRegistryProvider registries,
 net.kyori.adventure.key.Key key)

Converts a key to an object in this registry, or null if it is not registered.

toString

public @NonNull String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

registryKey

public net.kyori.adventure.key.Key registryKey()

Returns the value of the registryKey record component.

Returns:

the value of the registryKey record component

lookup

public JavaRegistryKey.RegistryLookup<T> lookup()

Returns the value of the lookup record component.

Returns:

the value of the lookup record component