-
Notifications
You must be signed in to change notification settings - Fork 584
/
MutableBiMap.java
148 lines (113 loc) · 4.48 KB
/
MutableBiMap.java
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*
* Copyright (c) 2016 Goldman Sachs.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Eclipse Distribution License v. 1.0 which accompany this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*/
package org.eclipse.collections.api.bimap;
import java.util.Map;
import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.block.function.Function2;
import org.eclipse.collections.api.block.predicate.Predicate;
import org.eclipse.collections.api.block.predicate.Predicate2;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.map.MutableMapIterable;
import org.eclipse.collections.api.multimap.set.MutableSetMultimap;
import org.eclipse.collections.api.ordered.OrderedIterable;
import org.eclipse.collections.api.partition.set.PartitionMutableSet;
import org.eclipse.collections.api.set.MutableSet;
import org.eclipse.collections.api.tuple.Pair;
/**
* A {@link BiMap} whose contents can be altered after initialization.
*
* @since 4.2
*/
public interface MutableBiMap<K, V> extends BiMap<K, V>, MutableMapIterable<K, V>, Cloneable
{
@Override
MutableBiMap<K, V> newEmpty();
@Override
MutableBiMap<V, K> inverse();
@Override
MutableBiMap<V, K> flipUniqueValues();
@Override
MutableSetMultimap<V, K> flip();
/**
* Similar to {@link Map#put(Object, Object)}, except that it throws on the addition of a duplicate value.
*
* @throws IllegalArgumentException if the value already exists in the bimap.
*/
@Override
V put(K key, V value);
/**
* Similar to {@link #put(Object, Object)}, except that it quietly removes any existing entry with the same
* value before putting the key-value pair.
*/
V forcePut(K key, V value);
@Override
MutableBiMap<K, V> asSynchronized();
@Override
MutableBiMap<K, V> asUnmodifiable();
MutableBiMap<K, V> clone();
@Override
MutableBiMap<K, V> tap(Procedure<? super V> procedure);
@Override
MutableBiMap<K, V> select(Predicate2<? super K, ? super V> predicate);
@Override
MutableBiMap<K, V> reject(Predicate2<? super K, ? super V> predicate);
@Override
<K2, V2> MutableBiMap<K2, V2> collect(Function2<? super K, ? super V, Pair<K2, V2>> function);
@Override
<R> MutableBiMap<K, R> collectValues(Function2<? super K, ? super V, ? extends R> function);
@Override
MutableSet<V> select(Predicate<? super V> predicate);
@Override
<P> MutableSet<V> selectWith(Predicate2<? super V, ? super P> predicate, P parameter);
@Override
MutableSet<V> reject(Predicate<? super V> predicate);
@Override
<P> MutableSet<V> rejectWith(Predicate2<? super V, ? super P> predicate, P parameter);
@Override
PartitionMutableSet<V> partition(Predicate<? super V> predicate);
@Override
<P> PartitionMutableSet<V> partitionWith(Predicate2<? super V, ? super P> predicate, P parameter);
@Override
<S> MutableSet<S> selectInstancesOf(Class<S> clazz);
/**
* @deprecated in 8.0. Use {@link OrderedIterable#zip(Iterable)} instead.
*/
@Override
@Deprecated
<S> MutableSet<Pair<V, S>> zip(Iterable<S> that);
/**
* @deprecated in 8.0. Use {@link OrderedIterable#zipWithIndex()} instead.
*/
@Override
@Deprecated
MutableSet<Pair<V, Integer>> zipWithIndex();
@Override
<V1> MutableSetMultimap<V1, V> groupBy(Function<? super V, ? extends V1> function);
@Override
<V1> MutableSetMultimap<V1, V> groupByEach(Function<? super V, ? extends Iterable<V1>> function);
@Override
<VV> MutableBiMap<VV, V> groupByUniqueKey(Function<? super V, ? extends VV> function);
@Override
MutableBiMap<K, V> withKeyValue(K key, V value);
@Override
default MutableBiMap<K, V> withMap(Map<? extends K, ? extends V> map)
{
this.putAll(map);
return this;
}
@Override
MutableBiMap<K, V> withAllKeyValues(Iterable<? extends Pair<? extends K, ? extends V>> keyValues);
@Override
MutableBiMap<K, V> withAllKeyValueArguments(Pair<? extends K, ? extends V>... keyValuePairs);
@Override
MutableBiMap<K, V> withoutKey(K key);
@Override
MutableBiMap<K, V> withoutAllKeys(Iterable<? extends K> keys);
}