/*
 * 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.Objects;

Data object representing the configuration of a configuration store. This object describes the configuration of a
chunk of configuration that you retrieve. It specifies its type (type of configuration store), the format of the
retrieved configuration chunk, and you can also configures the store if it needs configuration to
retrieve the configuration chunk.
Author:
Clement Escoffier/**
 * Data object representing the configuration of a configuration store. This object describes the configuration of a
 * chunk of configuration that you retrieve. It specifies its type (type of configuration store), the format of the
 * retrieved configuration chunk, and you can also configures the store if it needs configuration to
 * retrieve the configuration chunk.
 *
 * @author <a href="http://escoffier.me">Clement Escoffier</a>
 */
@DataObject
public class ConfigStoreOptions {

  private String type;
  private JsonObject config;
  private String format;
  private boolean optional;

  public ConfigStoreOptions() {
    // Empty constructor
  }

  public ConfigStoreOptions(ConfigStoreOptions other) {
    this.type = other.type;
    this.config = other.config == null ? null : other.config.copy();
    this.format = other.format;
    this.optional = other.optional;
  }

  public ConfigStoreOptions(JsonObject json) {
    type = json.getString("type");
    config = json.getJsonObject("config");
    optional = json.getBoolean("optional", false);
    format = json.getString("format", "json");
  }


  public JsonObject toJson() {
    JsonObject json = new JsonObject();
    if (type != null) {
      json.put("type", type);
    }
    if (config != null) {
      json.put("config", config);
    }
    if (format != null) {
      json.put("format", format);
    }
    json.put("optional", optional);
    return json;
  }

  
Returns:
the configuration type, it specified from which store the configuration is coming./**
   * @return the configuration type, it specified from which store the configuration is coming.
   */
  public String getType() {
    return type;
  }

  
Sets the configuration type
Params:
type – the type
Returns:
the current instance of ConfigStoreOptions/**
   * Sets the configuration type
   *
   * @param type the type
   * @return the current instance of {@link ConfigStoreOptions}
   */
  public ConfigStoreOptions setType(String type) {
    this.type = type;
    return this;
  }

  
Returns:
the configuration of the store, may be null if not needed./**
   * @return the configuration of the store, may be {@code null} if not needed.
   */
  public JsonObject getConfig() {
    return config;
  }

  
Sets the configuration of the store
Params:
config – the data, can be null
Returns:
the current instance of ConfigStoreOptions/**
   * Sets the configuration of the store
   *
   * @param config the data, can be {@code null}
   * @return the current instance of {@link ConfigStoreOptions}
   */
  public ConfigStoreOptions setConfig(JsonObject config) {
    this.config = config;
    return this;
  }


  
Returns:
the format of the configuration that is retrieved from the store./**
   * @return the format of the configuration that is retrieved from the store.
   */
  public String getFormat() {
    return format;
  }

  
Returns:
whether or not the store is considered as optional. When the configuration is retrieve, if an optional store
returns a failure, the failure is ignored and an empty json object is used instead (for this store).
The default value is false./**
   * @return whether or not the store is considered as optional. When the configuration is retrieve, if an optional store
   * returns a failure, the failure is ignored and an empty json object is used instead (for this store).
   * The default value is false.
   */
  public boolean isOptional() {
    return optional;
  }

  
Sets whether or not the store is optional. When the configuration is retrieve, if an optional store
returns a failure, the failure is ignored and an empty json object is used instead (for this store).
Params:
optional – whether or not the store is optional.
Returns:
the current instance of ConfigStoreOptions/**
   * Sets whether or not the store is optional. When the configuration is retrieve, if an optional store
   * returns a failure, the failure is ignored and an empty json object is used instead (for this store).
   *
   * @param optional whether or not the store is optional.
   * @return the current instance of {@link ConfigStoreOptions}
   */
  public ConfigStoreOptions setOptional(boolean optional) {
    this.optional = optional;
    return this;
  }

  
Sets the format of the configuration that is retrieved from the store.
Params:
format – the format, must not be null.
Returns:
the current instance of ConfigStoreOptions/**
   * Sets the format of the configuration that is retrieved from the store.
   *
   * @param format the format, must not be {@code null}.
   * @return the current instance of {@link ConfigStoreOptions}
   */
  public ConfigStoreOptions setFormat(String format) {
    Objects.requireNonNull(format);
    this.format = format;
    return this;
  }
}