Package org.geysermc.geyser.level.block

Record Class GeyserCustomBlockProperty<T>

java.lang.Object
java.lang.Record
org.geysermc.geyser.level.block.GeyserCustomBlockProperty<T>
Type Parameters:
T - The type of the property
Record Components:
name - The name of the property
values - The values of the property
type - The type of the property
All Implemented Interfaces:
org.geysermc.geyser.api.block.custom.property.CustomBlockProperty<T>
public record GeyserCustomBlockProperty<T>(@NonNull String name, @NonNull List<T> values, @NonNull org.geysermc.geyser.api.block.custom.property.PropertyType type) extends Record implements org.geysermc.geyser.api.block.custom.property.CustomBlockProperty<T>
A custom block property that can be used to store custom data for a block.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GeyserCustomBlockProperty​(@NonNull String name, @NonNull List<T> values, @NonNull org.geysermc.geyser.api.block.custom.property.PropertyType type)
    Creates an instance of a GeyserCustomBlockProperty record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    hashCode()
    Returns a hash code value for this object.
    @NonNull String
    name()
    Returns the value of the name record component.
    String
    toString()
    Returns a string representation of this record class.
    @NonNull org.geysermc.geyser.api.block.custom.property.PropertyType
    type()
    Returns the value of the type record component.
    @NonNull List<T>
    values()
    Returns the value of the values record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • GeyserCustomBlockProperty

      public GeyserCustomBlockProperty​(@NonNull String name, @NonNull List<T> values, @NonNull org.geysermc.geyser.api.block.custom.property.PropertyType type)
      Creates an instance of a GeyserCustomBlockProperty record class.
      Parameters:
      name - the value for the name record component
      values - the value for the values record component
      type - the value for the type record component

  • Method Details

    • 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.

    • name

      public @NonNull String name()
      Returns the value of the name record component.
      Specified by:
      name in interface org.geysermc.geyser.api.block.custom.property.CustomBlockProperty<T>
      Returns:
      the value of the name record component

    • values

      public @NonNull List<T> values()
      Returns the value of the values record component.
      Specified by:
      values in interface org.geysermc.geyser.api.block.custom.property.CustomBlockProperty<T>
      Returns:
      the value of the values record component

    • type

      public @NonNull org.geysermc.geyser.api.block.custom.property.PropertyType type()
      Returns the value of the type record component.
      Specified by:
      type in interface org.geysermc.geyser.api.block.custom.property.CustomBlockProperty<T>
      Returns:
      the value of the type record component