Package dev.jorel.commandapi.wrappers

Record Class ParticleData<T>

java.lang.Object
java.lang.Record
dev.jorel.commandapi.wrappers.ParticleData<T>
public record ParticleData<T>(org.bukkit.Particle particle, T data) extends Record
A data structure that stores a particle and its corresponding data (or null if no data is present)

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParticleData(org.bukkit.Particle particle, T data)
    Creates an instance of a ParticleData record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    data()
    Returns the value of the data record component.
    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.
    org.bukkit.Particle
    particle()
    Returns the value of the particle record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ParticleData

      public ParticleData(org.bukkit.Particle particle, T data)
      Creates an instance of a ParticleData record class.
      Parameters:
      particle - the value for the particle record component
      data - the value for the data 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.

    • particle

      public org.bukkit.Particle particle()
      Returns the value of the particle record component.
      Returns:
      the value of the particle record component

    • data

      public T data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component