org.fest.assertions.internal

Class Maps

java.lang.Object

org.fest.assertions.internal.Maps

public class Maps
extends java.lang.Object

Reusable assertions for Maps.

Author:

Alex Ruiz, Nicolas François

Method Summary

Modifier and Type	Method and Description
void	assertContains(AssertionInfo info, java.util.Map<?,?> actual, MapEntry[] entries) Asserts that the given Map contains the given entries, in any order.
<K,V> void	assertContainsKey(AssertionInfo info, java.util.Map<K,V> actual, K key) Verifies that the actual map contain the given key.
<K,V> void	assertContainsValue(AssertionInfo info, java.util.Map<K,V> actual, V value) Verifies that the actual map contain the given value.
void	assertDoesNotContain(AssertionInfo info, java.util.Map<?,?> actual, MapEntry[] entries) Asserts that the given Map does not contain the given entries.
<K,V> void	assertDoesNotContainKey(AssertionInfo info, java.util.Map<K,V> actual, K key) Verifies that the actual map not contains the given key.
<K,V> void	assertDoesNotContainValue(AssertionInfo info, java.util.Map<K,V> actual, V value) Verifies that the actual map not contains the given value.
void	assertEmpty(AssertionInfo info, java.util.Map<?,?> actual) Asserts that the given Map is empty.
void	assertHasSameSizeAs(AssertionInfo info, java.util.Map<?,?> map, java.lang.Iterable<?> other) Asserts that the number of entries in the given Map has the same size as the other Iterable.
void	assertHasSameSizeAs(AssertionInfo info, java.util.Map<?,?> map, java.lang.Object[] other) Asserts that the number of entries in the given Map has the same size as the other array.
void	assertHasSize(AssertionInfo info, java.util.Map<?,?> actual, int expectedSize) Asserts that the number of entries in the given Map is equal to the expected one.
void	assertNotEmpty(AssertionInfo info, java.util.Map<?,?> actual) Asserts that the given Map is not empty.
void	assertNullOrEmpty(AssertionInfo info, java.util.Map<?,?> actual) Asserts that the given Map is null or empty.
static Maps	instance() Returns the singleton instance of this class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

instance

public static Maps instance()

Returns the singleton instance of this class.

Returns:

the singleton instance of this class.

assertNullOrEmpty

public void assertNullOrEmpty(AssertionInfo info,
                              java.util.Map<?,?> actual)

Asserts that the given Map is null or empty.

Parameters:

info - contains information about the assertion.

actual - the given map.

Throws:

java.lang.AssertionError - if the given Map is not null *and* contains one or more entries.

assertEmpty

public void assertEmpty(AssertionInfo info,
                        java.util.Map<?,?> actual)

Asserts that the given Map is empty.

Parameters:

info - contains information about the assertion.

actual - the given Map.

Throws:

java.lang.AssertionError - if the given Map is null.

java.lang.AssertionError - if the given Map is not empty.

assertNotEmpty

public void assertNotEmpty(AssertionInfo info,
                           java.util.Map<?,?> actual)

Asserts that the given Map is not empty.

Parameters:

info - contains information about the assertion.

actual - the given Map.

Throws:

java.lang.AssertionError - if the given Map is null.

java.lang.AssertionError - if the given Map is empty.

assertHasSize

public void assertHasSize(AssertionInfo info,
                          java.util.Map<?,?> actual,
                          int expectedSize)

Asserts that the number of entries in the given Map is equal to the expected one.

Parameters:

info - contains information about the assertion.

actual - the given Map.

expectedSize - the expected size of actual.

Throws:

java.lang.AssertionError - if the given Map is null.

java.lang.AssertionError - if the number of entries in the given Map is different than the expected one.

assertHasSameSizeAs

public void assertHasSameSizeAs(AssertionInfo info,
                                java.util.Map<?,?> map,
                                java.lang.Iterable<?> other)

Asserts that the number of entries in the given Map has the same size as the other Iterable.

Parameters:

info - contains information about the assertion.

map - the given Map.

other - the group to compare

Throws:

java.lang.AssertionError - if the given Map is null.

java.lang.AssertionError - if the given Iterable is null.

java.lang.AssertionError - if the number of entries in the given Map does not have the same size.

assertHasSameSizeAs

public void assertHasSameSizeAs(AssertionInfo info,
                                java.util.Map<?,?> map,
                                java.lang.Object[] other)

Asserts that the number of entries in the given Map has the same size as the other array.

Parameters:

info - contains information about the assertion.

map - the given Map.

other - the group to compare

Throws:

java.lang.AssertionError - if the given Map is null.

java.lang.AssertionError - if the given array is null.

java.lang.AssertionError - if the number of entries in the given Map does not have the same size.

assertContains

public void assertContains(AssertionInfo info,
                           java.util.Map<?,?> actual,
                           MapEntry[] entries)

Asserts that the given Map contains the given entries, in any order.

Parameters:

info - contains information about the assertion.

actual - the given Map.

entries - the entries that are expected to be in the given Map.

Throws:

java.lang.NullPointerException - if the array of entries is null.

java.lang.IllegalArgumentException - if the array of entries is empty.

java.lang.NullPointerException - if any of the entries in the given array is null.

java.lang.AssertionError - if the given Map is null.

java.lang.AssertionError - if the given Map does not contain the given entries.

assertDoesNotContain

public void assertDoesNotContain(AssertionInfo info,
                                 java.util.Map<?,?> actual,
                                 MapEntry[] entries)

Asserts that the given Map does not contain the given entries.

Parameters:

info - contains information about the assertion.

actual - the given Map.

entries - the entries that are expected to be in the given Map.

Throws:

java.lang.NullPointerException - if the array of entries is null.

java.lang.IllegalArgumentException - if the array of entries is empty.

java.lang.NullPointerException - if any of the entries in the given array is null.

java.lang.AssertionError - if the given Map is null.

java.lang.AssertionError - if the given Map contains any of the given entries.

assertContainsKey

public <K,V> void assertContainsKey(AssertionInfo info,
                                    java.util.Map<K,V> actual,
                                    K key)

Verifies that the actual map contain the given key.

Parameters:

info - contains information about the assertion.

actual - the given Map.

key - the given key

Throws:

java.lang.AssertionError - if the actual map is null.

java.lang.AssertionError - if the actual map not contains the given key.

assertDoesNotContainKey

public <K,V> void assertDoesNotContainKey(AssertionInfo info,
                                          java.util.Map<K,V> actual,
                                          K key)

Verifies that the actual map not contains the given key.

Parameters:

info - contains information about the assertion.

actual - the given Map.

key - the given key

Throws:

java.lang.AssertionError - if the actual map is null.

java.lang.AssertionError - if the actual map contains the given key.

assertContainsValue

public <K,V> void assertContainsValue(AssertionInfo info,
                                      java.util.Map<K,V> actual,
                                      V value)

Verifies that the actual map contain the given value.

Parameters:

info - contains information about the assertion.

actual - the given Map.

value - the given value

Throws:

java.lang.AssertionError - if the actual map is null.

java.lang.AssertionError - if the actual map not contains the given value.

assertDoesNotContainValue

public <K,V> void assertDoesNotContainValue(AssertionInfo info,
                                            java.util.Map<K,V> actual,
                                            V value)

Verifies that the actual map not contains the given value.

Parameters:

info - contains information about the assertion.

actual - the given Map.

value - the given value

Throws:

java.lang.AssertionError - if the actual map is null.

java.lang.AssertionError - if the actual map contains the given value.