io.vertx.kotlin.core.cli.Argument.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.core.cli

import io.vertx.core.cli.Argument

/**
 * A function providing a DSL for building [io.vertx.core.cli.Argument] objects.
 *
 * Defines a command line argument. Unlike options, argument don't have names and are identified using an index. The
 * first index is 0 (because we are in the computer world).
 *
 * @param argName  Sets the argument name of this [io.vertx.core.cli.Argument].
 * @param defaultValue  Sets the default value of this [io.vertx.core.cli.Argument].
 * @param description  Sets the description of the [io.vertx.core.cli.Argument].
 * @param hidden  Sets whether or not the current [io.vertx.core.cli.Argument] is hidden.
 * @param index  Sets the argument index.
 * @param multiValued  Sets whether or not the argument can receive several values. Only the last argument can receive several values.
 * @param required  Sets whether or not the current [io.vertx.core.cli.Argument] is required.
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.core.cli.Argument original] using Vert.x codegen.
 */
fun argumentOf(
  argName: String? = null,
  defaultValue: String? = null,
  description: String? = null,
  hidden: Boolean? = null,
  index: Int? = null,
  multiValued: Boolean? = null,
  required: Boolean? = null): Argument = io.vertx.core.cli.Argument().apply {

  if (argName != null) {
    this.setArgName(argName)
  }
  if (defaultValue != null) {
    this.setDefaultValue(defaultValue)
  }
  if (description != null) {
    this.setDescription(description)
  }
  if (hidden != null) {
    this.setHidden(hidden)
  }
  if (index != null) {
    this.setIndex(index)
  }
  if (multiValued != null) {
    this.setMultiValued(multiValued)
  }
  if (required != null) {
    this.setRequired(required)
  }
}