Record Class ReloadEvent

java.lang.Object
java.lang.Record
net.flectone.pulse.model.event.lifecycle.ReloadEvent
Record Components:
cancelled - whether a listener vetoed the remaining reload work
type - the phase of the reload cycle that this event represents
flectonePulse - the plugin instance
reloadException - the failure that occurred, or null if the reload succeeded
All Implemented Interfaces:
Event
public record ReloadEvent(boolean cancelled, ReloadEvent.Type type, FlectonePulse flectonePulse, @Nullable ReloadException reloadException) extends Record implements Event
Fired after a reload finishes, whether or not it succeeded.

  • Constructor Details

    • ReloadEvent

      public ReloadEvent(FlectonePulse flectonePulse, ReloadEvent.Type type, ReloadException reloadException)
      Creates an event that has not been cancelled.
      Parameters:
      flectonePulse - the plugin instance
      type - the phase of the reload cycle that this event represents
      reloadException - the failure that occurred, or null on success

    • ReloadEvent

      public ReloadEvent(FlectonePulse flectonePulse, ReloadEvent.Type type)
      Creates an event that has not been cancelled and represents a successful reload.
      Parameters:
      flectonePulse - the plugin instance
      type - the phase of the reload cycle that this event represents

    • ReloadEvent

      public ReloadEvent(boolean cancelled, ReloadEvent.Type type, FlectonePulse flectonePulse, @Nullable ReloadException reloadException)
      Creates an instance of a ReloadEvent record class.
      Parameters:
      cancelled - the value for the cancelled record component
      type - the value for the type record component
      flectonePulse - the value for the flectonePulse record component
      reloadException - the value for the reloadException record component

  • Method Details

    • isSuccessful

      public boolean isSuccessful()
      Whether the reload completed without a failure.
      Returns:
      true if no exception was recorded

    • withCancelled

      public ReloadEvent withCancelled(boolean cancelled)
      Description copied from interface: Event
      Returns a copy of this event with the cancelled flag set.
      Specified by:
      withCancelled in interface Event
      Parameters:
      cancelled - the new cancelled state
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withType

      public ReloadEvent withType(ReloadEvent.Type type)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withFlectonePulse

      public ReloadEvent withFlectonePulse(FlectonePulse flectonePulse)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withReloadException

      public ReloadEvent withReloadException(@Nullable ReloadException reloadException)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • cancelled

      public boolean cancelled()
      Returns the value of the cancelled record component.
      Specified by:
      cancelled in interface Event
      Returns:
      the value of the cancelled record component

    • type

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

    • flectonePulse

      public FlectonePulse flectonePulse()
      Returns the value of the flectonePulse record component.
      Returns:
      the value of the flectonePulse record component

    • reloadException

      public @Nullable ReloadException reloadException()
      Returns the value of the reloadException record component.
      Returns:
      the value of the reloadException record component