Class ModulePreStopEvent

java.lang.Object

eu.cloudnetservice.driver.event.Event

eu.cloudnetservice.driver.event.events.module.ModuleEvent

eu.cloudnetservice.driver.event.events.module.ModulePreStopEvent

All Implemented Interfaces:

Cancelable

public final class ModulePreStopEvent
extends ModuleEvent
implements Cancelable

This event is being called before a module has been stopped and the tasks with the lifecycle ModuleLifeCycle.STOPPED of this module have been fired. ModuleWrapper.moduleLifeCycle() is still ModuleLifeCycle.STARTED or ModuleLifeCycle.LOADED.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	cancelled

Constructor Summary

Constructors

Constructor	Description
ModulePreStopEvent(@NonNull ModuleProvider moduleProvider, @NonNull ModuleWrapper module)	Constructs a new module pre stop event.

Method Summary

Modifier and Type	Method	Description
boolean	cancelled()	Gets the cancellation state of the event.
void	cancelled(boolean value)	Marks this event as cancelled and stops the execution of the representing change in the system.

Methods inherited from class eu.cloudnetservice.driver.event.events.module.ModuleEvent

module, moduleProvider

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

cancelled

private boolean cancelled

Constructor Details

ModulePreStopEvent

public ModulePreStopEvent(@NonNull
 @NonNull ModuleProvider moduleProvider,
 @NonNull
 @NonNull ModuleWrapper module)

Constructs a new module pre stop event.

Parameters:

moduleProvider - the provider in which the module is loaded.

module - the module which is associated with this event.

Throws:

NullPointerException - if either the provider or wrapper is null.

Method Details

cancelled

public boolean cancelled()

Gets the cancellation state of the event. A cancelled event will stop the execution of the representing change in the system, but will be passed to all event listeners nevertheless.

Specified by:

cancelled in interface Cancelable

Returns:

true if this is cancelled, false otherwise.

cancelled

public void cancelled(boolean value)

Marks this event as cancelled and stops the execution of the representing change in the system. The event will be passed to other event listeners down the line anyway.

Specified by:

cancelled in interface Cancelable

Parameters:

value - true if this event should get marked as cancelled, false otherwise.