/*
 * Copyright (c) 2014 Red Hat, Inc. and others
 *
 * Red Hat licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 */

package io.vertx.config;

import io.vertx.codegen.annotations.DataObject;
import io.vertx.core.json.JsonObject;

import java.util.ArrayList;
import java.util.List;

Options to configure the ConfigRetriever. 
Author:
Clement Escoffier/**
 * Options to configure the {@code ConfigRetriever}.
 *
 * @author <a href="http://escoffier.me">Clement Escoffier</a>
 */
@DataObject(generateConverter = true)
public class ConfigRetrieverOptions {

  
The default scan period in ms.
/**
   * The default scan period in ms.
   */
  private static final long SCAN_PERIOD_DEFAULT = 5000L;

  private long scanPeriod = SCAN_PERIOD_DEFAULT;

  private List<ConfigStoreOptions> stores = new ArrayList<>();

  private boolean includeDefaultStores = false;

  public ConfigRetrieverOptions() {
    // Empty constructor
  }

  public ConfigRetrieverOptions(ConfigRetrieverOptions other) {
    this.scanPeriod = other.scanPeriod;
    this.stores = other.stores;
  }

  public ConfigRetrieverOptions(JsonObject json) {
    ConfigRetrieverOptionsConverter.fromJson(json, this);
  }

  public JsonObject toJson() {
    JsonObject json = new JsonObject();
    ConfigRetrieverOptionsConverter.toJson(this, json);
    return json;
  }

  
Returns:
whether or not the default stored are included in the configuration./**
   * @return whether or not the default stored are included in the configuration.
   */
  public boolean isIncludeDefaultStores() {
    return includeDefaultStores;
  }

  
Enables or disables the inclusion of the default stored in the configuration.
Params:
includeDefaultStores – true to include the default stores.
Returns:
the current ConfigStoreOptions/**
   * Enables or disables the inclusion of the default stored in the configuration.
   *
   * @param includeDefaultStores {@code true} to include the default stores.
   * @return the current {@link ConfigStoreOptions}
   */
  public ConfigRetrieverOptions setIncludeDefaultStores(boolean includeDefaultStores) {
    this.includeDefaultStores = includeDefaultStores;
    return this;
  }

  
Returns:
the scan period in ms./**
   * @return the scan period in ms.
   */
  public long getScanPeriod() {
    return scanPeriod;
  }

  
Configures the scan period, in ms. This is the time amount between two checks of the configuration updates.
Params:
scanPeriod – the scan period in ms
Returns:
the current ConfigStoreOptions/**
   * Configures the scan period, in ms. This is the time amount between two checks of the configuration updates.
   *
   * @param scanPeriod the scan period in ms
   * @return the current {@link ConfigStoreOptions}
   */
  public ConfigRetrieverOptions setScanPeriod(long scanPeriod) {
    this.scanPeriod = scanPeriod;
    return this;
  }

  
Returns:
the current list of stores./**
   * @return the current list of stores.
   */
  public List<ConfigStoreOptions> getStores() {
    return stores;
  }

  
Sets the configuration stores.
Params:
stores – the list of stores.
Returns:
the current ConfigStoreOptions/**
   * Sets the configuration stores.
   *
   * @param stores the list of stores.
   * @return the current {@link ConfigStoreOptions}
   */
  public ConfigRetrieverOptions setStores(List<ConfigStoreOptions> stores) {
    if (stores == null) {
      this.stores = new ArrayList<>();
    } else {
      this.stores = stores;
    }
    return this;
  }

  
Adds a store to the list of stores.
Params:
options – the store configuration
Returns:
the current ConfigStoreOptions/**
   * Adds a store to the list of stores.
   *
   * @param options the store configuration
   * @return the current {@link ConfigStoreOptions}
   */
  public ConfigRetrieverOptions addStore(ConfigStoreOptions options) {
    getStores().add(options);
    return this;
  }
}