Record Class RegistryKey<T extends net.kyori.adventure.key.Keyed>

java.lang.Object
java.lang.Record
fr.robie.machineengine.api.registry.RegistryKey<T>
public record RegistryKey<T extends net.kyori.adventure.key.Keyed>(@NotNull RegistryType<T extends net.kyori.adventure.key.Keyed> registry, @NotNull net.kyori.adventure.key.Key id) extends Record
A typed reference to an entry of a registry, resolved on demand. Use it to hold references into reloadable registries (ยง7.3).

  • Constructor Summary

    Constructors
    Constructor
    Description
    RegistryKey(@NotNull RegistryType<T> registry, @NotNull net.kyori.adventure.key.Key id)
    Creates an instance of a RegistryKey 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.
    @NotNull net.kyori.adventure.key.Key
    id()
    Returns the value of the id record component.
    static <T extends net.kyori.adventure.key.Keyed>
    @NotNull RegistryKey<T>
    of(@NotNull RegistryType<T> registry, @NotNull net.kyori.adventure.key.Key id)
     
    @NotNull RegistryType<T>
    registry()
    Returns the value of the registry record component.
    @NotNull Optional<T>
    resolve(@NotNull RegistryAccess access)
     
    @NotNull String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • RegistryKey

      public RegistryKey(@NotNull @NotNull RegistryType<T> registry, @NotNull @NotNull net.kyori.adventure.key.Key id)
      Creates an instance of a RegistryKey record class.
      Parameters:
      registry - the value for the registry record component
      id - the value for the id record component

  • Method Details

    • of

      @NotNull public static <T extends net.kyori.adventure.key.Keyed> @NotNull RegistryKey<T> of(@NotNull @NotNull RegistryType<T> registry, @NotNull @NotNull net.kyori.adventure.key.Key id)

    • resolve

      @NotNull public @NotNull Optional<T> resolve(@NotNull @NotNull RegistryAccess access)

    • toString

      @NotNull public @NotNull 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.

    • registry

      @NotNull public @NotNull RegistryType<T> registry()
      Returns the value of the registry record component.
      Returns:
      the value of the registry record component

    • id

      @NotNull public @NotNull net.kyori.adventure.key.Key id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component