mods.thecomputerizer.theimpossiblelibrary.api.server

Class CommandAPI

java.lang.Object

mods.thecomputerizer.theimpossiblelibrary.api.server.CommandAPI

public abstract class CommandAPI
extends java.lang.Object

Needs to be registered while the server is starting up (call MinecraftServerAPI#registerCommand to register it)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandAPI.ArgType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object[]	exceptionArgs
protected java.lang.String	exceptionKey
protected boolean	executionNode
protected java.lang.String	name
protected CommandAPI	parent
protected java.util.Collection<CommandAPI>	subCommands
protected CommandAPI.ArgType	type

Constructor Summary

Constructors

Constructor and Description
CommandAPI(java.lang.String name, CommandAPI parent, CommandAPI.ArgType type, boolean executionNode)

Method Summary

Modifier and Type	Method and Description
void	addBasicSubCommand(java.lang.String name, CommandAPI.ArgType type, org.apache.logging.log4j.util.TriConsumer<MinecraftServerAPI<?>,CommandSenderAPI<?>,java.lang.String[]> executor)
void	addSubCommand(CommandAPI cmd)
protected void	buildStack(java.util.List<CommandAPI> stack)
abstract void	execute(MinecraftServerAPI<?> server, CommandSenderAPI<?> sender, java.lang.String input, java.lang.String remaining)
void	execute(java.lang.Object unwrappedSender, java.lang.String input, java.lang.String remaining)
protected java.lang.String	getErrorKey(java.lang.String... extras)
protected java.lang.String	getMessageKey(java.lang.String... keys)
CommandAPI	getRoot()
java.lang.String	getRootName()
CommandSenderAPI<?>	getSender(java.lang.Object sender)
MinecraftServerAPI<?>	getServer()
java.util.List<CommandAPI>	getStack()
java.util.List<CommandAPI>	getStackReverse()
abstract java.util.List<java.lang.String>	getTabCompletions(MinecraftServerAPI<?> server, CommandSenderAPI<?> sender, java.lang.String input, java.lang.String remaining)
java.util.List<java.lang.String>	getTabCompletions(java.lang.Object unwrappedSender, java.lang.String input, java.lang.String remaining)
protected java.lang.String	getUsageKey()
protected boolean	hasParentInput(java.lang.String input)
boolean	isValidInput(java.lang.String input)
protected boolean	isValidNumber(java.lang.String input, java.util.function.Function<java.lang.String,java.lang.Number> func)
protected boolean	isValidString(java.lang.String input) Only string type commands should override this
<T> T	parseArgAs(java.lang.Object[] arg, java.lang.Class<T> ignored) The actual unparsed string should be the last element in the array after the server or whatever else is needed to parse it correctly.
abstract void	prepareExceptionInfo()
<E> E	unwrapEntity(CommandSenderAPI<?> sender)

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected final CommandAPI parent

name

protected final java.lang.String name

type

protected final CommandAPI.ArgType type

executionNode

protected final boolean executionNode

subCommands

protected final java.util.Collection<CommandAPI> subCommands

exceptionKey

protected java.lang.String exceptionKey

exceptionArgs

protected java.lang.Object[] exceptionArgs

Constructor Detail

CommandAPI

public CommandAPI(java.lang.String name,
                  CommandAPI parent,
                  CommandAPI.ArgType type,
                  boolean executionNode)

Method Detail

addBasicSubCommand

public void addBasicSubCommand(java.lang.String name,
                               CommandAPI.ArgType type,
                               org.apache.logging.log4j.util.TriConsumer<MinecraftServerAPI<?>,CommandSenderAPI<?>,java.lang.String[]> executor)

addSubCommand

public void addSubCommand(CommandAPI cmd)

buildStack

protected void buildStack(java.util.List<CommandAPI> stack)

execute

public void execute(java.lang.Object unwrappedSender,
                    java.lang.String input,
                    java.lang.String remaining)
             throws java.lang.Exception

Throws:

java.lang.Exception

execute

public abstract void execute(MinecraftServerAPI<?> server,
                             CommandSenderAPI<?> sender,
                             java.lang.String input,
                             java.lang.String remaining)
                      throws java.lang.Exception

Throws:

java.lang.Exception

getErrorKey

protected java.lang.String getErrorKey(java.lang.String... extras)

getMessageKey

protected java.lang.String getMessageKey(java.lang.String... keys)

getRoot

public CommandAPI getRoot()

getRootName

public java.lang.String getRootName()

getSender

public CommandSenderAPI<?> getSender(java.lang.Object sender)

getServer

public MinecraftServerAPI<?> getServer()

getStack

public java.util.List<CommandAPI> getStack()

getStackReverse

public java.util.List<CommandAPI> getStackReverse()

getTabCompletions

public java.util.List<java.lang.String> getTabCompletions(java.lang.Object unwrappedSender,
                                                          java.lang.String input,
                                                          java.lang.String remaining)

getTabCompletions

public abstract java.util.List<java.lang.String> getTabCompletions(MinecraftServerAPI<?> server,
                                                                   CommandSenderAPI<?> sender,
                                                                   java.lang.String input,
                                                                   java.lang.String remaining)

getUsageKey

protected java.lang.String getUsageKey()

hasParentInput

protected boolean hasParentInput(java.lang.String input)

isValidInput

public boolean isValidInput(java.lang.String input)

isValidString

protected boolean isValidString(java.lang.String input)

Only string type commands should override this

isValidNumber

protected boolean isValidNumber(java.lang.String input,
                                java.util.function.Function<java.lang.String,java.lang.Number> func)

parseArgAs

public <T> T parseArgAs(java.lang.Object[] arg,
                        java.lang.Class<T> ignored)
                 throws java.lang.Exception

The actual unparsed string should be the last element in the array after the server or whatever else is needed to parse it correctly.

Throws:

java.lang.Exception

prepareExceptionInfo

public abstract void prepareExceptionInfo()

unwrapEntity

public <E> E unwrapEntity(CommandSenderAPI<?> sender)