Package com.palmergames.bukkit.towny.object.inviteobjects

Class PlayerJoinTownInvite

java.lang.Object

com.palmergames.bukkit.towny.object.inviteobjects.PlayerJoinTownInvite

All Implemented Interfaces:

Invite

public class PlayerJoinTownInvite
extends Object

Constructor Summary

Constructors

Constructor	Description
PlayerJoinTownInvite(org.bukkit.command.CommandSender directSender, Resident receiver, Town sender)

Method Summary

Modifier and Type	Method	Description
void	accept()	Runs the accept code for the given invitation.
void	decline(boolean fromSender)	Runs the reject code for the given invitation.
boolean	equals(Object o)
@Nullable org.bukkit.command.CommandSender	getDirectSender()	Gets the sender of the invitation
Resident	getReceiver()	Gets the receiver of the invitation.
Town	getSender()	Gets the sender of the invitation.
@NotNull String	getSenderName()
@Nullable UUID	getSenderUUID()
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Details

PlayerJoinTownInvite

public PlayerJoinTownInvite(org.bukkit.command.CommandSender directSender,
 Resident receiver,
 Town sender)

Method Details

accept

public void accept()
            throws TownyException

Description copied from interface: Invite

Runs the accept code for the given invitation.

Throws:

TownyException - Sends errors back up to be processed by the caller.

decline

public void decline(boolean fromSender)

Description copied from interface: Invite

Runs the reject code for the given invitation.

Parameters:

fromSender - Tells if invite was revoked (true) or declined (false).

getDirectSender

@Nullable
public @Nullable org.bukkit.command.CommandSender getDirectSender()

Description copied from interface: Invite

Gets the sender of the invitation

Specified by:

getDirectSender in interface Invite

Returns:

The CommandSender of the invitation, or null if the sender is a player and not online.

getSenderName

@NotNull
public @NotNull String getSenderName()

Specified by:

getSenderName in interface Invite

Returns:

The sender's name, or 'CONSOLE' if the invitation was sent by console.

getSenderUUID

@Nullable
public @Nullable UUID getSenderUUID()

Specified by:

getSenderUUID in interface Invite

Returns:

The sender's uuid, or null if the invitation was sent by console.

getReceiver

public Resident getReceiver()

Description copied from interface: Invite

Gets the receiver of the invitation.

Specified by:

getReceiver in interface Invite

Returns:

The InviteReceiver object receiving the invite.

getSender

public Town getSender()

Description copied from interface: Invite

Gets the sender of the invitation.

Specified by:

getSender in interface Invite

Returns:

The InviteSender object that sent the invite.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object