Simplify test setup by simplifying the Multimap assert.

Since there is no different between the three different multimap assert types we can collapse them into one assertion type.

Author: mattbertolini

src/main/java/org/assertj/eclipse/collections/api/Assertions.java

@@ -13,12 +13,8 @@
 package org.assertj.eclipse.collections.api;
 
 import org.assertj.core.util.CheckReturnValue;
-import org.assertj.eclipse.collections.api.multimap.bag.BagMultimapAssert;
-import org.assertj.eclipse.collections.api.multimap.list.ListMultimapAssert;
-import org.assertj.eclipse.collections.api.multimap.set.SetMultimapAssert;
-import org.eclipse.collections.api.multimap.bag.BagMultimap;
-import org.eclipse.collections.api.multimap.list.ListMultimap;
-import org.eclipse.collections.api.multimap.set.SetMultimap;
+import org.assertj.eclipse.collections.api.multimap.MultimapAssert;
+import org.eclipse.collections.api.multimap.Multimap;
 
 /**
  * Entry point for assertion methods for the Eclipse Collections library. Each method in this class is a static factory
@@ -34,38 +30,14 @@ protected Assertions() {
   }
 
   /**
-   * Creates a new instance of {@link BagMultimapAssert}.
+   * Creates a new instance of {@link MultimapAssert}.
    *
    * @param actual the actual value.
    * @return the created assertion object.
    * @param <KEY> The type of keys in the BagMultimap
    * @param <VALUE> The type of values in the BagMultimap
    */
-  public static <KEY, VALUE> BagMultimapAssert<KEY, VALUE> assertThat(BagMultimap<KEY, VALUE> actual) {
-    return BagMultimapAssert.assertThat(actual);
-  }
-
-  /**
-   * Creates a new instance of {@link ListMultimapAssert}.
-   *
-   * @param actual the actual value.
-   * @return the created assertion object.
-   * @param <KEY> The type of keys in the ListMultimap
-   * @param <VALUE> The type of values in the ListMultimap
-   */
-  public static <KEY, VALUE> ListMultimapAssert<KEY, VALUE> assertThat(ListMultimap<KEY, VALUE> actual) {
-    return ListMultimapAssert.assertThat(actual);
-  }
-
-  /**
-   * Creates a new instance of {@link SetMultimapAssert}.
-   *
-   * @param actual the actual value.
-   * @return the created assertion object.
-   * @param <KEY> The type of keys in the SetMultimap
-   * @param <VALUE> The type of values in the SetMultimap
-   */
-  public static <KEY, VALUE> SetMultimapAssert<KEY, VALUE> assertThat(SetMultimap<KEY, VALUE> actual) {
-    return SetMultimapAssert.assertThat(actual);
+  public static <KEY, VALUE> MultimapAssert<KEY, VALUE> assertThat(Multimap<KEY, VALUE> actual) {
+    return new MultimapAssert<>(actual);
   }
 }

src/main/java/org/assertj/eclipse/collections/api/BDDAssertions.java

@@ -13,12 +13,8 @@
 package org.assertj.eclipse.collections.api;
 
 import org.assertj.core.util.CheckReturnValue;
-import org.assertj.eclipse.collections.api.multimap.bag.BagMultimapAssert;
-import org.assertj.eclipse.collections.api.multimap.list.ListMultimapAssert;
-import org.assertj.eclipse.collections.api.multimap.set.SetMultimapAssert;
-import org.eclipse.collections.api.multimap.bag.BagMultimap;
-import org.eclipse.collections.api.multimap.list.ListMultimap;
-import org.eclipse.collections.api.multimap.set.SetMultimap;
+import org.assertj.eclipse.collections.api.multimap.MultimapAssert;
+import org.eclipse.collections.api.multimap.Multimap;
 
 /**
  * Behavior-driven development style entry point for assertion methods for the Eclipse Collections library. Each method
@@ -34,38 +30,14 @@ protected BDDAssertions() {
   }
 
   /**
-   * Creates a new instance of {@link BagMultimapAssert}.
+   * Creates a new instance of {@link MultimapAssert}.
    *
    * @param actual the actual value.
    * @return the created assertion object.
    * @param <KEY> The type of keys in the BagMultimap
    * @param <VALUE> The type of values in the BagMultimap
    */
