1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*
* Copyright (C) 2007 The Guava Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.common.collect;
import com.google.common.annotations.GwtCompatible;
import com.google.errorprone.annotations.DoNotMock;
import java.util.Map;
import org.checkerframework.checker.nullness.qual.Nullable;
/**
* An object representing the differences between two maps.
*
* @author Kevin Bourrillion
* @since 2.0
*/
@DoNotMock("Use Maps.difference")
@GwtCompatible
public interface MapDifference<K, V> {
/**
* Returns {@code true} if there are no differences between the two maps; that is, if the maps are
* equal.
*/
boolean areEqual();
/**
* Returns an unmodifiable map containing the entries from the left map whose keys are not present
* in the right map.
*/
Map<K, V> entriesOnlyOnLeft();
/**
* Returns an unmodifiable map containing the entries from the right map whose keys are not
* present in the left map.
*/
Map<K, V> entriesOnlyOnRight();
/**
* Returns an unmodifiable map containing the entries that appear in both maps; that is, the
* intersection of the two maps.
*/
Map<K, V> entriesInCommon();
/**
* Returns an unmodifiable map describing keys that appear in both maps, but with different
* values.
*/
Map<K, ValueDifference<V>> entriesDiffering();
/**
* Compares the specified object with this instance for equality. Returns {@code true} if the
* given object is also a {@code MapDifference} and the values returned by the {@link
* #entriesOnlyOnLeft()}, {@link #entriesOnlyOnRight()}, {@link #entriesInCommon()} and {@link
* #entriesDiffering()} of the two instances are equal.
*/
@Override
boolean equals(@Nullable Object object);
/**
* Returns the hash code for this instance. This is defined as the hash code of
*
* <pre>{@code
* Arrays.asList(entriesOnlyOnLeft(), entriesOnlyOnRight(),
* entriesInCommon(), entriesDiffering())
* }</pre>
*/
@Override
int hashCode();
/**
* A difference between the mappings from two maps with the same key. The {@link #leftValue} and
* {@link #rightValue} are not equal, and one but not both of them may be null.
*
* @since 2.0
*/
@DoNotMock("Use Maps.difference")
interface ValueDifference<V> {
/** Returns the value from the left map (possibly null). */
V leftValue();
/** Returns the value from the right map (possibly null). */
V rightValue();
/**
* Two instances are considered equal if their {@link #leftValue()} values are equal and their
* {@link #rightValue()} values are also equal.
*/
@Override
boolean equals(@Nullable Object other);
/**
* The hash code equals the value {@code Arrays.asList(leftValue(), rightValue()).hashCode()}.
*/
@Override
int hashCode();
}
}
|
