com.scalar.db.api.Mutation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scalardb Show documentation
A universal transaction manager that achieves database-agnostic transactions and distributed transactions that span multiple databases
The newest version!
package com.scalar.db.api;

import com.google.common.base.MoreObjects;
import com.scalar.db.io.Key;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;

/**
 * An abstraction for mutation operations such as {@link Put}, {@link Delete}, {@link Insert},
 * {@link Upsert}, and {@link Update}.
 *
 * @author Hiroyuki Yamada
 */
@NotThreadSafe
public abstract class Mutation extends Operation {

  /** @deprecated As of release 3.13.0. Will be removed in release 5.0.0. */
  @Deprecated private Optional condition;

  /**
   * @param partitionKey a partition key
   * @param clusteringKey a clustering key
   * @deprecated As of release 3.6.0. Will be removed in release 5.0.0.
   */
  @Deprecated
  public Mutation(Key partitionKey, Key clusteringKey) {
    super(partitionKey, clusteringKey);
    condition = Optional.empty();
  }

  /**
   * @param mutation a mutation
   * @deprecated As of release 3.6.0. Will be removed in release 5.0.0.
   */
  @Deprecated
  public Mutation(Mutation mutation) {
    super(mutation);
    condition = mutation.condition;
  }

  Mutation(
      @Nullable String namespace,
      String tableName,
      Key partitionKey,
      @Nullable Key clusteringKey,
      @Nullable MutationCondition condition) {
    super(namespace, tableName, partitionKey, clusteringKey);
    this.condition = Optional.ofNullable(condition);
  }

  /**
   * Returns the {@link MutationCondition}
   *
   * @return {@code MutationCondition}
   * @deprecated As of release 3.13.0. Will be removed in release 5.0.0.
   */
  @Deprecated
  @Nonnull
  public Optional getCondition() {
    return condition;
  }

  /**
   * Sets the specified {@link MutationCondition}
   *
   * @param condition a {@code MutationCondition}
   * @return this object
   * @deprecated As of release 3.6.0. Will be removed in release 5.0.0.
   */
  @Deprecated
  public Mutation withCondition(MutationCondition condition) {
    this.condition = Optional.ofNullable(condition);
    return this;
  }

  /**
   * Indicates whether some other object is "equal to" this object. The other object is considered
   * equal if:
   *
   * 
   *   both super class instances are equal and
   *   
it is also an {@code Mutation} and
   *   
both instances have the same condition
   * 
   *
   * @param o an object to be tested for equality
   * @return {@code true} if the other object is "equal to" this object otherwise {@code false}
   */
  @Override
  public boolean equals(Object o) {
    if (!super.equals(o)) {
      return false;
    }
    if (o == this) {
      return true;
    }
    if (!(o instanceof Mutation)) {
      return false;
    }
    Mutation other = (Mutation) o;
    return condition.equals(other.condition);
  }

  @Override
  public int hashCode() {
    return Objects.hash(super.hashCode(), condition);
  }

  @Override
  public String toString() {
    return MoreObjects.toStringHelper(this)
        .add("namespace", forNamespace())
        .add("table", forTable())
        .add("partitionKey", getPartitionKey())
        .add("clusteringKey", getClusteringKey())
        .add("consistency", getConsistency())
        .add("condition", condition)
        .toString();
  }
}