Cleanup use of Guava library
[yangtools.git] / common / util / src / main / java / org / opendaylight / yangtools / util / MutableOffsetMap.java
index 2c3ea479a247f4f932aedcc71c6ead4e00676bc8..8a04f3230784366401ad6e8b1c85831eb893af34 100644 (file)
@@ -7,10 +7,11 @@
  */
 package org.opendaylight.yangtools.util;
 
+import static com.google.common.base.Verify.verify;
+import static java.util.Objects.requireNonNull;
+
 import com.google.common.annotations.Beta;
 import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Preconditions;
-import com.google.common.base.Verify;
 import com.google.common.collect.ImmutableMap;
 import java.util.AbstractMap;
 import java.util.AbstractSet;
@@ -24,6 +25,7 @@ import java.util.List;
 import java.util.Map;
 import java.util.NoSuchElementException;
 import java.util.Set;
+import javax.annotation.Nonnull;
 
 /**
  * A mutable version of {@link ImmutableOffsetMap}. It inherits the set of mappings from the immutable version and
@@ -35,7 +37,7 @@ import java.util.Set;
  * </code>
  * results in source and result sharing the backing objects.
  *
- * This map does not support null keys nor values.
+ * <p>This map does not support null keys nor values.
  *
  * @param <K> the type of keys maintained by this map
  * @param <V> the type of mapped values
@@ -44,15 +46,15 @@ import java.util.Set;
 public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implements Cloneable, ModifiableMapPhase<K, V> {
     static final class Ordered<K, V> extends MutableOffsetMap<K, V> {
         Ordered() {
-            super(new LinkedHashMap<K, V>());
+            super(new LinkedHashMap<>());
         }
 
         Ordered(final Map<K, V> source) {
-            super(OffsetMapCache.orderedOffsets(source.keySet()), source, new LinkedHashMap<K, V>());
+            super(OffsetMapCache.orderedOffsets(source.keySet()), source, new LinkedHashMap<>());
         }
 
         Ordered(final Map<K, Integer> offsets, final V[] objects) {
-            super(offsets, objects, new LinkedHashMap<K, V>());
+            super(offsets, objects, new LinkedHashMap<>());
         }
 
         @Override
@@ -78,15 +80,15 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
 
     static final class Unordered<K, V> extends MutableOffsetMap<K, V> {
         Unordered() {
-            super(new HashMap<K, V>());
+            super(new HashMap<>());
         }
 
         Unordered(final Map<K, V> source) {
-            super(OffsetMapCache.unorderedOffsets(source.keySet()), source, new HashMap<K, V>());
+            super(OffsetMapCache.unorderedOffsets(source.keySet()), source, new HashMap<>());
         }
 
         Unordered(final Map<K, Integer> offsets, final V[] objects) {
-            super(offsets, objects, new HashMap<K, V>());
+            super(offsets, objects, new HashMap<>());
         }
 
         @Override
@@ -121,15 +123,15 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
     private boolean needClone = true;
 
     MutableOffsetMap(final Map<K, Integer> offsets, final V[] objects, final HashMap<K, V> newKeys) {
-        Verify.verify(newKeys.isEmpty());
-        this.offsets = Preconditions.checkNotNull(offsets);
-        this.objects = Preconditions.checkNotNull(objects);
-        this.newKeys = Preconditions.checkNotNull(newKeys);
+        verify(newKeys.isEmpty());
+        this.offsets = requireNonNull(offsets);
+        this.objects = requireNonNull(objects);
+        this.newKeys = requireNonNull(newKeys);
     }
 
     @SuppressWarnings("unchecked")
     MutableOffsetMap(final HashMap<K, V> newKeys) {
-        this(ImmutableMap.<K, Integer>of(), (V[]) EMPTY_ARRAY, newKeys);
+        this(ImmutableMap.of(), (V[]) EMPTY_ARRAY, newKeys);
     }
 
     @SuppressWarnings("unchecked")
@@ -137,50 +139,34 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
         this(offsets, (V[]) new Object[offsets.size()], newKeys);
 
         for (Entry<K, V> e : source.entrySet()) {
-            objects[offsets.get(e.getKey())] = Preconditions.checkNotNull(e.getValue());
+            objects[offsets.get(e.getKey())] = requireNonNull(e.getValue());
         }
 
         this.needClone = false;
     }
 
-    /**
-     * @deprecated Use {@link #orderedCopyOf(Map)} or {@link #unorderedCopyOf(Map)} instead.
-     */
-    @Deprecated
-    public static <K, V> MutableOffsetMap<K, V> copyOf(final Map<K, V> m) {
-        return orderedCopyOf(m);
-    }
-
-    public static <K, V> MutableOffsetMap<K, V> orderedCopyOf(final Map<K, V> m) {
-        if (m instanceof Ordered) {
-            return ((Ordered<K, V>) m).clone();
+    public static <K, V> MutableOffsetMap<K, V> orderedCopyOf(final Map<K, V> map) {
+        if (map instanceof Ordered) {
+            return ((Ordered<K, V>) map).clone();
         }
-        if (m instanceof ImmutableOffsetMap) {
-            final ImmutableOffsetMap<K, V> om = (ImmutableOffsetMap<K, V>) m;
+        if (map instanceof ImmutableOffsetMap) {
+            final ImmutableOffsetMap<K, V> om = (ImmutableOffsetMap<K, V>) map;
             return new Ordered<>(om.offsets(), om.objects());
         }
 
-        return new Ordered<>(m);
+        return new Ordered<>(map);
     }
 
-    public static <K, V> MutableOffsetMap<K, V> unorderedCopyOf(final Map<K, V> m) {
-        if (m instanceof Unordered) {
-            return ((Unordered<K, V>) m).clone();
+    public static <K, V> MutableOffsetMap<K, V> unorderedCopyOf(final Map<K, V> map) {
+        if (map instanceof Unordered) {
+            return ((Unordered<K, V>) map).clone();
         }
-        if (m instanceof ImmutableOffsetMap) {
-            final ImmutableOffsetMap<K, V> om = (ImmutableOffsetMap<K, V>) m;
+        if (map instanceof ImmutableOffsetMap) {
+            final ImmutableOffsetMap<K, V> om = (ImmutableOffsetMap<K, V>) map;
             return new Unordered<>(om.offsets(), om.objects());
         }
 
-        return new Unordered<>(m);
-    }
-
-    /**
-     * @deprecated Use {@link #ordered()} or {@link #unordered()} instead.
-     */
-    @Deprecated
-    public static <K, V> MutableOffsetMap<K, V> of() {
-        return ordered();
+        return new Unordered<>(map);
     }
 
     public static <K, V> MutableOffsetMap<K, V> ordered() {
@@ -192,8 +178,11 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
     }
 
     abstract Object removedObject();
+
     abstract UnmodifiableMapPhase<K, V> modifiedMap(List<K> keys, V[] objects);
+
     abstract UnmodifiableMapPhase<K, V> unmodifiedMap(Map<K, Integer> offsets, V[] objects);
+
     abstract SharedSingletonMap<K, V> singletonMap();
 
     @Override
@@ -251,8 +240,8 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
 
     @Override
     public final V put(final K key, final V value) {
-        Preconditions.checkNotNull(value);
-        final Integer offset = offsets.get(Preconditions.checkNotNull(key));
+        requireNonNull(value);
+        final Integer offset = offsets.get(requireNonNull(key));
         if (offset != null) {
             final Object obj = objects[offset];
 
@@ -325,11 +314,13 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
         }
     }
 
+    @Nonnull
     @Override
     public final Set<Entry<K, V>> entrySet() {
         return new EntrySet();
     }
 
+    @Nonnull
     @Override
     public Map<K, V> toUnmodifiableMap() {
         if (removed == 0 && newKeys.isEmpty()) {
@@ -375,7 +366,7 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
         // Construct the values
         @SuppressWarnings("unchecked")
         final V[] values = (V[])new Object[keyset.size()];
-        int i = 0;
+        int offset = 0;
         if (removed != 0) {
             if (removed != offsets.size()) {
                 for (Entry<K, Integer> e : offsets.entrySet()) {
@@ -383,16 +374,16 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
                     if (o != null && !REMOVED.equals(o)) {
                         @SuppressWarnings("unchecked")
                         final V v = (V) o;
-                        values[i++] = v;
+                        values[offset++] = v;
                     }
                 }
             }
         } else {
             System.arraycopy(objects, 0, values, 0, offsets.size());
-            i = offsets.size();
+            offset = offsets.size();
         }
         for (V v : newKeys.values()) {
-            values[i++] = v;
+            values[offset++] = v;
         }
 
         return modifiedMap(keyset, values);
@@ -406,7 +397,7 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
         try {
             ret = (MutableOffsetMap<K, V>) super.clone();
         } catch (CloneNotSupportedException e) {
-           throw new IllegalStateException("Clone is expected to work", e);
+            throw new IllegalStateException("Clone is expected to work", e);
         }
 
         ret.newKeys = (HashMap<K, V>) newKeys.clone();
@@ -429,22 +420,22 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
     }
 
     @Override
-    public final boolean equals(final Object o) {
-        if (o == this) {
+    public final boolean equals(final Object obj) {
+        if (obj == this) {
             return true;
         }
-        if (!(o instanceof Map)) {
+        if (!(obj instanceof Map)) {
             return false;
         }
 
-        if (o instanceof ImmutableOffsetMap) {
-            final ImmutableOffsetMap<?, ?> om = (ImmutableOffsetMap<?, ?>) o;
+        if (obj instanceof ImmutableOffsetMap) {
+            final ImmutableOffsetMap<?, ?> om = (ImmutableOffsetMap<?, ?>) obj;
 
             if (newKeys.isEmpty() && offsets.equals(om.offsets())) {
                 return Arrays.deepEquals(objects, om.objects());
             }
-        } else if (o instanceof MutableOffsetMap) {
-            final MutableOffsetMap<?, ?> om = (MutableOffsetMap<?, ?>) o;
+        } else if (obj instanceof MutableOffsetMap) {
+            final MutableOffsetMap<?, ?> om = (MutableOffsetMap<?, ?>) obj;
 
             if (offsets.equals(om.offsets)) {
                 return Arrays.deepEquals(objects, om.objects) && newKeys.equals(om.newKeys);
@@ -452,7 +443,7 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
         }
 
         // Fall back to brute map compare
-        final Map<?, ?> other = (Map<?, ?>)o;
+        final Map<?, ?> other = (Map<?, ?>)obj;
 
         // Size and key sets have to match
         if (size() != other.size() || !keySet().equals(other.keySet())) {
@@ -470,8 +461,8 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
 
             // Ensure all objects are present
             for (Entry<K, Integer> e : offsets.entrySet()) {
-                final Object obj = objects[e.getValue()];
-                if (obj != null && !REMOVED.equals(obj) && !obj.equals(other.get(e.getKey()))) {
+                final Object val = objects[e.getValue()];
+                if (val != null && !REMOVED.equals(val) && !val.equals(other.get(e.getKey()))) {
                     return false;
                 }
             }
@@ -483,6 +474,7 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
         return true;
     }
 
+    @Nonnull
     @Override
     public final Set<K> keySet() {
         return new KeySet();
@@ -504,6 +496,7 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
     }
 
     private final class EntrySet extends AbstractSet<Entry<K, V>> {
+        @Nonnull
         @Override
         public Iterator<Entry<K, V>> iterator() {
             return new AbstractSetIterator<Entry<K, V>>() {
@@ -521,6 +514,7 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
         }
 
         @Override
+        @SuppressWarnings("checkstyle:parameterName")
         public boolean contains(final Object o) {
             if (!(o instanceof Entry)) {
                 return false;
@@ -536,13 +530,15 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
         }
 
         @Override
+        @SuppressWarnings("checkstyle:parameterName")
         public boolean add(final Entry<K, V> e) {
-            Preconditions.checkNotNull(e.getValue());
-            final V p = MutableOffsetMap.this.put(e.getKey(), e.getValue());
-            return !e.getValue().equals(p);
+            final V v = requireNonNull(e.getValue());
+            final V p = MutableOffsetMap.this.put(e.getKey(), v);
+            return !v.equals(p);
         }
 
         @Override
+        @SuppressWarnings("checkstyle:parameterName")
         public boolean remove(final Object o) {
             if (!(o instanceof Entry)) {
                 return false;
@@ -569,6 +565,7 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
     }
 
     private final class KeySet extends AbstractSet<K> {
+        @Nonnull
         @Override
         public Iterator<K> iterator() {
             return new AbstractSetIterator<K>() {
@@ -589,7 +586,8 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
         private final Iterator<Entry<K, Integer>> oldIterator = offsets.entrySet().iterator();
         private final Iterator<K> newIterator = newKeys.keySet().iterator();
         private int expectedModCount = modCount;
-        private K currentKey, nextKey;
+        private K currentKey;
+        private K nextKey;
 
         AbstractSetIterator() {
             updateNextKey();
@@ -622,7 +620,7 @@ public abstract class MutableOffsetMap<K, V> extends AbstractMap<K, V> implement
 
         @Override
         public final void remove() {
-            Preconditions.checkState(currentKey != null);
+            requireNonNull(currentKey != null);
 
             checkModCount();
             final Integer offset = offsets.get(currentKey);