Package cn.lunadeer.dominion.events.group

Class GroupSetFlagEvent

java.lang.Object

org.bukkit.event.Event

cn.lunadeer.dominion.events.CallableEvent

cn.lunadeer.dominion.events.ResultEvent

cn.lunadeer.dominion.events.group.GroupSetFlagEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class GroupSetFlagEvent
extends ResultEvent

Event triggered when group's flag is changed.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
GroupSetFlagEvent(@NotNull org.bukkit.command.CommandSender operator, @NotNull DominionDTO dominion, @NotNull GroupDTO group, @NotNull PriFlag flag, boolean newValue)	Constructs a new GroupSetFlagEvent.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	afterSet(Consumer<GroupDTO> consumer)	Call back after the group is set.
@NotNull DominionDTO	getDominion()	Gets the dominion to which the group belongs.
PriFlag	getFlag()	Gets the flag being set.
CompletableFuture<GroupDTO>	getFutureToComplete()	Gets the CompletableFuture that will be completed with the GroupDTO.
GroupDTO	getGroup()	Gets the group for which the flag is being set.
boolean	getNewValue()	Gets the new value of the flag.
boolean	getOldValue()	Gets the old value of the flag.
void	setNewValue(boolean newValue)	Sets the new value of the flag.

Methods inherited from class cn.lunadeer.dominion.events.ResultEvent

getOperator, isCancelled, setCancelled

Methods inherited from class cn.lunadeer.dominion.events.CallableEvent

call, getHandlerList, getHandlers

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

GroupSetFlagEvent

public GroupSetFlagEvent(@NotNull
 @NotNull org.bukkit.command.CommandSender operator,
 @NotNull
 @NotNull DominionDTO dominion,
 @NotNull
 @NotNull GroupDTO group,
 @NotNull
 @NotNull PriFlag flag,
 boolean newValue)

Constructs a new GroupSetFlagEvent.

Parameters:

operator - the command sender who initiated the event

dominion - the dominion to which the group belongs

group - the group for which the flag is being set

flag - the flag being set

newValue - the new value of the flag

Method Details

getDominion

@NotNull
public @NotNull DominionDTO getDominion()

Gets the dominion to which the group belongs.

Returns:

the dominion

getFlag

public PriFlag getFlag()

Gets the flag being set.

Returns:

the flag

getOldValue

public boolean getOldValue()

Gets the old value of the flag.

Returns:

the old value of the flag

getNewValue

public boolean getNewValue()

Gets the new value of the flag.

Returns:

the new value of the flag

setNewValue

public void setNewValue(boolean newValue)

Sets the new value of the flag.

Parameters:

newValue - the new value to set

getGroup

public GroupDTO getGroup()

Gets the group for which the flag is being set.

Returns:

the group

getFutureToComplete

public CompletableFuture<GroupDTO> getFutureToComplete()

Gets the CompletableFuture that will be completed with the GroupDTO.

Under most circumstances, you should not need to use this method directly. If you need to perform actions after the group is set, you should use the afterSet(Consumer) method instead.

Returns:

the CompletableFuture to be completed

afterSet

public CompletableFuture<Void> afterSet(Consumer<GroupDTO> consumer)

Call back after the group is set.

Use this method to perform actions after the group has been set (may fail), if you need to do something with the set group,

Parameters:

consumer - the consumer to handle the set group

Returns:

a CompletableFuture that completes when the consumer has been executed