Record Class ModuleEnableEvent

java.lang.Object
java.lang.Record
net.flectone.pulse.model.event.module.ModuleEnableEvent
Record Components:
cancelled - whether a listener vetoed the change
module - the module being enabled
All Implemented Interfaces:
Event, ModuleEvent
public record ModuleEnableEvent(boolean cancelled, ModuleSimple module) extends Record implements ModuleEvent
Fired before a module is switched on. Cancelling it keeps the module off.

  • Constructor Details

    • ModuleEnableEvent

      public ModuleEnableEvent(ModuleSimple module)
      Creates an event that has not been cancelled.
      Parameters:
      module - the module being enabled

    • ModuleEnableEvent

      public ModuleEnableEvent(boolean cancelled, ModuleSimple module)
      Creates an instance of a ModuleEnableEvent record class.
      Parameters:
      cancelled - the value for the cancelled record component
      module - the value for the module record component

  • Method Details

    • withCancelled

      public ModuleEnableEvent 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).

    • withModule

      public ModuleEnableEvent withModule(ModuleSimple module)
      Description copied from interface: ModuleEvent
      Returns a copy of this event for a different module.
      Specified by:
      withModule in interface ModuleEvent
      Parameters:
      module - the new module
      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

    • module

      public ModuleSimple module()
      Returns the value of the module record component.
      Specified by:
      module in interface ModuleEvent
      Returns:
      the value of the module record component