Package de.eldoria.jacksonbukkit.entities

Record Class FireworkEffectWrapper

java.lang.Object
java.lang.Record
de.eldoria.jacksonbukkit.entities.FireworkEffectWrapper
public record FireworkEffectWrapper(FireworkEffect.Type type, List<Color> colors, List<Color> fadeColors, boolean flicker, boolean trail) extends Record
Class for wrapping a FireworkEffect.

  • Constructor Details

    • FireworkEffectWrapper

      public FireworkEffectWrapper(FireworkEffect.Type type, List<Color> colors, List<Color> fadeColors, boolean flicker, boolean trail)
      Creates an instance of a FireworkEffectWrapper record class.
      Parameters:
      type - the value for the type record component
      colors - the value for the colors record component
      fadeColors - the value for the fadeColors record component
      flicker - the value for the flicker record component
      trail - the value for the trail record component

  • Method Details

    • of

      public static FireworkEffectWrapper of(FireworkEffect fireworkEffect)
      Create a new FireworkEffectWrapper based on a FireworkEffect.
      Parameters:
      fireworkEffect - firework effect instance
      Returns:
      new FireworkEffectWrapper instance

    • toFireworkEffect

      public FireworkEffect toFireworkEffect()
      Constructs a new FireworkEffect based on wrapper values.
      Returns:
      new FireworkEffect instance

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • type

      public FireworkEffect.Type type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • colors

      public List<Color> colors()
      Returns the value of the colors record component.
      Returns:
      the value of the colors record component

    • fadeColors

      public List<Color> fadeColors()
      Returns the value of the fadeColors record component.
      Returns:
      the value of the fadeColors record component

    • flicker

      public boolean flicker()
      Returns the value of the flicker record component.
      Returns:
      the value of the flicker record component

    • trail

      public boolean trail()
      Returns the value of the trail record component.
      Returns:
      the value of the trail record component