-  public static <KEY, VALUE> BagMultimapAssert<KEY, VALUE> then(BagMultimap<KEY, VALUE> actual) {
-    return assertThat(actual);
-  }
-
-  /**
-   * Creates a new instance of {@link ListMultimapAssert}.
-   *
-   * @param actual the actual value.
-   * @return the created assertion object.
-   * @param <KEY> The type of keys in the ListMultimap
-   * @param <VALUE> The type of values in the ListMultimap
-   */
-  public static <KEY, VALUE> ListMultimapAssert<KEY, VALUE> then(ListMultimap<KEY, VALUE> actual) {
-    return assertThat(actual);
-  }
-
-  /**
-   * Creates a new instance of {@link SetMultimapAssert}.
-   *
-   * @param actual the actual value.
-   * @return the created assertion object.
-   * @param <KEY> The type of keys in the SetMultimap
-   * @param <VALUE> The type of values in the SetMultimap
-   */
-  public static <KEY, VALUE> SetMultimapAssert<KEY, VALUE> then(SetMultimap<KEY, VALUE> actual) {
+  public static <KEY, VALUE> MultimapAssert<KEY, VALUE> then(Multimap<KEY, VALUE> actual) {
     return assertThat(actual);
   }
 }

src/main/java/org/assertj/eclipse/collections/api/EclipseCollectionsSoftAssertionsProvider.java

@@ -14,54 +14,24 @@
 
 import org.assertj.core.api.SoftAssertionsProvider;
 import org.assertj.core.util.CheckReturnValue;
