common/util/src/main/java/org/opendaylight/yangtools/util/ImmutableOffsetMap.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.util;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.collect.ImmutableMap;
  15 import com.google.common.collect.UnmodifiableIterator;
  16 import java.io.IOException;
  17 import java.io.ObjectInputStream;
  18 import java.io.ObjectOutputStream;
  19 import java.io.Serializable;
  20 import java.lang.reflect.Field;
  21 import java.util.AbstractMap.SimpleImmutableEntry;
  22 import java.util.AbstractSet;
  23 import java.util.ArrayList;
  24 import java.util.Arrays;
  25 import java.util.Collection;
  26 import java.util.Iterator;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.Set;
  30 import org.eclipse.jdt.annotation.NonNull;
  31 import org.eclipse.jdt.annotation.Nullable;
  32
  33 /**
  34  * Implementation of the {@link Map} interface which stores a set of immutable mappings using a key-to-offset map and
  35  * a backing array. This is useful for situations where the same key set is shared across a multitude of maps, as this
  36  * class uses a global cache to share the key-to-offset mapping.
  37  *
  38  * <p>
  39  * In case the set of keys is statically known, you can use {@link ImmutableOffsetMapTemplate} to efficiently create
  40  * {@link ImmutableOffsetMap} instances.
  41  *
  42  * @param <K> the type of keys maintained by this map
  43  * @param <V> the type of mapped values
  44  */
  45 @Beta
  46 public abstract class ImmutableOffsetMap<K, V> implements UnmodifiableMapPhase<K, V>, Serializable {
  47     static final class Ordered<K, V> extends ImmutableOffsetMap<K, V> {
  48         private static final long serialVersionUID = 1L;
  49
  50         Ordered(final ImmutableMap<K, Integer> offsets, final V[] objects) {
  51             super(offsets, objects);
  52         }
  53
  54         @Override
  55         public @NonNull MutableOffsetMap<K, V> toModifiableMap() {
  56             return MutableOffsetMap.orderedCopyOf(this);
  57         }
  58
  59         @Override
  60         void setFields(final List<K> keys, final V[] values) throws IOException {
  61             setField(this, OFFSETS_FIELD, OffsetMapCache.orderedOffsets(keys));
  62             setField(this, ARRAY_FIELD, values);
  63         }
  64     }
  65
  66     static final class Unordered<K, V> extends ImmutableOffsetMap<K, V> {
  67         private static final long serialVersionUID = 1L;
  68
  69         Unordered(final ImmutableMap<K, Integer> offsets, final V[] objects) {
  70             super(offsets, objects);
  71         }
  72
  73         @Override
  74         public @NonNull MutableOffsetMap<K, V> toModifiableMap() {
  75             return MutableOffsetMap.unorderedCopyOf(this);
  76         }
  77
  78         @Override
  79         void setFields(final List<K> keys, final V[] values) throws IOException {
  80             final Map<K, Integer> newOffsets = OffsetMapCache.unorderedOffsets(keys);
  81
  82             setField(this, OFFSETS_FIELD, newOffsets);
  83             setField(this, ARRAY_FIELD, OffsetMapCache.adjustedArray(newOffsets, keys, values));
  84         }
  85     }
  86
  87     private static final long serialVersionUID = 1L;
  88
  89     private final transient @NonNull ImmutableMap<K, Integer> offsets;
  90     private final transient @NonNull V[] objects;
  91     private transient int hashCode;
  92
  93     /**
  94      * Construct a new instance backed by specified key-to-offset map and array of objects.
  95      *
  96      * @param offsets Key-to-offset map, may not be null
  97      * @param objects Array of value object, may not be null. The array is stored as is, the caller
  98      *              is responsible for ensuring its contents remain unmodified.
  99      */
 100     ImmutableOffsetMap(final ImmutableMap<K, Integer> offsets, final V[] objects) {
 101         this.offsets = requireNonNull(offsets);
 102         this.objects = requireNonNull(objects);
 103         checkArgument(offsets.size() == objects.length);
 104     }
 105
 106     @Override
 107     public abstract @NonNull MutableOffsetMap<K, V> toModifiableMap();
 108
 109     abstract void setFields(List<K> keys, V[] values) throws IOException;
 110
 111     /**
 112      * Create an {@link ImmutableOffsetMap} as a copy of an existing map. This is actually not completely true, as this
 113      * method returns an {@link ImmutableMap} for empty and singleton inputs, as those are more memory-efficient. This
 114      * method also recognizes {@link ImmutableOffsetMap} and {@link SharedSingletonMap} on input, and returns it back
 115      * without doing anything else. It also recognizes {@link MutableOffsetMap} (as returned by
 116      * {@link #toModifiableMap()}) and makes an efficient copy of its contents. All other maps are converted to an
 117      * {@link ImmutableOffsetMap} with the same iteration order as input.
 118      *
 119      * @param map Input map, may not be null.
 120      * @return An isolated, immutable copy of the input map
 121      * @throws NullPointerException if {@code map} or any of its elements is null.
 122      */
 123     public static <K, V> @NonNull Map<K, V> orderedCopyOf(final @NonNull Map<K, V> map) {
 124         final Map<K, V> common = commonCopy(map);
 125         if (common != null) {
 126             return common;
 127         }
 128
 129         final int size = map.size();
 130         if (size == 1) {
 131             // Efficient single-entry implementation
 132             final Entry<K, V> e = map.entrySet().iterator().next();
 133             return SharedSingletonMap.orderedOf(e.getKey(), e.getValue());
 134         }
 135
 136         final ImmutableMap<K, Integer> offsets = OffsetMapCache.orderedOffsets(map.keySet());
 137         @SuppressWarnings("unchecked")
 138         final V[] array = (V[]) new Object[offsets.size()];
 139         for (Entry<K, V> e : map.entrySet()) {
 140             array[offsets.get(e.getKey())] = e.getValue();
 141         }
 142
 143         return new Ordered<>(offsets, array);
 144     }
 145
 146     /**
 147      * Create an {@link ImmutableOffsetMap} as a copy of an existing map. This is actually not completely true, as this
 148      * method returns an {@link ImmutableMap} for empty and singleton inputs, as those are more memory-efficient. This
 149      * method also recognizes {@link ImmutableOffsetMap} and {@link SharedSingletonMap} on input, and returns it back
 150      * without doing anything else. It also recognizes {@link MutableOffsetMap} (as returned by
 151      * {@link #toModifiableMap()}) and makes an efficient copy of its contents. All other maps are converted to an
 152      * {@link ImmutableOffsetMap}. Iterator order is not guaranteed to be retained.
 153      *
 154      * @param map Input map, may not be null.
 155      * @return An isolated, immutable copy of the input map
 156      * @throws NullPointerException if {@code map} or any of its elements is null.
 157      */
 158     public static <K, V> @NonNull Map<K, V> unorderedCopyOf(final @NonNull Map<K, V> map) {
 159         final Map<K, V> common = commonCopy(map);
 160         if (common != null) {
 161             return common;
 162         }
 163
 164         final int size = map.size();
 165         if (size == 1) {
 166             // Efficient single-entry implementation
 167             final Entry<K, V> e = map.entrySet().iterator().next();
 168             return SharedSingletonMap.unorderedOf(e.getKey(), e.getValue());
 169         }
 170
 171         final ImmutableMap<K, Integer> offsets = OffsetMapCache.unorderedOffsets(map.keySet());
 172         @SuppressWarnings("unchecked")
 173         final V[] array = (V[]) new Object[offsets.size()];
 174         for (Entry<K, V> e : map.entrySet()) {
 175             array[offsets.get(e.getKey())] = e.getValue();
 176         }
 177
 178         return new Unordered<>(offsets, array);
 179     }
 180
 181     private static <K, V> @Nullable Map<K, V> commonCopy(final @NonNull Map<K, V> map) {
 182         // Prevent a copy. Note that ImmutableMap is not listed here because of its potentially larger keySet overhead.
 183         if (map instanceof ImmutableOffsetMap || map instanceof SharedSingletonMap) {
 184             return map;
 185         }
 186
 187         // Familiar and efficient to copy
 188         if (map instanceof MutableOffsetMap) {
 189             return ((MutableOffsetMap<K, V>) map).toUnmodifiableMap();
 190         }
 191
 192         if (map.isEmpty()) {
 193             // Shares a single object
 194             return ImmutableMap.of();
 195         }
 196
 197         return null;
 198     }
 199
 200     @Override
 201     public final int size() {
 202         return offsets.size();
 203     }
 204
 205     @Override
 206     public final boolean isEmpty() {
 207         return offsets.isEmpty();
 208     }
 209
 210     @Override
 211     public final int hashCode() {
 212         if (hashCode != 0) {
 213             return hashCode;
 214         }
 215
 216         int result = 0;
 217         for (Entry<K, Integer> e : offsets.entrySet()) {
 218             result += e.getKey().hashCode() ^ objects[e.getValue()].hashCode();
 219         }
 220
 221         hashCode = result;
 222         return result;
 223     }
 224
 225     @Override
 226     public final boolean equals(final Object obj) {
 227         if (obj == this) {
 228             return true;
 229         }
 230         if (!(obj instanceof Map)) {
 231             return false;
 232         }
 233
 234         if (obj instanceof ImmutableOffsetMap) {
 235             final ImmutableOffsetMap<?, ?> om = (ImmutableOffsetMap<?, ?>) obj;
 236
 237             // If the offset match, the arrays have to match, too
 238             if (offsets.equals(om.offsets)) {
 239                 return Arrays.deepEquals(objects, om.objects);
 240             }
 241         } else if (obj instanceof MutableOffsetMap) {
 242             // Let MutableOffsetMap do the actual work.
 243             return obj.equals(this);
 244         }
 245
 246         final Map<?, ?> other = (Map<?, ?>)obj;
 247
 248         // Size and key sets have to match
 249         if (size() != other.size() || !keySet().equals(other.keySet())) {
 250             return false;
 251         }
 252
 253         try {
 254             // Ensure all objects are present
 255             for (Entry<K, Integer> e : offsets.entrySet()) {
 256                 if (!objects[e.getValue()].equals(other.get(e.getKey()))) {
 257                     return false;
 258                 }
 259             }
 260         } catch (ClassCastException e) {
 261             // Can be thrown by other.get() indicating we have incompatible key types
 262             return false;
 263         }
 264
 265         return true;
 266     }
 267
 268     @Override
 269     public final boolean containsKey(final Object key) {
 270         return offsets.containsKey(key);
 271     }
 272
 273     @Override
 274     public final boolean containsValue(final Object value) {
 275         for (Object o : objects) {
 276             if (value.equals(o)) {
 277                 return true;
 278             }
 279         }
 280         return false;
 281     }
 282
 283     @Override
 284     public final V get(final Object key) {
 285         final Integer offset = offsets.get(key);
 286         return offset == null ? null : objects[offset];
 287     }
 288
 289     @Override
 290     public final V remove(final Object key) {
 291         throw new UnsupportedOperationException();
 292     }
 293
 294     @Override
 295     public final V put(final K key, final V value) {
 296         throw new UnsupportedOperationException();
 297     }
 298
 299     @Override
 300     @SuppressWarnings("checkstyle:parameterName")
 301     public final void putAll(final Map<? extends K, ? extends V> m) {
 302         throw new UnsupportedOperationException();
 303     }
 304
 305     @Override
 306     public final void clear() {
 307         throw new UnsupportedOperationException();
 308     }
 309
 310     @Override
 311     public final Set<K> keySet() {
 312         return offsets.keySet();
 313     }
 314
 315     @Override
 316     public final @NonNull Collection<V> values() {
 317         return new ConstantArrayCollection<>(objects);
 318     }
 319
 320     @Override
 321     public final @NonNull Set<Entry<K, V>> entrySet() {
 322         return new EntrySet();
 323     }
 324
 325     @Override
 326     public final String toString() {
 327         final StringBuilder sb = new StringBuilder("{");
 328         final Iterator<K> it = offsets.keySet().iterator();
 329         int offset = 0;
 330         while (it.hasNext()) {
 331             sb.append(it.next());
 332             sb.append('=');
 333             sb.append(objects[offset++]);
 334
 335             if (it.hasNext()) {
 336                 sb.append(", ");
 337             }
 338         }
 339
 340         return sb.append('}').toString();
 341     }
 342
 343     final @NonNull ImmutableMap<K, Integer> offsets() {
 344         return offsets;
 345     }
 346
 347     final @NonNull V[] objects() {
 348         return objects;
 349     }
 350
 351     private final class EntrySet extends AbstractSet<Entry<K, V>> {
 352         @Override
 353         public @NonNull Iterator<Entry<K, V>> iterator() {
 354             final Iterator<Entry<K, Integer>> it = offsets.entrySet().iterator();
 355             return new UnmodifiableIterator<Entry<K, V>>() {
 356                 @Override
 357                 public boolean hasNext() {
 358                     return it.hasNext();
 359                 }
 360
 361                 @Override
 362                 public Entry<K, V> next() {
 363                     final Entry<K, Integer> e = it.next();
 364                     return new SimpleImmutableEntry<>(e.getKey(), objects[e.getValue()]);
 365                 }
 366             };
 367         }
 368
 369         @Override
 370         public int size() {
 371             return offsets.size();
 372         }
 373     }
 374
 375     private void writeObject(final ObjectOutputStream out) throws IOException {
 376         out.writeInt(offsets.size());
 377         for (Entry<K, V> e : entrySet()) {
 378             out.writeObject(e.getKey());
 379             out.writeObject(e.getValue());
 380         }
 381     }
 382
 383     private static final Field OFFSETS_FIELD = fieldFor("offsets");
 384     private static final Field ARRAY_FIELD = fieldFor("objects");
 385
 386     private static @NonNull Field fieldFor(final @NonNull String name) {
 387         final Field f;
 388         try {
 389             f = ImmutableOffsetMap.class.getDeclaredField(name);
 390         } catch (NoSuchFieldException | SecurityException e) {
 391             throw new IllegalStateException("Failed to lookup field " + name, e);
 392         }
 393
 394         f.setAccessible(true);
 395         return f;
 396     }
 397
 398     private static void setField(final @NonNull ImmutableOffsetMap<?, ?> map, final @NonNull Field field,
 399             final Object value) throws IOException {
 400         try {
 401             field.set(map, value);
 402         } catch (IllegalArgumentException | IllegalAccessException e) {
 403             throw new IOException("Failed to set field " + field, e);
 404         }
 405     }
 406
 407     @SuppressWarnings("unchecked")
 408     private void readObject(final @NonNull ObjectInputStream in) throws IOException, ClassNotFoundException {
 409         final int s = in.readInt();
 410
 411         final List<K> keys = new ArrayList<>(s);
 412         final V[] values = (V[]) new Object[s];
 413
 414         for (int i = 0; i < s; ++i) {
 415             keys.add((K)in.readObject());
 416             values[i] = (V)in.readObject();
 417         }
 418
 419         setFields(keys, values);
 420     }
 421 }