Package org.skriptlang.skript.bukkit.particles.registration

Record Class EffectInfo<E,D>

java.lang.Object
java.lang.Record
org.skriptlang.skript.bukkit.particles.registration.EffectInfo<E,D>
Type Parameters:
E - The type of effect
D - The type of data required by the particle
Record Components:
effect - The effect type
pattern - The pattern that can be used to parse this particle
dataSupplier - Function to supply data from parsed expressions
toStringFunction - Function to convert the particle and data to a string representation
public record EffectInfo<E,D>(E effect, String pattern, DataSupplier<D> dataSupplier, ToString toStringFunction) extends Record
Information about a effect type that requires additional data.

  • Constructor Details

    • EffectInfo

      public EffectInfo(E effect, String pattern, DataSupplier<D> dataSupplier, ToString toStringFunction)
      Creates an instance of a EffectInfo record class.
      Parameters:
      effect - the value for the effect record component
      pattern - the value for the pattern record component
      dataSupplier - the value for the dataSupplier record component
      toStringFunction - the value for the toStringFunction 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.

    • effect

      public E effect()
      Returns the value of the effect record component.
      Returns:
      the value of the effect record component

    • pattern

      public String pattern()
      Returns the value of the pattern record component.
      Returns:
      the value of the pattern record component

    • dataSupplier

      public DataSupplier<D> dataSupplier()
      Returns the value of the dataSupplier record component.
      Returns:
      the value of the dataSupplier record component

    • toStringFunction

      public ToString toStringFunction()
      Returns the value of the toStringFunction record component.
      Returns:
      the value of the toStringFunction record component