-import org.assertj.eclipse.collections.api.multimap.bag.BagMultimapAssert;
-import org.assertj.eclipse.collections.api.multimap.list.ListMultimapAssert;
-import org.assertj.eclipse.collections.api.multimap.set.SetMultimapAssert;
-import org.eclipse.collections.api.multimap.bag.BagMultimap;
-import org.eclipse.collections.api.multimap.list.ListMultimap;
-import org.eclipse.collections.api.multimap.set.SetMultimap;
+import org.assertj.eclipse.collections.api.multimap.MultimapAssert;
+import org.eclipse.collections.api.multimap.Multimap;
 
 /**
  * Soft assertions implementations for Eclipse Collections types.
  */
 @CheckReturnValue
 public interface EclipseCollectionsSoftAssertionsProvider extends SoftAssertionsProvider {
   /**
-   * Creates a new, proxied instance of a {@link BagMultimapAssert}
+   * Creates a new, proxied instance of a {@link MultimapAssert}
    *
    * @param actual the path
    * @return the created assertion object
    * @param <KEY> The type of keys in the actual BagMultimap
    * @param <VALUE> The type of values in the actual BagMultimap
    */
   @SuppressWarnings("unchecked")
-  default <KEY, VALUE> BagMultimapAssert<KEY, VALUE> assertThat(BagMultimap<KEY, VALUE> actual) {
-    return this.proxy(BagMultimapAssert.class, BagMultimap.class, actual);
-  }
-
-  /**
-   * Creates a new, proxied instance of a {@link ListMultimapAssert}
-   *
-   * @param actual the path
-   * @return the created assertion object
-   * @param <KEY> The type of keys in the actual ListMultimap
-   * @param <VALUE> The type of values in the actual ListMultimap
-   */
-  @SuppressWarnings("unchecked")
-  default <KEY, VALUE> ListMultimapAssert<KEY, VALUE> assertThat(ListMultimap<KEY, VALUE> actual) {
-    return this.proxy(ListMultimapAssert.class, ListMultimap.class, actual);
-  }
-
-  /**
-   * Creates a new, proxied instance of a {@link SetMultimapAssert}
-   *
-   * @param actual the path
-   * @return the created assertion object
-   * @param <KEY> The type of keys in the actual SetMultimap
-   * @param <VALUE> The type of values in the actual SetMultimap
-   */
-  @SuppressWarnings("unchecked")
-  default <KEY, VALUE> SetMultimapAssert<KEY, VALUE> assertThat(SetMultimap<KEY, VALUE> actual) {
-    return this.proxy(SetMultimapAssert.class, SetMultimap.class, actual);
+  default <KEY, VALUE> MultimapAssert<KEY, VALUE> assertThat(Multimap<KEY, VALUE> actual) {
+    return this.proxy(MultimapAssert.class, Multimap.class, actual);
   }
 }

…api/multimap/AbstractMultimapAssert.java …ections/api/multimap/MultimapAssert.javasrc/main/java/org/assertj/eclipse/collections/api/multimap/AbstractMultimapAssert.java renamed to src/main/java/org/assertj/eclipse/collections/api/multimap/MultimapAssert.java src/main/java/org/assertj/eclipse/collections/api/multimap/AbstractMultimapAssert.java renamed to src/main/java/org/assertj/eclipse/collections/api/multimap/MultimapAssert.java

@@ -34,7 +34,7 @@
 
 import java.util.Map;
 
-import org.assertj.core.api.AbstractObjectAssert;
+import org.assertj.core.api.AbstractAssert;
 import org.assertj.core.api.Condition;
 import org.assertj.core.error.GroupTypeDescription;
 import org.eclipse.collections.api.RichIterable;
@@ -48,21 +48,18 @@
 /**
  * Base class for all implementations of assertions for {@link Multimap}.
  *
- * @param <SELF>   the "self" type of this assertion class.
- * @param <ACTUAL> the type of the "actual" value.
- * @param <KEY>    the type of keys in the Multimap.
- * @param <VALUE>  the type of values in the Multimap.
+ * @param <KEY>   the type of keys in the Multimap.
+ * @param <VALUE> the type of values in the Multimap.
  */
-public abstract class AbstractMultimapAssert<SELF extends AbstractMultimapAssert<SELF, ACTUAL, KEY, VALUE>, ACTUAL extends Multimap<KEY, VALUE>, KEY, VALUE>
-  extends AbstractObjectAssert<SELF, ACTUAL> {
+public class MultimapAssert<KEY, VALUE> extends AbstractAssert<MultimapAssert<KEY, VALUE>, Multimap<KEY, VALUE>> {
 
   /**
-   * Creates a new {@link AbstractMultimapAssert}.
+   * Creates a new {@link MultimapAssert}.
+   *
    * @param actual The actual Multimap to assert against
-   * @param selfType The "self" type of child assert class
    */
-  protected AbstractMultimapAssert(ACTUAL actual, Class<?> selfType) {
-    super(actual, selfType);
+  public MultimapAssert(Multimap<KEY, VALUE> actual) {
+    super(actual, MultimapAssert.class);
   }
 
   /**
@@ -85,7 +82,7 @@ protected AbstractMultimapAssert(ACTUAL actual, Class<?> selfType) {
    * @throws AssertionError if the actual {@link Multimap} does not contain the given entries
    */
   @SafeVarargs
-  public final SELF contains(Pair<KEY, VALUE>... entries) {
+  public final MultimapAssert<KEY, VALUE> contains(Pair<KEY, VALUE>... entries) {
     return this.containsForProxy(Lists.mutable.of(entries));
   }
 
@@ -98,7 +95,7 @@ public final SELF contains(Pair<KEY, VALUE>... entries) {
    * @throws AssertionError if the actual {@code Multimap} does not contain one or more of the specified entries.
    */
   @SafeVarargs
-  public final SELF contains(Map.Entry<KEY, VALUE>... entries) {
+  public final MultimapAssert<KEY, VALUE> contains(Map.Entry<KEY, VALUE>... entries) {
     MutableList<Pair<KEY, VALUE>> pairs = Lists.mutable.of(entries).collect(Tuples::pairFrom);
     return this.containsForProxy(pairs);
   }
@@ -110,7 +107,7 @@ public final SELF contains(Map.Entry<KEY, VALUE>... entries) {
    * @return this assertion object for method chaining.
    * @throws AssertionError if the actual {@code Multimap} does not contain one or more of the specified entries.
    */
-  protected SELF containsForProxy(MutableList<Pair<KEY, VALUE>> entries) {
+  protected MultimapAssert<KEY, VALUE> containsForProxy(MutableList<Pair<KEY, VALUE>> entries) {
     this.isNotNull();
     MutableList<Pair<KEY, VALUE>> entriesNotFound = entries
       .reject(entry -> this.actual.containsKeyAndValue(entry.getOne(), entry.getTwo()));
@@ -130,7 +127,7 @@ protected SELF containsForProxy(MutableList<Pair<KEY, VALUE>> entries) {
    * @see #contains(Pair[])
    * @see #contains(Map.Entry[])
    */
-  public SELF containsEntry(KEY key, VALUE value) {
+  public MultimapAssert<KEY, VALUE> containsEntry(KEY key, VALUE value) {
     return this.contains(Tuples.pair(key, value));
   }
 
@@ -152,7 +149,7 @@ public SELF containsEntry(KEY key, VALUE value) {
    * @return this assertion object for method chaining.
    * @throws AssertionError if the actual {@link Multimap} does not contain the given keys.
    */
-  public SELF containsKeys(KEY... keys) {
+  public MultimapAssert<KEY, VALUE> containsKeys(KEY... keys) {
     this.isNotNull();
     MutableList<KEY> keysNotFound = Lists.mutable.of(keys).reject(this.actual::containsKey);
     if (keysNotFound.isEmpty()) {
@@ -169,7 +166,7 @@ public SELF containsKeys(KEY... keys) {
    * @throws AssertionError if the actual {@link Multimap} does not contain only the given entries.
    */
   @SafeVarargs
-  public final SELF containsOnly(Map.Entry<? extends KEY, ? extends VALUE>... entries) {
+  public final MultimapAssert<KEY, VALUE> containsOnly(Map.Entry<? extends KEY, ? extends VALUE>... entries) {
     MutableList<Pair<? extends KEY, ? extends VALUE>> pairs = Lists.mutable.of(entries).collect(Tuples::pairFrom);
     return this.containsOnlyForProxy(pairs);
   }
@@ -182,7 +179,7 @@ public final SELF containsOnly(Map.Entry<? extends KEY, ? extends VALUE>... entr
    * @throws AssertionError if the actual {@link Multimap} does not contain only the given entries.
    */
   @SafeVarargs
-  public final SELF containsOnly(Pair<? extends KEY, ? extends VALUE>... entries) {
+  public final MultimapAssert<KEY, VALUE> containsOnly(Pair<? extends KEY, ? extends VALUE>... entries) {
     return this.containsOnlyForProxy(Lists.mutable.of(entries));
   }
 
@@ -193,7 +190,7 @@ public final SELF containsOnly(Pair<? extends KEY, ? extends VALUE>... entries)
    * @return this assertion object for method chaining
    * @throws AssertionError if the actual {@link Multimap} does not contain only the given entries.
    */
-  protected SELF containsOnlyForProxy(MutableList<Pair<? extends KEY, ? extends VALUE>> entries) {
+  protected MultimapAssert<KEY, VALUE> containsOnlyForProxy(MutableList<Pair<? extends KEY, ? extends VALUE>> entries) {
     this.isNotNull();
     PartitionMutableList<Pair<? extends KEY, ? extends VALUE>> partition = entries
       .partition(entry -> this.actual.containsKeyAndValue(entry.getOne(), entry.getTwo()));
@@ -217,7 +214,7 @@ protected SELF containsOnlyForProxy(MutableList<Pair<? extends KEY, ? extends VA
    * @return the current assertion object for method chaining
    * @throws AssertionError if the actual map does not contain the given values
    */
-  public SELF containsValues(VALUE... values) {
+  public MultimapAssert<KEY, VALUE> containsValues(VALUE... values) {
     this.isNotNull();
     MutableList<VALUE> valuesNotFound = Lists.mutable.of(values).reject(this.actual::containsValue);
     if (valuesNotFound.isEmpty()) {
@@ -233,7 +230,7 @@ public SELF containsValues(VALUE... values) {
    * @return this assertion object for method chaining.
    * @throws AssertionError if the actual number of distinct keys in the {@code Multimap} does not match the expected size.
    */
-  public SELF hasDistinctSize(int expected) {
+  public MultimapAssert<KEY, VALUE> hasDistinctSize(int expected) {
     this.isNotNull();
     int actualSize = this.actual.sizeDistinct();
     if (actualSize == expected) {
@@ -249,7 +246,7 @@ public SELF hasDistinctSize(int expected) {
    * @return this assertion object for method chaining.
    * @throws AssertionError if the actual distinct size of the {@link Multimap} is not greater than the specified boundary.
    */
-  public SELF hasDistinctSizeGreaterThan(int boundary) {
+  public MultimapAssert<KEY, VALUE> hasDistinctSizeGreaterThan(int boundary) {
     this.isNotNull();
     int actualSize = this.actual.sizeDistinct();
     if (actualSize > boundary) {
@@ -265,7 +262,7 @@ public SELF hasDistinctSizeGreaterThan(int boundary) {
    * @return this assertion for method chaining
    * @throws AssertionError if the distinct size of the collection is less than the specified boundary
    */
-  public SELF hasDistinctSizeGreaterThanOrEqualTo(int boundary) {
+  public MultimapAssert<KEY, VALUE> hasDistinctSizeGreaterThanOrEqualTo(int boundary) {
     this.isNotNull();
     int actualSize = this.actual.sizeDistinct();
     if (actualSize >= boundary) {
@@ -282,7 +279,7 @@ public SELF hasDistinctSizeGreaterThanOrEqualTo(int boundary) {
    * @throws NullPointerException if the provided condition is null.
    * @throws AssertionError       if none of the keys in the {@link Multimap} satisfy the given condition.
    */
-  public SELF hasKeySatisfying(Condition<? super KEY> keyCondition) {
+  public MultimapAssert<KEY, VALUE> hasKeySatisfying(Condition<? super KEY> keyCondition) {
     this.isNotNull();
     requireNonNull(keyCondition, "The condition to evaluate should not be null");
 
@@ -312,7 +309,7 @@ public SELF hasKeySatisfying(Condition<? super KEY> keyCondition) {
    * @return {@code this} assertion object.
    * @throws AssertionError if the actual size of the {@link Multimap} is not equal to the expected size.
    */
-  public SELF hasSize(int expected) {
+  public MultimapAssert<KEY, VALUE> hasSize(int expected) {
     this.isNotNull();
     int actualSize = this.actual.size();
     if (actualSize == expected) {
@@ -342,7 +339,7 @@ public SELF hasSize(int expected) {
    * @return {@code this} assertion object.
    * @throws AssertionError if the actual size of the {@link Multimap} is not between the given boundaries.
    */
-  public SELF hasSizeBetween(int lowerBoundary, int higherBoundary) {
+  public MultimapAssert<KEY, VALUE> hasSizeBetween(int lowerBoundary, int higherBoundary) {
     this.isNotNull();
     int actualSize = this.actual.size();
     if (actualSize >= lowerBoundary && actualSize <= higherBoundary) {
@@ -370,7 +367,7 @@ public SELF hasSizeBetween(int lowerBoundary, int higherBoundary) {
    * @return {@code this} assertion object.
    * @throws AssertionError if the actual size of the {@link Multimap} is not greater than the specified boundary.
    */
-  public SELF hasSizeGreaterThan(int boundary) {
+  public MultimapAssert<KEY, VALUE> hasSizeGreaterThan(int boundary) {
     this.isNotNull();
     int actualSize = this.actual.size();
     if (actualSize > boundary) {
@@ -400,7 +397,7 @@ public SELF hasSizeGreaterThan(int boundary) {
    * @return {@code this} assertion object for method chaining.
    * @throws AssertionError if the actual size of the {@link Multimap} is less than the expected size.
    */
-  public SELF hasSizeGreaterThanOrEqualTo(int boundary) {
+  public MultimapAssert<KEY, VALUE> hasSizeGreaterThanOrEqualTo(int boundary) {
     this.isNotNull();
     int actualSize = this.actual.size();
     if (actualSize >= boundary) {
@@ -428,7 +425,7 @@ public SELF hasSizeGreaterThanOrEqualTo(int boundary) {
    * @return {@code this} assertion object.
    * @throws AssertionError if the actual size of the {@link Multimap} is not less than the expected size.
    */
-  public SELF hasSizeLessThan(int boundary) {
+  public MultimapAssert<KEY, VALUE> hasSizeLessThan(int boundary) {
     this.isNotNull();
     int actualSize = this.actual.size();
     if (actualSize < boundary) {
@@ -457,7 +454,7 @@ public SELF hasSizeLessThan(int boundary) {
    * @return {@code this} assertion object for method chaining.
    * @throws AssertionError if the actual size of the {@link Multimap} is greater than the expected size.
    */
-  public SELF hasSizeLessThanOrEqualTo(int boundary) {
+  public MultimapAssert<KEY, VALUE> hasSizeLessThanOrEqualTo(int boundary) {
     this.isNotNull();
     int actualSize = this.actual.size();
     if (actualSize <= boundary) {
@@ -474,7 +471,7 @@ public SELF hasSizeLessThanOrEqualTo(int boundary) {
    * @throws NullPointerException if the provided condition is null.
    * @throws AssertionError       if none of the values in the {@link Multimap} satisfy the given condition.
    */
-  public SELF hasValueSatisfying(Condition<? super VALUE> valueCondition) {
+  public MultimapAssert<KEY, VALUE> hasValueSatisfying(Condition<? super VALUE> valueCondition) {
     this.isNotNull();
     requireNonNull(valueCondition, "The condition to evaluate should not be null");
 
@@ -522,7 +519,7 @@ public void isEmpty() {
    * @return this assertion object for method chaining
    * @throws AssertionError if the {@link Multimap} of values is empty.
    */
-  public SELF isNotEmpty() {
+  public MultimapAssert<KEY, VALUE> isNotEmpty() {
     this.isNotNull();
     if (!this.actual.isEmpty()) {
       return this.myself;