All Known Subinterfaces:: SortedMapDifference<K,V>

@DoNotMock("Use Maps.difference")
@GwtCompatible
public interface MapDifference<K extends @Nullable Object,V extends @Nullable Object>

An object representing the differences between two maps.

Since:: 2.0
Author:: Kevin Bourrillion

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`MapDifference.ValueDifference<V extends @Nullable Object>`	A difference between the mappings from two maps with the same key.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`areEqual()`	Returns `true` if there are no differences between the two maps; that is, if the maps are equal.
`Map<K,MapDifference.ValueDifference<V>>`	`entriesDiffering()`	Returns an unmodifiable map describing keys that appear in both maps, but with different values.
`Map<K,V>`	`entriesInCommon()`	Returns an unmodifiable map containing the entries that appear in both maps; that is, the intersection of the two maps.
`Map<K,V>`	`entriesOnlyOnLeft()`	Returns an unmodifiable map containing the entries from the left map whose keys are not present in the right map.
`Map<K,V>`	`entriesOnlyOnRight()`	Returns an unmodifiable map containing the entries from the right map whose keys are not present in the left map.
`boolean`	`equals(Object object)`	Compares the specified object with this instance for equality.
`int`	`hashCode()`	Returns the hash code for this instance.

- Method Detail
  - areEqual
```
boolean areEqual()
```
    Returns true if there are no differences between the two maps; that is, if the maps are equal.
  - entriesOnlyOnLeft
```
Map<K,V> entriesOnlyOnLeft()
```
    Returns an unmodifiable map containing the entries from the left map whose keys are not present in the right map.
  - entriesOnlyOnRight
```
Map<K,V> entriesOnlyOnRight()
```
    Returns an unmodifiable map containing the entries from the right map whose keys are not present in the left map.
  - entriesInCommon
```
Map<K,V> entriesInCommon()
```
    Returns an unmodifiable map containing the entries that appear in both maps; that is, the intersection of the two maps.
  - entriesDiffering
```
Map<K,MapDifference.ValueDifference<V>> entriesDiffering()
```
    Returns an unmodifiable map describing keys that appear in both maps, but with different values.
  - equals
```
boolean equals(@CheckForNull
               Object object)
```
    Compares the specified object with this instance for equality. Returns true if the given object is also a MapDifference and the values returned by the entriesOnlyOnLeft(), entriesOnlyOnRight(), entriesInCommon() and entriesDiffering() of the two instances are equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
    
    See Also:
    
    Object.hashCode(), HashMap
  - hashCode
```
int hashCode()
```
    Returns the hash code for this instance. This is defined as the hash code of
    Arrays.asList(entriesOnlyOnLeft(), entriesOnlyOnRight(), entriesInCommon(), entriesDiffering())
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.
    
    See Also:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

Interface MapDifference<K extends @Nullable Object,​V extends @Nullable Object>

Nested Class Summary

Method Summary

Method Detail

areEqual

entriesOnlyOnLeft

entriesOnlyOnRight

entriesInCommon

entriesDiffering

equals

hashCode

Interface MapDifference<K extends @Nullable Object,V extends @Nullable Object>