Record Class EnableEvent

java.lang.Object
java.lang.Record
net.flectone.pulse.model.event.lifecycle.EnableEvent
Record Components:
cancelled - whether a listener vetoed the remaining startup work
type - the startup stage
flectonePulse - the plugin instance
All Implemented Interfaces:
Event
public record EnableEvent(boolean cancelled, EnableEvent.Type type, FlectonePulse flectonePulse) extends Record implements Event
Fired while the plugin starts up, once per EnableEvent.Type stage.

  • Constructor Details

    • EnableEvent

      public EnableEvent(EnableEvent.Type type, FlectonePulse flectonePulse)
      Creates an event that has not been cancelled.
      Parameters:
      type - the startup stage
      flectonePulse - the plugin instance

    • EnableEvent

      public EnableEvent(boolean cancelled, EnableEvent.Type type, FlectonePulse flectonePulse)
      Creates an instance of a EnableEvent 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

  • Method Details

    • withCancelled

      public EnableEvent 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 EnableEvent withType(EnableEvent.Type type)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withFlectonePulse

      public EnableEvent withFlectonePulse(FlectonePulse flectonePulse)
      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 EnableEvent.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