Merge branch 'christopherfrieler-feature/CLIENTS-1063-equals-implementations' into develop

Author: alexmoore

src/main/java/com/basho/riak/client/api/commands/buckets/FetchBucketProperties.java

@@ -20,6 +20,8 @@
 import com.basho.riak.client.core.operations.FetchBucketPropsOperation;
 import com.basho.riak.client.core.query.Namespace;
 
+import java.util.Objects;
+
 /**
  * Command used to fetch the properties of a bucket in Riak.
  * <script src="https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js"></script>
@@ -30,9 +32,11 @@
  * FetchBucketProperties fbp = new FetchBucketProperties.Builder(ns).build();
  * FetchBucketPropsOperation.Response resp = client.execute(fbp);
  * BucketProperties props = resp.getBucketProperties();}</pre>
- * Note that this simply returns the core response {@link com.basho.riak.client.core.operations.FetchBucketPropsOperation.Response}
- *
+ * Note that this simply returns the core response
+ * {@link com.basho.riak.client.core.operations.FetchBucketPropsOperation.Response}
+ * <p>
  * </p>
+ *
  * @author Dave Rusek <drusek at basho dot com>
  * @since 2.0
  */
@@ -51,6 +55,30 @@ protected FetchBucketPropsOperation buildCoreOperation()
         return new FetchBucketPropsOperation.Builder(namespace).build();
     }
 
+    @Override
+    public boolean equals(Object other)
+    {
+        if (this == other)
+        {
+            return true;
+        }
+
+        if (!(other instanceof FetchBucketProperties))
+        {
+            return false;
+        }
+
+        FetchBucketProperties otherFetchBucketProperties = (FetchBucketProperties) other;
+
+        return Objects.equals(namespace, otherFetchBucketProperties.namespace);
+    }
+
+    @Override
+    public int hashCode()
+    {
+        return Objects.hash(namespace);
+    }
+
     /**
      * Builder used to construct a FetchBucketPoperties command.
      */
@@ -60,6 +88,7 @@ public static class Builder
 
         /**
          * Construct a Builder for a FetchBucketProperties command.
+         *
          * @param namespace The namespace for the bucket.
          */
         public Builder(Namespace namespace)
@@ -73,6 +102,7 @@ public Builder(Namespace namespace)
 
         /**
          * Construct a new FetchBucketProperties command.
+         *
          * @return a new FetchBucketProperties command.
          */
         public FetchBucketProperties build()

src/main/java/com/basho/riak/client/api/commands/buckets/StoreBucketProperties.java

@@ -21,18 +21,21 @@
 import com.basho.riak.client.core.query.Namespace;
 import com.basho.riak.client.core.query.functions.Function;
 
+import java.util.Objects;
+
 /**
  * Command used to store (modify) the properties of a bucket in Riak.
  * <p>
  * <pre class="prettyprint">
  * {@code
  * Namespace ns = new Namespace("my_type", "my_bucket");
  * StoreBucketProperties sbp =
- *  new StoreBucketProperties.Builder(ns)
- *      .withAllowMulti(true)
- *      .build();
+ * new StoreBucketProperties.Builder(ns)
+ * .withAllowMulti(true)
+ * .build();
  * client.execute(sbp);}</pre>
  * </p>
+ *
  * @author Dave Rusek <drusek at basho dot com>
  * @since 2.0
  */
