Package cn.lunadeer.dominion.events.group

Class GroupAddMemberEvent

java.lang.Object

org.bukkit.event.Event

cn.lunadeer.dominion.events.CallableEvent

cn.lunadeer.dominion.events.ResultEvent

cn.lunadeer.dominion.events.group.GroupAddMemberEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class GroupAddMemberEvent
extends ResultEvent

Event triggered when a member is added to a group within a dominion.

Nested Class Summary

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

org.bukkit.event.Event.Result

Constructor Summary

Constructors

Constructor	Description
GroupAddMemberEvent(@NotNull org.bukkit.command.CommandSender operator, @NotNull DominionDTO dominion, @NotNull GroupDTO group, @NotNull MemberDTO member)	Constructs a new GroupAddMemberEvent.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	afterAdded(Consumer<MemberDTO> consumer)	Call back after the member is added.
@NotNull DominionDTO	getDominion()	Gets the dominion to which the group belongs.
CompletableFuture<MemberDTO>	getFutureToComplete()	Gets the CompletableFuture that will be completed with the added MemberDTO.
@NotNull GroupDTO	getGroup()	Gets the group to which the member is being added.
@NotNull MemberDTO	getMember()	Gets the member being added to the group.
void	setMember(@NotNull MemberDTO member)	Sets the member being added to the group.

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

GroupAddMemberEvent

public GroupAddMemberEvent(@NotNull
 @NotNull org.bukkit.command.CommandSender operator,
 @NotNull
 @NotNull DominionDTO dominion,
 @NotNull
 @NotNull GroupDTO group,
 @NotNull
 @NotNull MemberDTO member)

Constructs a new GroupAddMemberEvent.

Parameters:

operator - the command sender who initiated the event

dominion - the dominion to which the group belongs

group - the group to which the member is being added

member - the member being added to the group

Method Details

getGroup

@NotNull
public @NotNull GroupDTO getGroup()

Gets the group to which the member is being added.

Returns:

the group

getMember

@NotNull
public @NotNull MemberDTO getMember()

Gets the member being added to the group.

This method returns the member that will be added to the group. If you want to get the member after it has been added (which may fail), you should use the afterAdded(Consumer) method instead.

Returns:

the member

setMember

public void setMember(@NotNull
 @NotNull MemberDTO member)

Sets the member being added to the group.

Parameters:

member - the member to set

getDominion

@NotNull
public @NotNull DominionDTO getDominion()

Gets the dominion to which the group belongs.

Returns:

the dominion

getFutureToComplete

public CompletableFuture<MemberDTO> getFutureToComplete()

Gets the CompletableFuture that will be completed with the added MemberDTO.

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

Returns:

the CompletableFuture to be completed

afterAdded

public CompletableFuture<Void> afterAdded(Consumer<MemberDTO> consumer)

Call back after the member is added.

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

Parameters:

consumer - the consumer to handle the created member

Returns:

a CompletableFuture that completes when the consumer has been executed