dev.jorel.commandapi.CommandAPICommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commandapi-bukkit-shade-mojang-mapped Show documentation

There is a newer version: 9.5.3

Show newest version

package dev.jorel.commandapi;

import dev.jorel.commandapi.arguments.Argument;

import java.util.Optional;

import org.bukkit.command.CommandSender;
import org.bukkit.help.HelpTopic;
import org.bukkit.plugin.java.JavaPlugin;

public class CommandAPICommand extends AbstractCommandAPICommand, CommandSender> implements BukkitExecutable {
	
	public CommandAPICommand(CommandMetaData meta) {
		super(meta);
	}
	
	public CommandAPICommand(String commandName) {
		super(commandName);
	}

	@Override
	protected CommandAPICommand newConcreteCommandAPICommand(CommandMetaData metaData) {
		return new CommandAPICommand(metaData);
	}

	@Override
	public CommandAPICommand instance() {
		return this;
	}
	
	/**
	 * Sets the {@link HelpTopic} for this command. Using this method will override
	 * any declared short description, full description or usage description provided
	 * via the following methods:
	 * 
	 *   {@link CommandAPICommand#withShortDescription(String)}
	 *   {@link CommandAPICommand#withFullDescription(String)}
	 *   {@link CommandAPICommand#withUsage(String...)}
	 *   {@link CommandAPICommand#withHelp(String, String)}
	 * 
	 * @param helpTopic the help topic to use for this command
	 * @return this command builder
	 */
	public CommandAPICommand withHelp(HelpTopic helpTopic) {
		this.meta.helpTopic = Optional.of(helpTopic);
		return instance();
	}

	/**
	 * Registers the command with a given namespace
	 *
	 * @param namespace The namespace of this command. This cannot be null or empty
	 *
	 */
	public void register(String namespace) {
		if (CommandAPIBukkit.get().isInvalidNamespace(this.meta.commandName, namespace)) {
			super.register();
			return;
		}
		super.register(namespace);
	}

	/**
	 * Registers this command with a given {@link JavaPlugin} instance
	 *
	 * @param plugin The plugin instance used to determine this command's namespace
	 */
	public void register(JavaPlugin plugin) {
		super.register(plugin.getName().toLowerCase());
	}
}