@@ -94,8 +97,7 @@ public final class StoreBucketProperties extends AsIsRiakCommand<Void, Namespace
     @Override
     protected StoreBucketPropsOperation buildCoreOperation()
     {
-        StoreBucketPropsOperation.Builder builder =
-            new StoreBucketPropsOperation.Builder(namespace);
+        StoreBucketPropsOperation.Builder builder = new StoreBucketPropsOperation.Builder(namespace);
 
         if (allowMulti != null)
         {
@@ -215,6 +217,76 @@ protected StoreBucketPropsOperation buildCoreOperation()
         return builder.build();
     }
 
+    @Override
+    public boolean equals(Object other)
+    {
+        if (this == other)
+        {
+            return true;
+        }
+
+        if (!(other instanceof StoreBucketProperties))
+        {
+            return false;
+        }
+
+        StoreBucketProperties otherStoreBucketProperties = (StoreBucketProperties) other;
+
+        return Objects.equals(namespace, otherStoreBucketProperties.namespace) &&
+               Objects.equals(allowMulti, otherStoreBucketProperties.allowMulti) &&
+               Objects.equals(backend, otherStoreBucketProperties.backend) &&
+               Objects.equals(basicQuorum, otherStoreBucketProperties.basicQuorum) &&
+               Objects.equals(bigVClock, otherStoreBucketProperties.bigVClock) &&
+               Objects.equals(chashkeyFunction, otherStoreBucketProperties.chashkeyFunction) &&
+               Objects.equals(lastWriteWins, otherStoreBucketProperties.lastWriteWins) &&
+               Objects.equals(linkWalkFunction, otherStoreBucketProperties.linkWalkFunction) &&
+               Objects.equals(rw, otherStoreBucketProperties.rw) &&
+               Objects.equals(dw, otherStoreBucketProperties.dw) &&
+               Objects.equals(w, otherStoreBucketProperties.w) &&
+               Objects.equals(r, otherStoreBucketProperties.r) &&
+               Objects.equals(pr, otherStoreBucketProperties.pr) &&
+               Objects.equals(pw, otherStoreBucketProperties.pw) &&
+               Objects.equals(notFoundOk, otherStoreBucketProperties.notFoundOk) &&
+               Objects.equals(preCommitHook, otherStoreBucketProperties.preCommitHook) &&
+               Objects.equals(postCommitHook, otherStoreBucketProperties.postCommitHook) &&
+               Objects.equals(oldVClock, otherStoreBucketProperties.oldVClock) &&
+               Objects.equals(youngVClock, otherStoreBucketProperties.youngVClock) &&
+               Objects.equals(smallVClock, otherStoreBucketProperties.smallVClock) &&
+               Objects.equals(nval, otherStoreBucketProperties.nval) &&
+               Objects.equals(legacySearch, otherStoreBucketProperties.legacySearch) &&
+               Objects.equals(searchIndex, otherStoreBucketProperties.searchIndex) &&
+               Objects.equals(hllPrecision, otherStoreBucketProperties.hllPrecision);
+    }
+
+    @Override
+    public int hashCode()
+    {
+        return Objects.hash(namespace,
+                            allowMulti,
+                            backend,
+                            basicQuorum,
+                            bigVClock,
+                            chashkeyFunction,
+                            lastWriteWins,
+                            linkWalkFunction,
+                            rw,
+                            dw,
+                            w,
+                            r,
+                            pr,
+                            pw,
+                            notFoundOk,
+                            preCommitHook,
+                            postCommitHook,
+                            oldVClock,
+                            youngVClock,
+                            smallVClock,
+                            nval,
+                            legacySearch,
+                            searchIndex,
+                            hllPrecision);
+    }
+
     public static class Builder
     {
         private final Namespace namespace;
@@ -282,7 +354,7 @@ public Builder withBackend(String backend)
 
         /**
          * Set the basic_quorum value.
-         *
+         * <p>
          * The parameter controls whether a read request should return early in
          * some fail cases. E.g. If a quorum of nodes has already returned
          * notfound/error, don't wait around for the rest.
@@ -301,7 +373,9 @@ public Builder withBasicQuorum(boolean use)
          *
          * @param bigVClock a long representing a epoch time value.
          * @return a reference to this object.
-         * @see <a href="http://docs.basho.com/riak/latest/theory/concepts/Vector-Clocks/#Vector-Clock-Pruning">Vector Clock Pruning</a>
+         * @see
+         * <a href="http://docs.basho.com/riak/latest/theory/concepts/Vector-Clocks/#Vector-Clock-Pruning">Vector
+         * Clock Pruning</a>
          */
         public Builder withBigVClock(Long bigVClock)
         {
@@ -475,7 +549,9 @@ public Builder withPostcommitHook(Function hook)
          *
          * @param oldVClock an long representing a epoch time value.
          * @return a reference to this object.
-         * @see <a href="http://docs.basho.com/riak/latest/theory/concepts/Vector-Clocks/#Vector-Clock-Pruning">Vector Clock Pruning</a>
+         * @see
+         * <a href="http://docs.basho.com/riak/latest/theory/concepts/Vector-Clocks/#Vector-Clock-Pruning">Vector
+         * Clock Pruning</a>
          */
         public Builder withOldVClock(Long oldVClock)
         {
@@ -488,7 +564,9 @@ public Builder withOldVClock(Long oldVClock)
          *
          * @param youngVClock a long representing a epoch time value.
          * @return a reference to this object.
-         * @see <a href="http://docs.basho.com/riak/latest/theory/concepts/Vector-Clocks/#Vector-Clock-Pruning">Vector Clock Pruning</a>
+         * @see
+         * <a href="http://docs.basho.com/riak/latest/theory/concepts/Vector-Clocks/#Vector-Clock-Pruning">Vector
+         * Clock Pruning</a>
          */
         public Builder withYoungVClock(Long youngVClock)
         {
@@ -501,7 +579,9 @@ public Builder withYoungVClock(Long youngVClock)
          *
          * @param smallVClock a long representing a epoch time value.
          * @return a reference to this object.
-         * @see <a href="http://docs.basho.com/riak/latest/theory/concepts/Vector-Clocks/#Vector-Clock-Pruning">Vector Clock Pruning</a>
+         * @see
+         * <a href="http://docs.basho.com/riak/latest/theory/concepts/Vector-Clocks/#Vector-Clock-Pruning">Vector
+         * Clock Pruning</a>
          */
         public Builder withSmallVClock(Long smallVClock)
         {
@@ -528,11 +608,11 @@ public Builder withNVal(int nVal)
         /**
          * Enable Legacy Riak Search. Setting this to true causes the search
          * pre-commit hook to be added.
-         *
+         * <p>
          * <b>Note this is only for legacy Riak (&lt; v2.0) Search support.</b>
          *
          * @param enable add/remove (true/false) the pre-commit hook for Legacy
-         * Riak Search.
+         *               Riak Search.
          * @return a reference to this object.
          */
         public Builder withLegacyRiakSearchEnabled(boolean enable)

src/main/java/com/basho/riak/client/api/commands/search/StoreIndex.java

@@ -4,6 +4,8 @@
 import com.basho.riak.client.core.operations.YzPutIndexOperation;
 import com.basho.riak.client.core.query.search.YokozunaIndex;
 
+import java.util.Objects;
+
 /**
  * Command used to store a search index in Riak.
  * <p>
@@ -36,6 +38,31 @@ protected YzPutIndexOperation buildCoreOperation()
         return opBuilder.build();
     }
 
+    @Override
+    public boolean equals(Object other)
+    {
+        if (this == other)
+        {
+            return true;
+        }
+
+        if (!(other instanceof StoreIndex))
+        {
+            return false;
+        }
+
+        Builder otherStoreIndex = ((StoreIndex) other).cmdBuilder;
+
+        return Objects.equals(cmdBuilder.index, otherStoreIndex.index) &&
+               Objects.equals(cmdBuilder.timeout, otherStoreIndex.timeout);
+    }
+
+    @Override
+    public int hashCode()
+    {
+        return Objects.hash(cmdBuilder.index, cmdBuilder.timeout);
+    }
+
     /**
      * Builder for a StoreIndex command.
      */
@@ -60,6 +87,7 @@ public Builder(YokozunaIndex index)
          * By default, riak has a 45s timeout for Yokozuna index creation.
          * Setting this value will override that default for this operation.
          * </p>
+         *
          * @param timeout the timeout in milliseconds to be sent to riak.
          * @return a reference to this object.
          */

src/main/java/com/basho/riak/client/core/query/search/YokozunaIndex.java

@@ -15,6 +15,8 @@
  */
 package com.basho.riak.client.core.query.search;
 
+import java.util.Objects;
+
 /**
  * Represents a Yokozuna Index.
  *
@@ -28,7 +30,7 @@ public class YokozunaIndex
 
     /**
      * Constructs a Yokozuna index without naming the schema.
-     *
+     * <p>
      * Due to an implementation detail on the Riak side, the index name is restricted
      * to US-ASCII characters. The supplied String is converted to bytes
      * using the UTF-8 Charset.
@@ -46,7 +48,7 @@ public YokozunaIndex(String name)
      * to US-ASCII characters. The supplied String is converted to bytes
      * using the UTF-8 Charset.
      *
-     * @param name The name of the index.
+     * @param name   The name of the index.
      * @param schema The name of a schema
      */
     public YokozunaIndex(String name, String schema)
@@ -89,6 +91,7 @@ public String getName()
 
     /**
      * Returns the schema name for this index.
+     *
      * @return The schema name.
      */
     public String getSchema()
@@ -115,4 +118,30 @@ public Integer getNVal()
     {
         return nVal;
     }
+
+    @Override
+    public boolean equals(Object other)
+    {
+        if (this == other)
+        {
+            return true;
+        }
+
+        if (!(other instanceof YokozunaIndex))
+        {
+            return false;
+        }
+
+        YokozunaIndex otherYokozunaIndex = (YokozunaIndex) other;
+
+        return Objects.equals(name, otherYokozunaIndex.name) &&
+               Objects.equals(schema, otherYokozunaIndex.schema) &&
+               Objects.equals(nVal, otherYokozunaIndex.nVal);
+    }
+
+    @Override
+    public int hashCode()
+    {
+        return Objects.hash(name, schema, nVal);
+    }
 }