third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/TrieMap.java

   1 /*
   2  * (C) Copyright 2016 Pantheon Technologies, s.r.o. and others.
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16 package org.opendaylight.yangtools.triemap;
  17
  18 import static com.google.common.base.Preconditions.checkNotNull;
  19 import static org.opendaylight.yangtools.triemap.LookupResult.RESTART;
  20
  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;
  26 import java.util.Set;
  27 import java.util.concurrent.ConcurrentMap;
  28
  29 /**
  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.
  32  *
  33  * @author Aleksandar Prokopec (original Scala implementation)
  34  * @author Roman Levenstein (original Java 6 port)
  35  * @author Robert Varga
  36  *
  37  * @param <K> the type of keys maintained by this map
  38  * @param <V> the type of mapped values
  39  */
  40 @Beta
  41 public abstract class TrieMap<K, V> extends AbstractMap<K, V> implements ConcurrentMap<K,V>, Serializable {
  42     private static final long serialVersionUID = 1L;
  43
  44     private final Equivalence<? super K> equiv;
  45
  46     private AbstractEntrySet<K, V> entrySet;
  47     private AbstractKeySet<K> keySet;
  48
  49     TrieMap(final Equivalence<? super K> equiv) {
  50         this.equiv = equiv;
  51     }
  52
  53     public static <K, V> MutableTrieMap<K, V> create() {
  54         return new MutableTrieMap<>(Equivalence.equals());
  55     }
  56
  57     /**
  58      * Returns a snapshot of this TrieMap. This operation is lock-free and
  59      * linearizable.
  60      *
  61      * <p>
  62      * The snapshot is lazily updated - the first time some branch in the
  63      * snapshot or this TrieMap are accessed, they are rewritten. This means
  64      * that the work of rebuilding both the snapshot and this TrieMap is
  65      * distributed across all the threads doing updates or accesses subsequent
  66      * to the snapshot creation.
  67      */
  68     public abstract TrieMap<K, V> mutableSnapshot();
  69
  70     /**
  71      * Returns a read-only snapshot of this TrieMap. This operation is lock-free
  72      * and linearizable.
  73      *
  74      * <p>
  75      * The snapshot is lazily updated - the first time some branch of this
  76      * TrieMap are accessed, it is rewritten. The work of creating the snapshot
  77      * is thus distributed across subsequent updates and accesses on this
  78      * TrieMap by all threads. Note that the snapshot itself is never rewritten
  79      * unlike when calling the `snapshot` method, but the obtained snapshot
  80      * cannot be modified.
  81      *
  82      * <p>
  83      * This method is used by other methods such as `size` and `iterator`.
  84      */
  85     public abstract ImmutableTrieMap<K, V> immutableSnapshot();
  86
  87     @Override
  88     public final boolean containsKey(final Object key) {
  89         return get(key) != null;
  90     }
  91
  92     @Override
  93     public final boolean containsValue(final Object value) {
  94         return super.containsValue(checkNotNull(value));
  95     }
  96
  97     @Override
  98     public final Set<Entry<K, V>> entrySet() {
  99         final AbstractEntrySet<K, V> ret;
 100         return (ret = entrySet) != null ? ret : (entrySet = createEntrySet());
 101     }
 102
 103     @Override
 104     public final Set<K> keySet() {
 105         final AbstractKeySet<K> ret;
 106         return (ret = keySet) != null ? ret : (keySet = createKeySet());
 107     }
 108
 109     @Override
 110     public final V get(final Object key) {
 111         @SuppressWarnings("unchecked")
 112         final K k = (K) checkNotNull(key);
 113         return lookuphc(k, computeHash(k));
 114     }
 115
 116     @Override
 117     public abstract void clear();
 118
 119     @Override
 120     public abstract V put(K key, V value);
 121
 122     @Override
 123     public abstract V putIfAbsent(K key, V value);
 124
 125     @Override
 126     public abstract V remove(Object key);
 127
 128     @Override
 129     public abstract boolean remove(Object key, Object value);
 130
 131     @Override
 132     public abstract boolean replace(K key, V oldValue, V newValue);
 133
 134     @Override
 135     public abstract V replace(K key, V value);
 136
 137     @Override
 138     public abstract int size();
 139
 140     /* internal methods implemented by subclasses */
 141
 142     abstract AbstractEntrySet<K, V> createEntrySet();
 143
 144     abstract AbstractKeySet<K> createKeySet();
 145
 146     abstract boolean isReadOnly();
 147
 148     abstract INode<K, V> RDCSS_READ_ROOT(boolean abort);
 149
 150     /**
 151      * Return an iterator over a TrieMap.
 152      *
 153      * <p>
 154      * If this is a read-only snapshot, it would return a read-only iterator.
 155      *
 156      * <p>
 157      * If it is the original TrieMap or a non-readonly snapshot, it would return
 158      * an iterator that would allow for updates.
 159      *
 160      * @return An iterator.
 161      */
 162     abstract AbstractIterator<K, V> iterator();
 163
 164     /* internal methods provided for subclasses */
 165
 166     /**
 167      * Return an iterator over a TrieMap. This is a read-only iterator.
 168      *
 169      * @return A read-only iterator.
 170      */
 171     final ImmutableIterator<K, V> immutableIterator() {
 172         return new ImmutableIterator<>(immutableSnapshot());
 173     }
 174
 175     @SuppressWarnings("null")
 176     static <V> V toNullable(final Optional<V> opt) {
 177         return opt.orElse(null);
 178     }
 179
 180     final int computeHash(final K key) {
 181         return equiv.hash(key);
 182     }
 183
 184     final Object writeReplace() throws ObjectStreamException {
 185         return new SerializationProxy(immutableSnapshot(), isReadOnly());
 186     }
 187
 188     /* package-protected utility methods */
 189
 190     final Equivalence<? super K> equiv() {
 191         return equiv;
 192     }
 193
 194     final INode<K, V> readRoot() {
 195         return RDCSS_READ_ROOT(false);
 196     }
 197
 198     // FIXME: abort = false by default
 199     final INode<K, V> readRoot(final boolean abort) {
 200         return RDCSS_READ_ROOT(abort);
 201     }
 202
 203     final INode<K, V> RDCSS_READ_ROOT() {
 204         return RDCSS_READ_ROOT(false);
 205     }
 206
 207     final boolean equal(final K k1, final K k2) {
 208         return equiv.equivalent(k1, k2);
 209     }
 210
 211     /* private implementation methods */
 212
 213     @SuppressWarnings("unchecked")
 214     private V lookuphc(final K key, final int hc) {
 215         Object res;
 216         do {
 217             // Keep looping as long as RESTART is being indicated
 218             res = RDCSS_READ_ROOT().rec_lookup(key, hc, 0, null, this);
 219         } while (res == RESTART);
 220
 221         return (V) res;
 222     }
 223 }