org.geysermc.floodgate.command

Class WhitelistCommand

java.lang.Object

org.geysermc.floodgate.command.WhitelistCommand

All Implemented Interfaces:

FloodgateCommand

public class WhitelistCommand
extends Object
implements FloodgateCommand

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WhitelistCommand.Message

Constructor Summary

Constructors

Constructor and Description
WhitelistCommand()

Method Summary

Modifier and Type	Method and Description
cloud.commandframework.Command<UserAudience>	buildCommand(cloud.commandframework.CommandManager<UserAudience> commandManager) Called by the CommandRegister when it wants you to build the command which he can add.
void	execute(cloud.commandframework.context.CommandContext<UserAudience> context) Called when the command created in FloodgateCommand.buildCommand(CommandManager) is executed.
void	performCommand(cloud.commandframework.context.CommandContext<UserAudience> context, boolean add)
boolean	shouldRegister(FloodgateConfig config) Called by the CommandRegister to check if the command should be added given the config.

Methods inherited from class java.lang.Object

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

Constructor Detail

WhitelistCommand

public WhitelistCommand()

Method Detail

buildCommand

public cloud.commandframework.Command<UserAudience> buildCommand(cloud.commandframework.CommandManager<UserAudience> commandManager)

Description copied from interface: FloodgateCommand

Called by the CommandRegister when it wants you to build the command which he can add.

Specified by:

buildCommand in interface FloodgateCommand

Parameters:

commandManager - the manager to create a command

Returns:

the command to register

performCommand

public void performCommand(cloud.commandframework.context.CommandContext<UserAudience> context,
                           boolean add)

execute

public void execute(cloud.commandframework.context.CommandContext<UserAudience> context)

Description copied from interface: FloodgateCommand

Called when the command created in FloodgateCommand.buildCommand(CommandManager) is executed.

Specified by:

execute in interface FloodgateCommand

Parameters:

context - the context of the executed command

shouldRegister

public boolean shouldRegister(FloodgateConfig config)

Description copied from interface: FloodgateCommand

Called by the CommandRegister to check if the command should be added given the config.

Specified by:

shouldRegister in interface FloodgateCommand

Parameters:

config - the config to check if a command should be added

Returns:

true if it should be added