/*
 * Copyright (c) 2016 The original author or authors
 *
 * 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.ext.consul;

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

Represents key/value pair stored in Consul
Author:
Ruslan Sennov
See Also:
Consul key/value store/**
 * Represents key/value pair stored in Consul
 *
 * @author <a href="mailto:ruslan.sennov@gmail.com">Ruslan Sennov</a>
 * @see <a href="https://www.consul.io/docs/agent/http/kv.html">Consul key/value store</a>
 */
@DataObject(generateConverter = true)
public class KeyValue implements TxnResult {

  private String key;
  private String value;
  private String session;
  private long flags;
  private long createIndex;
  private long modifyIndex;
  private long lockIndex;

  
Default constructor
/**
   * Default constructor
   */
  public KeyValue() {}

  
Copy constructor
Params:
other – the one to copy/**
   * Copy constructor
   *
   * @param other the one to copy
   */
  public KeyValue(KeyValue other) {
    this.key = other.key;
    this.value = other.value;
    this.session = other.session;
    this.flags = other.flags;
    this.createIndex = other.createIndex;
    this.modifyIndex = other.modifyIndex;
    this.lockIndex = other.lockIndex;
  }

  
Constructor from JSON
Params:
json – the JSON/**
   * Constructor from JSON
   *
   * @param json the JSON
   */
  public KeyValue(JsonObject json) {
    KeyValueConverter.fromJson(json, this);
  }

  
Convert to JSON
Returns:
the JSON/**
   * Convert to JSON
   *
   * @return the JSON
   */
  public JsonObject toJson() {
    JsonObject jsonObject = new JsonObject();
    KeyValueConverter.toJson(this, jsonObject);
    return jsonObject;
  }

  
Return true if there is a key/value pair present, otherwise false. 
Returns:
true if there is a key/value pair present, otherwise false/**
   * Return {@code true} if there is a key/value pair present, otherwise {@code false}.
   *
   * @return {@code true} if there is a key/value pair present, otherwise {@code false}
   */
  @GenIgnore
  public boolean isPresent() {
    return key != null;
  }

  
Get the key
Returns:
the key/**
   * Get the key
   *
   * @return the key
   */
  public String getKey() {
    return key;
  }

  
Set the key
Params:
key – the key
Returns:
reference to this, for fluency/**
   * Set the key
   *
   * @param key the key
   * @return reference to this, for fluency
   */
  public KeyValue setKey(String key) {
    this.key = key;
    return this;
  }

  
Get the value. In case if KeyValue is result of transaction, value can be empty
Returns:
the value/**
   * Get the value. In case if KeyValue is result of transaction, value can be empty
   *
   * @return the value
   */
  public String getValue() {
    return value;
  }

  
Set the value
Params:
value – the value
Returns:
reference to this, for fluency/**
   * Set the value
   *
   * @param value the value
   * @return reference to this, for fluency
   */
  public KeyValue setValue(String value) {
    this.value = value;
    return this;
  }

  
Get the session that owns the lock
Returns:
the session that owns the lock/**
   * Get the session that owns the lock
   *
   * @return the session that owns the lock
   */
  public String getSession() {
    return session;
  }

  
Set the session that owns the lock
Params:
session – the session that owns the lock
Returns:
reference to this, for fluency/**
   * Set the session that owns the lock
   *
   * @param session the session that owns the lock
   * @return reference to this, for fluency
   */
  public KeyValue setSession(String session) {
    this.session = session;
    return this;
  }

  
Get the flags attached to this entry. Clients can choose to use this however makes sense for their application.
Returns:
the flags attached to this entry/**
   * Get the flags attached to this entry. Clients can choose to use this however makes sense for their application.
   *
   * @return the flags attached to this entry
   */
  public long getFlags() {
    return flags;
  }

  
Set the flags attached to this entry. Clients can choose to use this however makes sense for their application.
Params:
flags – the flags attached to this entry. Clients can choose to use this however makes sense for their application.
Returns:
reference to this, for fluency/**
   * Set the flags attached to this entry. Clients can choose to use this however makes sense for their application.
   *
   * @param flags the flags attached to this entry. Clients can choose to use this however makes sense for their application.
   * @return reference to this, for fluency
   */
  public KeyValue setFlags(long flags) {
    this.flags = flags;
    return this;
  }

  
Get the internal index value that represents when the entry was created.
Returns:
the internal index value that represents when the entry was created./**
   * Get the internal index value that represents when the entry was created.
   *
   * @return the internal index value that represents when the entry was created.
   */
  public long getCreateIndex() {
    return createIndex;
  }

  
Set the internal index value that represents when the entry was created.
Params:
createIndex – the internal index value that represents when the entry was created.
Returns:
reference to this, for fluency/**
   * Set the internal index value that represents when the entry was created.
   *
   * @param createIndex the internal index value that represents when the entry was created.
   * @return reference to this, for fluency
   */
  public KeyValue setCreateIndex(long createIndex) {
    this.createIndex = createIndex;
    return this;
  }

  
Get the last index that modified this key.
Returns:
the last index that modified this key./**
   * Get the last index that modified this key.
   *
   * @return the last index that modified this key.
   */
  public long getModifyIndex() {
    return modifyIndex;
  }

  
Set the last index that modified this key.
Params:
modifyIndex – the last index that modified this key.
Returns:
reference to this, for fluency/**
   * Set the last index that modified this key.
   *
   * @param modifyIndex the last index that modified this key.
   * @return reference to this, for fluency
   */
  public KeyValue setModifyIndex(long modifyIndex) {
    this.modifyIndex = modifyIndex;
    return this;
  }

  
Get the number of times this key has successfully been acquired in a lock.
Returns:
the number of times this key has successfully been acquired in a lock./**
   * Get the number of times this key has successfully been acquired in a lock.
   *
   * @return the number of times this key has successfully been acquired in a lock.
   */
  public long getLockIndex() {
    return lockIndex;
  }

  
Set the number of times this key has successfully been acquired in a lock.
Params:
lockIndex – the number of times this key has successfully been acquired in a lock.
Returns:
reference to this, for fluency/**
   * Set the number of times this key has successfully been acquired in a lock.
   *
   * @param lockIndex the number of times this key has successfully been acquired in a lock.
   * @return reference to this, for fluency
   */
  public KeyValue setLockIndex(long lockIndex) {
    this.lockIndex = lockIndex;
    return this;
  }

  @GenIgnore
  @Override
  public TxnOperationType getOperationType() {
    return TxnOperationType.KV;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;

    KeyValue keyValue = (KeyValue) o;

    if (flags != keyValue.flags) return false;
    if (createIndex != keyValue.createIndex) return false;
    if (modifyIndex != keyValue.modifyIndex) return false;
    if (lockIndex != keyValue.lockIndex) return false;
    if (key != null ? !key.equals(keyValue.key) : keyValue.key != null) return false;
    if (value != null ? !value.equals(keyValue.value) : keyValue.value != null) return false;
    return session != null ? session.equals(keyValue.session) : keyValue.session == null;
  }

  @Override
  public int hashCode() {
    int result = key != null ? key.hashCode() : 0;
    result = 31 * result + (value != null ? value.hashCode() : 0);
    result = 31 * result + (session != null ? session.hashCode() : 0);
    result = 31 * result + (int) (flags ^ (flags >>> 32));
    result = 31 * result + (int) (createIndex ^ (createIndex >>> 32));
    result = 31 * result + (int) (modifyIndex ^ (modifyIndex >>> 32));
    result = 31 * result + (int) (lockIndex ^ (lockIndex >>> 32));
    return result;
  }
}