Adds Multimap assertions and assumptions (#77)

Fixes #77

Author: mchmielarz

src/main/java/org/assertj/vavr/api/AbstractMapAssert.java

@@ -78,7 +78,7 @@ public SELF allSatisfy(BiConsumer<? super KEY, ? super VALUE> entryRequirements)
      * @return {@code this} assertion object.
      * @throws NullPointerException if the given values is {@code null}.
      * @throws AssertionError       if the actual map is {@code null}.
-     * @throws AssertionError       if the actual map not contains the given {@code key}.
+     * @throws AssertionError       if the actual map does not contain the given {@code key}.
      * @throws AssertionError       if the actual map contains the given key, but value does not match the given {@code valueCondition}.
      */
     public SELF hasEntrySatisfying(KEY key, Condition<? super VALUE> valueCondition) {

src/main/java/org/assertj/vavr/api/AbstractMultimapAssert.java

@@ -0,0 +1,18 @@
+package org.assertj.vavr.api;
+
+import io.vavr.collection.Multimap;
+
+/**
+ * Assertions for {@link io.vavr.collection.Multimap}.
+ *
+ * @param <KEY>   key type of the {@link Multimap}.
+ * @param <VALUE> value type of the {@link Multimap}.
+ * @author Michał Chmielarz
+ */
+public class MultimapAssert<KEY, VALUE> extends AbstractMultimapAssert<MultimapAssert<KEY, VALUE>, Multimap<KEY, VALUE>, KEY, VALUE> {
+
+    MultimapAssert(Multimap<KEY, VALUE> multimap) {
+        super(multimap, MultimapAssert.class);
+    }
+
+}

src/main/java/org/assertj/vavr/api/MultimapAssert.java

@@ -4,7 +4,7 @@
 import org.assertj.core.error.ErrorMessageFactory;
 
 /**
- * Creates an error message indicating that an assertion that verifies a map does not contains values.
+ * Creates an error message indicating that an assertion that verifies a map does not contain values.
  * 
  * @author Michał Chmielarz
  */

src/main/java/org/assertj/vavr/api/ShouldNotContainValues.java

@@ -15,6 +15,7 @@
 import io.vavr.Lazy;
 import io.vavr.collection.List;
 import io.vavr.collection.Map;
+import io.vavr.collection.Multimap;
 import io.vavr.collection.Seq;
 import io.vavr.control.Either;
 import io.vavr.control.Option;
@@ -35,7 +36,7 @@ private VavrAssertions() {
     }
 
     /**
-     * Create assertion for {@link io.vavr.control.Either}.
+     * Creates assertion for {@link io.vavr.control.Either}.
      *
      * @param <LEFT>  the type of a value contained on left by <code>actual {@link Either}</code>.
      * @param <RIGHT> the type of a value contained on right by <code>actual {@link Either}</code>.
@@ -48,7 +49,7 @@ public static <LEFT, RIGHT> EitherAssert<LEFT, RIGHT> assertThat(Either<LEFT, RI
     }
 
     /**
-     * Create assertion for {@link Lazy}.
+     * Creates assertion for {@link Lazy}.
      *
      * @param <VALUE> the type of a value contained by <code>actual {@link Lazy}</code>.
      * @param actual  the actual value.
@@ -60,7 +61,7 @@ public static <VALUE> LazyAssert<VALUE> assertThat(Lazy<VALUE> actual) {
     }
 
     /**
-     * Create assertion for {@link io.vavr.control.Option}.
+     * Creates assertion for {@link io.vavr.control.Option}.
      *
      * @param <VALUE> the type of a value contained by <code>actual {@link Option}</code>.
      * @param actual  the actual value.
@@ -72,7 +73,7 @@ public static <VALUE> OptionAssert<VALUE> assertThat(Option<VALUE> actual) {
     }
 
     /**
-     * Create assertion for {@link io.vavr.control.Try}.
+     * Creates assertion for {@link io.vavr.control.Try}.
      *
      * @param <VALUE> the type of a value contained by <code>actual {@link Try}</code>.
      * @param actual  the actual value.
@@ -84,7 +85,7 @@ public static <VALUE> TryAssert<VALUE> assertThat(Try<VALUE> actual) {
     }
 
     /**
-     * Create assertion for {@link io.vavr.collection.List}.
+     * Creates assertion for {@link io.vavr.collection.List}.
      *
      * @param <VALUE> the type of elements contained by <code>actual {@link List}</code>.
      * @param actual  the actual value.
@@ -96,7 +97,7 @@ public static <VALUE> SeqAssert<VALUE> assertThat(Seq<VALUE> actual) {
     }
 
     /**
-     * Create assertion for {@link io.vavr.control.Validation}.
+     * Creates assertion for {@link io.vavr.control.Validation}.
      *
      * @param <INVALID> type of the value in the case of the invalid {@link Validation}.
      * @param <VALID>   type of the value in the case of the valid {@link Validation}.
@@ -109,7 +110,7 @@ public static <INVALID, VALID> ValidationAssert<INVALID, VALID> assertThat(Valid
     }
 
     /**
-     * Create assertion for {@link io.vavr.collection.Map}.
+     * Creates assertion for {@link io.vavr.collection.Map}.
      *
      * @param <KEY>   key type of the {@link Map}.
      * @param <VALUE> value type of the {@link Map}.
@@ -121,4 +122,17 @@ public static <KEY, VALUE> MapAssert<KEY, VALUE> assertThat(Map<KEY, VALUE> actu
         return new MapAssert<>(actual);
     }
 
+    /**
+     * Creates assertion for {@link io.vavr.collection.Multimap}.
+     *
+     * @param <KEY>   key type of the {@link Multimap}.
+     * @param <VALUE> value type of the {@link Multimap}.
+     * @param actual  the actual value.
+     * @return the created assertion object.
+     */
+    @CheckReturnValue
+    public static <KEY, VALUE> MultimapAssert<KEY, VALUE> assertThat(Multimap<KEY, VALUE> actual) {
+        return new MultimapAssert<>(actual);
+    }
+
 }

src/main/java/org/assertj/vavr/api/VavrAssertions.java

@@ -2,6 +2,7 @@
 
 import io.vavr.Lazy;
 import io.vavr.collection.Map;
+import io.vavr.collection.Multimap;
 import io.vavr.collection.Seq;
 import io.vavr.control.Either;
 import io.vavr.control.Option;
@@ -98,6 +99,20 @@ public static <VALUE> AbstractLazyAssert<?, VALUE> assumeThat(Lazy<VALUE> actual
         return asAssumption(MapAssert.class, Map.class, actual);
     }
 
+    /**
+     * Creates a new instance of <code>{@link MultimapAssert}</code> assumption.
+     *
+     * @param <K>    the type of keys in the multimap.
+     * @param <V>    the type of values in the multimap.
+     * @param actual the actual value.
+     * @return the created assumption for assertion object.
+     */
+    @CheckReturnValue
+    @SuppressWarnings("unchecked")
+    public static <K, V> AbstractMultimapAssert<?, ?, K, V> assumeThat(Multimap<K, V> actual) {
+        return asAssumption(MultimapAssert.class, Multimap.class, actual);
+    }
+
     /**
      * Creates a new instance of <code>{@link OptionAssert}</code> assumption.
      *