io.github.bananapuncher714.cartographer.core.api.command

Class SubCommand

java.lang.Object

io.github.bananapuncher714.cartographer.core.api.command.SubCommand

public class SubCommand
extends java.lang.Object

A build and run command framework for automatic tab completions and easy branching. TODO Make a builder for this or something.

Author:

BananaPuncher714

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<SenderValidator>	senderValidators
protected java.util.List<SubCommand>	subCommands
protected InputValidator<?>	validator
protected CommandExecutable	whenNone
protected CommandExecutable	whenUnknown

Constructor Summary

Constructors

Constructor and Description
SubCommand() Accept anything as a valid input
SubCommand(InputValidator<?> validator) Create a SubCommand with the input validator provided.
SubCommand(java.lang.String command) Create a SubCommand with the string as the input validator.

Method Summary

Modifier and Type	Method and Description
SubCommand	add(SubCommand builder)
SubCommand	addSenderValidator(SenderValidator validator)
SubCommand	applyTo(org.bukkit.command.PluginCommand command)
SubCommand	defaultTo(CommandExecutable executable) Ran when there are no arguments provided, or if the executable for when unknown is not set.
InputValidator<?>	getInputValidator()
java.util.Set<SenderValidator>	getSenderValidators()
java.util.List<SubCommand>	getSubCommands()
java.util.Collection<java.lang.String>	getTabCompletes()
java.util.Collection<java.lang.String>	getTabCompletions(org.bukkit.command.CommandSender sender, java.lang.String[] args)
boolean	matches(org.bukkit.command.CommandSender sender)
boolean	matches(org.bukkit.command.CommandSender sender, java.lang.String input, java.lang.String[] args)
boolean	matches(java.lang.String input, java.lang.String[] args)
CommandResult	submit(org.bukkit.command.CommandSender sender, java.lang.String command, java.lang.String[] args, CommandParameters parameter)
SubCommand	whenUnknown(CommandExecutable executable) Ran when the arguments provided don't match any SubCommands registered.

Methods inherited from class java.lang.Object

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

Field Detail

subCommands

protected java.util.List<SubCommand> subCommands

validator

protected InputValidator<?> validator

senderValidators

protected java.util.Set<SenderValidator> senderValidators

whenUnknown

protected CommandExecutable whenUnknown

whenNone

protected CommandExecutable whenNone

Constructor Detail

SubCommand

public SubCommand()

Accept anything as a valid input

SubCommand

public SubCommand(java.lang.String command)

Create a SubCommand with the string as the input validator.

Parameters:

command - The subcommand value.

SubCommand

public SubCommand(InputValidator<?> validator)

Create a SubCommand with the input validator provided.

Parameters:

validator - Can be null.

Method Detail

add

public SubCommand add(SubCommand builder)

addSenderValidator

public SubCommand addSenderValidator(SenderValidator validator)

whenUnknown

public SubCommand whenUnknown(CommandExecutable executable)

Ran when the arguments provided don't match any SubCommands registered.

Parameters:

executable - An executable where the arguments will start with the unknown subcommand.

Returns:

Builder pattern return.

defaultTo

public SubCommand defaultTo(CommandExecutable executable)

Ran when there are no arguments provided, or if the executable for when unknown is not set.

Parameters:

executable - If null, nothing will happen.

Returns:

Builder pattern return.

matches

public boolean matches(org.bukkit.command.CommandSender sender)

matches

public boolean matches(java.lang.String input,
                       java.lang.String[] args)

matches

public boolean matches(org.bukkit.command.CommandSender sender,
                       java.lang.String input,
                       java.lang.String[] args)

getTabCompletes

public java.util.Collection<java.lang.String> getTabCompletes()

getSubCommands

public java.util.List<SubCommand> getSubCommands()

getInputValidator

public InputValidator<?> getInputValidator()

getSenderValidators

public java.util.Set<SenderValidator> getSenderValidators()

submit

public CommandResult submit(org.bukkit.command.CommandSender sender,
                            java.lang.String command,
                            java.lang.String[] args,
                            CommandParameters parameter)

getTabCompletions

public java.util.Collection<java.lang.String> getTabCompletions(org.bukkit.command.CommandSender sender,
                                                                java.lang.String[] args)

applyTo

public SubCommand applyTo(org.bukkit.command.PluginCommand command)