Package org.core.command.commands.timings

Class TimingsCommand

java.lang.Object

org.core.command.commands.timings.TimingsCommand

All Implemented Interfaces:

ArgumentCommand

public class TimingsCommand
extends Object
implements ArgumentCommand

Constructor Summary

Constructors

Constructor	Description
TimingsCommand()

Method Summary

Modifier and Type	Method	Description
List<CommandArgument<?>>	getArguments()	Gets the arguments of the command.
String	getDescription()	Gets a description of the command, designing to inform the user on what the command does.
Optional<Permission>	getPermissionNode()	Gets the permission node of the command that is required to run the command.
boolean	run(CommandContext commandContext, String... args)	Runs the command

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.core.command.argument.ArgumentCommand

hasPermission

Constructor Details

TimingsCommand

public TimingsCommand()

Method Details

getArguments

public List<CommandArgument<?>> getArguments()

Description copied from interface: ArgumentCommand

Gets the arguments of the command. This should be a list of arguments that do not change

Specified by:

getArguments in interface ArgumentCommand

Returns:

A list of command arguments

getDescription

public String getDescription()

Description copied from interface: ArgumentCommand

Gets a description of the command, designing to inform the user on what the command does.

Specified by:

getDescription in interface ArgumentCommand

Returns:

A string of the description

getPermissionNode

public Optional<Permission> getPermissionNode()

Description copied from interface: ArgumentCommand

Gets the permission node of the command that is required to run the command. If a permission is not required then this should return Optional.empty()

When checking to see if this command has permission you should use ArgumentCommand.hasPermission(CommandSource)

Specified by:

getPermissionNode in interface ArgumentCommand

Returns:

The permission to the command

run

public boolean run(CommandContext commandContext,
 String... args)
            throws NotEnoughArguments

Description copied from interface: ArgumentCommand

Runs the command

Specified by:

run in interface ArgumentCommand

Parameters:

commandContext - The command context for this command

args - The arguments for the command

Returns:

if the command should show the usage (false to show)

Throws:

NotEnoughArguments - If the arguments provided are not enough for the command, this will throw