Package cn.lunadeer.dominion.events.member

Class MemberAddedEvent

java.lang.Object

org.bukkit.event.Event

cn.lunadeer.dominion.events.CallableEvent

cn.lunadeer.dominion.events.ResultEvent

cn.lunadeer.dominion.events.member.MemberAddedEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class MemberAddedEvent
extends ResultEvent

Event triggered when a member is added to 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
MemberAddedEvent(@NotNull org.bukkit.command.CommandSender operator, @NotNull DominionDTO dominion, @NotNull PlayerDTO player)	Constructs a new MemberAddedEvent.

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.
CompletableFuture<MemberDTO>	getFutureToComplete()	Gets the CompletableFuture that will be completed with the added MemberDTO.
@Nullable MemberDTO	getMember()	Deprecated, for removal: This API element is subject to removal in a future version.
@NotNull PlayerDTO	getPlayer()	Gets the player.
void	setDominion(@NotNull DominionDTO dominion)	Sets the dominion.
void	setMember(@Nullable MemberDTO member)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setPlayer(@NotNull PlayerDTO player)	Sets the player.

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

MemberAddedEvent

public MemberAddedEvent(@NotNull
 @NotNull org.bukkit.command.CommandSender operator,
 @NotNull
 @NotNull DominionDTO dominion,
 @NotNull
 @NotNull PlayerDTO player)

Constructs a new MemberAddedEvent.

Parameters:

operator - the command sender who initiated the event

dominion - the dominion to which the member is added

player - the player record being added as a member

Method Details

setDominion

public void setDominion(@NotNull
 @NotNull DominionDTO dominion)

Sets the dominion.

Parameters:

dominion - the dominion to set

getDominion

@NotNull
public @NotNull DominionDTO getDominion()

Gets the dominion.

Returns:

the dominion

setPlayer

public void setPlayer(@NotNull
 @NotNull PlayerDTO player)

Sets the player.

Parameters:

player - the player to set

getPlayer

@NotNull
public @NotNull PlayerDTO getPlayer()

Gets the player.

Returns:

the player

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 future; its result is the added member, or null when the operation fails

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 (the callback receives null when the operation fails).

Parameters:

consumer - the consumer to handle the added member

Returns:

a future that completes when the consumer has been executed

setMember

@Deprecated(since="4.6.0",
            forRemoval=true)
public void setMember(@Nullable
 @Nullable MemberDTO member)

Deprecated, for removal: This API element is subject to removal in a future version.

This compatibility method does nothing.

Parameters:

member - ignored

getMember

@Deprecated(since="4.6.0",
            forRemoval=true)
@Nullable
public @Nullable MemberDTO getMember()

Deprecated, for removal: This API element is subject to removal in a future version.

This compatibility method always returns null. Use afterAdded(Consumer) to observe the asynchronous result.

Returns:

always null