io.vertx.kotlin.ext.shell.command.CommandRegistry.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-lang-kotlin Show documentation
There is a newer version: 5.0.0.CR1
/*
 * Copyright 2019 Red Hat, Inc.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution.
 *
 * The Eclipse Public License is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * The Apache License v2.0 is available at
 * http://www.opensource.org/licenses/apache2.0.php
 *
 * You may elect to redistribute this code under either of these licenses.
 */
package io.vertx.kotlin.ext.shell.command

import io.vertx.ext.shell.command.Command
import io.vertx.ext.shell.command.CommandRegistry
import io.vertx.kotlin.coroutines.awaitResult

/**
 * Suspending version of method [io.vertx.ext.shell.command.CommandRegistry.registerCommand]
 *
 * @param command the command to register
 * @return [Command]
 *
 * NOTE: This function has been automatically generated from [io.vertx.ext.shell.command.CommandRegistry] using Vert.x codegen.
 */
@Deprecated(message = "Instead use registerCommand returning a future and chain with await()", replaceWith = ReplaceWith("registerCommand(command).await()"))
suspend fun CommandRegistry.registerCommandAwait(command: Command): Command {
  return awaitResult {
    this.registerCommand(command, it)
  }
}

/**
 * Suspending version of method [io.vertx.ext.shell.command.CommandRegistry.registerCommands]
 *
 * @param commands the commands to register
 * @return [List]
 *
 * NOTE: This function has been automatically generated from [io.vertx.ext.shell.command.CommandRegistry] using Vert.x codegen.
 */
@Deprecated(message = "Instead use registerCommands returning a future and chain with await()", replaceWith = ReplaceWith("registerCommands(commands).await()"))
suspend fun CommandRegistry.registerCommandsAwait(commands: List): List {
  return awaitResult {
    this.registerCommands(commands, it)
  }
}

/**
 * Suspending version of method [io.vertx.ext.shell.command.CommandRegistry.unregisterCommand]
 *
 * @param commandName the command name
 *
 * NOTE: This function has been automatically generated from [io.vertx.ext.shell.command.CommandRegistry] using Vert.x codegen.
 */
@Deprecated(message = "Instead use unregisterCommand returning a future and chain with await()", replaceWith = ReplaceWith("unregisterCommand(commandName).await()"))
suspend fun CommandRegistry.unregisterCommandAwait(commandName: String): Unit {
  return awaitResult {
    this.unregisterCommand(commandName, io.vertx.core.Handler { ar -> it.handle(ar.mapEmpty()) })
  }
}