io.vertx.kotlin.config.ConfigRetrieverOptions.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.config

import io.vertx.config.ConfigRetrieverOptions
import io.vertx.config.ConfigStoreOptions

/**
 * A function providing a DSL for building [io.vertx.config.ConfigRetrieverOptions] objects.
 *
 * Options to configure the ConfigRetriever.
 *
 * @param includeDefaultStores  Enables or disables the inclusion of the default stored in the configuration.
 * @param scanPeriod  Configures the scan period, in ms. This is the time amount between two checks of the configuration updates.
 * @param stores  Sets the configuration stores.
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.config.ConfigRetrieverOptions original] using Vert.x codegen.
 */
fun configRetrieverOptionsOf(
  includeDefaultStores: Boolean? = null,
  scanPeriod: Long? = null,
  stores: Iterable? = null): ConfigRetrieverOptions = io.vertx.config.ConfigRetrieverOptions().apply {

  if (includeDefaultStores != null) {
    this.setIncludeDefaultStores(includeDefaultStores)
  }
  if (scanPeriod != null) {
    this.setScanPeriod(scanPeriod)
  }
  if (stores != null) {
    this.setStores(stores.toList())
  }
}

/**
 * A function providing a DSL for building [io.vertx.config.ConfigRetrieverOptions] objects.
 *
 * Options to configure the ConfigRetriever.
 *
 * @param includeDefaultStores  Enables or disables the inclusion of the default stored in the configuration.
 * @param scanPeriod  Configures the scan period, in ms. This is the time amount between two checks of the configuration updates.
 * @param stores  Sets the configuration stores.
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.config.ConfigRetrieverOptions original] using Vert.x codegen.
 */
@Deprecated(
  message = "This function will be removed in a future version",
  replaceWith = ReplaceWith("configRetrieverOptionsOf(includeDefaultStores, scanPeriod, stores)")
)
fun ConfigRetrieverOptions(
  includeDefaultStores: Boolean? = null,
  scanPeriod: Long? = null,
  stores: Iterable? = null): ConfigRetrieverOptions = io.vertx.config.ConfigRetrieverOptions().apply {

  if (includeDefaultStores != null) {
    this.setIncludeDefaultStores(includeDefaultStores)
  }
  if (scanPeriod != null) {
    this.setScanPeriod(scanPeriod)
  }
  if (stores != null) {
    this.setStores(stores.toList())
  }
}