Record Class RegistryReference<K,V>

java.lang.Object
java.lang.Record
net.darkhax.bookshelf.common.api.registry.RegistryReference<K,V>
Type Parameters:
K - The type of the registry key.
V - The type of the registered value.
Record Components:
key - The key the value was registered with.
value - A supplier that produces the registered value.
public record RegistryReference<K,V>(K key, CachedSupplier<V> value) extends Record
Represents an entry in a game registry.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RegistryReference(K key, CachedSupplier<V> value)
    Creates an instance of a RegistryReference 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.
    K
    key()
    Returns the value of the key record component.
    static <V> RegistryReference<net.minecraft.resources.Identifier, V>
    location(net.minecraft.resources.Identifier key, CachedSupplier<V> value)
    A helper method that produces a reference for a registry that uses Identifier based keys.
    static <V> RegistryReference<net.minecraft.resources.ResourceKey<V>, V>
    resource(net.minecraft.core.Registry<V> registry, net.minecraft.resources.Identifier key, CachedSupplier<V> value)
    A helper method that produces a reference for a registry that uses ResourceKey.
    static <V> RegistryReference<net.minecraft.resources.ResourceKey<V>, V>
    resource(net.minecraft.resources.ResourceKey<? extends net.minecraft.core.Registry<V>> registryKey, net.minecraft.resources.Identifier key, CachedSupplier<V> value)
    A helper method that produces a reference for a registry that uses ResourceKey.
    static <V> RegistryReference<net.minecraft.resources.ResourceKey<V>, V>
    resource(net.minecraft.resources.ResourceKey<V> key)
    A helper method that produces a reference for a registry that uses ResourceKey.
    final String
    toString()
    Returns a string representation of this record class.
    CachedSupplier<V>
    value()
    Returns the value of the value record component.

    Methods inherited from class Object

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

  • Constructor Details

    • RegistryReference

      public RegistryReference(K key, CachedSupplier<V> value)
      Creates an instance of a RegistryReference record class.
      Parameters:
      key - the value for the key record component
      value - the value for the value record component

  • Method Details

    • location

      public static <V> RegistryReference<net.minecraft.resources.Identifier, V> location(net.minecraft.resources.Identifier key, CachedSupplier<V> value)
      A helper method that produces a reference for a registry that uses Identifier based keys.
      Type Parameters:
      V - The type of the registered value.
      Parameters:
      key - The key the value was registered with.
      value - A supplier that produces the registered value.
      Returns:
      A reference to the registry entry.

    • resource

      public static <V> RegistryReference<net.minecraft.resources.ResourceKey<V>, V> resource(net.minecraft.resources.ResourceKey<V> key)
      A helper method that produces a reference for a registry that uses ResourceKey.
      Type Parameters:
      V - The type of the value held in the registry.
      Parameters:
      key - The key to lookup.
      Returns:
      A reference to a value in a registry.

    • resource

      public static <V> RegistryReference<net.minecraft.resources.ResourceKey<V>, V> resource(net.minecraft.resources.ResourceKey<? extends net.minecraft.core.Registry<V>> registryKey, net.minecraft.resources.Identifier key, CachedSupplier<V> value)
      A helper method that produces a reference for a registry that uses ResourceKey.
      Type Parameters:
      V - The type of the registered value.
      Parameters:
      registryKey - The key for the registry the value is registered in.
      key - The key the value was registered with.
      value - A supplier that produces the registered value.
      Returns:
      A reference to the registry entry.

    • resource

      public static <V> RegistryReference<net.minecraft.resources.ResourceKey<V>, V> resource(net.minecraft.core.Registry<V> registry, net.minecraft.resources.Identifier key, CachedSupplier<V> value)
      A helper method that produces a reference for a registry that uses ResourceKey.
      Type Parameters:
      V - The type of the registered value.
      Parameters:
      registry - The registry the value is registered in.
      key - The key the value was registered with.
      value - A supplier that produces the registered value.
      Returns:
      A reference to the registry entry.

    • toString

      public final 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.

    • key

      public K key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • value

      public CachedSupplier<V> value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component