vertx / io.vertx.ext.shell.command / CommandRegistry

CommandRegistry

interface CommandRegistry : CommandResolver

A registry that contains the commands known by a shell. It is a mutable command resolver.

Author
Julien Viet

Functions

create

open static fun create(vertx: Vertx): CommandRegistry

Create a new registry.

getShared

open static fun getShared(vertx: Vertx): CommandRegistry

Get the shared registry for the Vert.x instance.

registerCommand

abstract fun registerCommand(command: Class<out AnnotatedCommand>): CommandRegistry

Like #registerCommand(Class, Handler), without a completion handler.

abstract fun registerCommand(command: Class<out AnnotatedCommand>, completionHandler: Handler<AsyncResult<Command>>): CommandRegistry

Register a single command.

abstract fun registerCommand(command: Command): CommandRegistry

Like #registerCommand(Command, Handler), without a completion handler.

abstract fun registerCommand(command: Command, completionHandler: Handler<AsyncResult<Command>>): CommandRegistry

Register a command

registerCommands

abstract fun registerCommands(commands: MutableList<Command>): CommandRegistry

Like #registerCommands(List, Handler), without a completion handler.

abstract fun registerCommands(commands: MutableList<Command>, completionHandler: Handler<AsyncResult<MutableList<Command>>>): CommandRegistry

Register a list of commands.

unregisterCommand

abstract fun unregisterCommand(commandName: String): CommandRegistry

Like #unregisterCommand(String, Handler), without a completion handler.

abstract fun unregisterCommand(commandName: String, completionHandler: Handler<AsyncResult<Void>>): CommandRegistry

Unregister a command.