2 * (C) Copyright 2016 Pantheon Technologies, s.r.o. and others.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 package org.opendaylight.yangtools.triemap;
18 import static com.google.common.base.Preconditions.checkNotNull;
19 import static org.opendaylight.yangtools.triemap.LookupResult.RESTART;
21 import com.google.common.annotations.Beta;
22 import java.io.ObjectStreamException;
23 import java.io.Serializable;
24 import java.util.AbstractMap;
25 import java.util.Optional;
27 import java.util.concurrent.ConcurrentMap;
30 * This is a port of Scala's TrieMap class from the Scala Collections library. This implementation does not support
31 * null keys nor null values.
33 * @author Aleksandar Prokopec (original Scala implementation)
34 * @author Roman Levenstein (original Java 6 port)
35 * @author Robert Varga
37 * @param <K> the type of keys maintained by this map
38 * @param <V> the type of mapped values
41 public abstract class TrieMap<K, V> extends AbstractMap<K, V> implements ConcurrentMap<K,V>, Serializable {
42 private static final long serialVersionUID = 1L;
44 private final Equivalence<? super K> equiv;
46 private AbstractEntrySet<K, V> entrySet;
47 private AbstractKeySet<K> keySet;
49 TrieMap(final Equivalence<? super K> equiv) {
53 public static <K, V> TrieMap<K, V> create() {
54 return new MutableTrieMap<>(Equivalence.equals());
58 * Returns a snapshot of this TrieMap. This operation is lock-free and
61 * The snapshot is lazily updated - the first time some branch in the
62 * snapshot or this TrieMap are accessed, they are rewritten. This means
63 * that the work of rebuilding both the snapshot and this TrieMap is
64 * distributed across all the threads doing updates or accesses subsequent
65 * to the snapshot creation.
67 public abstract TrieMap<K, V> mutableSnapshot();
70 * Returns a read-only snapshot of this TrieMap. This operation is lock-free
73 * The snapshot is lazily updated - the first time some branch of this
74 * TrieMap are accessed, it is rewritten. The work of creating the snapshot
75 * is thus distributed across subsequent updates and accesses on this
76 * TrieMap by all threads. Note that the snapshot itself is never rewritten
77 * unlike when calling the `snapshot` method, but the obtained snapshot
80 * This method is used by other methods such as `size` and `iterator`.
82 public abstract ImmutableTrieMap<K, V> immutableSnapshot();
85 public final boolean containsKey(final Object key) {
86 return get(key) != null;
90 public final boolean containsValue(final Object value) {
91 return super.containsValue(checkNotNull(value));
95 public final Set<Entry<K, V>> entrySet() {
96 AbstractEntrySet<K, V> ret = entrySet;
98 entrySet = ret = createEntrySet();
104 public final Set<K> keySet() {
105 AbstractKeySet<K> ret = keySet;
107 keySet = ret = createKeySet();
113 public final V get(final Object key) {
114 @SuppressWarnings("unchecked")
115 final K k = (K) checkNotNull(key);
116 return lookuphc(k, computeHash(k));
120 public abstract void clear();
123 public abstract V put(K key, V value);
126 public abstract V putIfAbsent(K key, V value);
129 public abstract V remove(Object key);
132 public abstract boolean remove(Object key, Object value);
135 public abstract boolean replace(K key, V oldValue, V newValue);
138 public abstract V replace(K key, V value);
141 public abstract int size();
143 /* internal methods implemented by subclasses */
145 abstract AbstractEntrySet<K, V> createEntrySet();
147 abstract AbstractKeySet<K> createKeySet();
149 abstract boolean isReadOnly();
151 abstract INode<K, V> RDCSS_READ_ROOT(boolean abort);
154 * Return an iterator over a TrieMap.
156 * If this is a read-only snapshot, it would return a read-only iterator.
158 * If it is the original TrieMap or a non-readonly snapshot, it would return
159 * an iterator that would allow for updates.
163 abstract AbstractIterator<K, V> iterator();
165 /* internal methods provided for subclasses */
168 * Return an iterator over a TrieMap.
169 * This is a read-only iterator.
173 final ImmutableIterator<K, V> immutableIterator() {
174 return new ImmutableIterator<>(immutableSnapshot());
177 @SuppressWarnings("null")
178 static <V> V toNullable(final Optional<V> opt) {
179 return opt.orElse(null);
182 final int computeHash(final K k) {
183 return equiv.hash(k);
186 final Object writeReplace() throws ObjectStreamException {
187 return new SerializationProxy(immutableSnapshot(), isReadOnly());
190 /* package-protected utility methods */
192 final Equivalence<? super K> equiv() {
196 final INode<K, V> readRoot() {
197 return RDCSS_READ_ROOT(false);
200 // FIXME: abort = false by default
201 final INode<K, V> readRoot(final boolean abort) {
202 return RDCSS_READ_ROOT(abort);
205 final INode<K, V> RDCSS_READ_ROOT() {
206 return RDCSS_READ_ROOT(false);
209 final boolean equal(final K k1, final K k2) {
210 return equiv.equivalent(k1, k2);
213 /* private implementation methods */
215 @SuppressWarnings("unchecked")
216 private V lookuphc(final K k, final int hc) {
219 // Keep looping as long as RESTART is being indicated
220 res = RDCSS_READ_ROOT().rec_lookup(k, hc, 0, null, this);
221 } while (res == RESTART);