GraphMine

graphmine-core / io.github.sof3.graphmine.command

Package io.github.sof3.graphmine.command

This package contains the API for declaring commands.

Types

Command abstract class Command<C : Scope>
This class represents a command type. Each instance of Command should represent one registered command.
CommandExecutor class CommandExecutor<A : Overload, S : CommandSender, C : Scope>
The this context of command handlers.
CommandMap class CommandMap
Stores a list of commands. This class can also be instantiated at individual commands to provide a sub-command list.
CommandReceiver interface CommandReceiver
Accepts output from a command.
CommandSender interface CommandSender
Represents an object that sends the command.
EmptyOverload class EmptyOverload : Overload
An empty overload, reused for commands that do not require arguments.
Overload abstract class Overload
Defines the parameters of a command.
RegisteredOverload class RegisteredOverload : I18nable
A factory that creates a new instance of a known command overload for each command execution.

Exceptions

CommandException abstract class CommandException : Exception, I18nable
Represents any user-friendly errors reported from commands.
WrongSyntaxException class WrongSyntaxException : CommandException
Thrown when a command with wrong syntax is sent.