BUG-7464: Add dedicated key set classes

These are slightly more efficient versions of the default
key set and react to Set.remove().

Change-Id: If67d4c75210d22dafbd2cd2dabeebc8554505a5e
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/AbstractKeySet.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/AbstractKeySet.java
new file mode 100644 (file)
index 0000000..8e80392
--- /dev/null
+++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/AbstractKeySet.java
@@ -0,0 +1,65 @@
+/*
+ * (C) Copyright 2016 Pantheon Technologies, s.r.o. and others.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.opendaylight.yangtools.triemap;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import java.util.AbstractSet;
+import java.util.Collection;
+
+/**
+ * Abstract base class for key set views of a TrieMap
+ *
+ * @author Robert Varga
+ *
+ * @param <K> the type of keys
+ */
+abstract class AbstractKeySet<K> extends AbstractSet<K> {
+    private final TrieMap<K, ?> map;
+
+    AbstractKeySet(final TrieMap<K, ?> map) {
+        this.map = checkNotNull(map);
+    }
+
+    final TrieMap<K, ?> map() {
+        return map;
+    }
+
+    @Override
+    public final boolean add(final K e) {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public final boolean addAll(final Collection<? extends K> c) {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public final boolean contains(final Object o) {
+        return map.containsKey(o);
+    }
+
+    @Override
+    public final boolean isEmpty() {
+        return map.isEmpty();
+    }
+
+    @Override
+    public final int size() {
+        return map.size();
+    }
+}

diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableKeySet.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableKeySet.java
new file mode 100644 (file)
index 0000000..fa8f39f
--- /dev/null
+++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableKeySet.java
@@ -0,0 +1,60 @@
+/*
+ * (C) Copyright 2016 Pantheon Technologies, s.r.o. and others.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.opendaylight.yangtools.triemap;
+
+import static org.opendaylight.yangtools.triemap.ImmutableTrieMap.unsupported;
+
+import com.google.common.collect.Iterators;
+import java.util.Collection;
+import java.util.Iterator;
+import java.util.Map.Entry;
+
+/**
+ * An immutable view of a TrieMap's key set.
+ *
+ * @author Robert Varga
+ *
+ * @param <K> the type of keys
+ */
+final class ImmutableKeySet<K> extends AbstractKeySet<K> {
+    ImmutableKeySet(final TrieMap<K, ?> map) {
+        super(map);
+    }
+
+    @Override
+    public Iterator<K> iterator() {
+        return Iterators.transform(map().immutableIterator(), Entry::getKey);
+    }
+
+    @Override
+    public void clear() {
+        throw unsupported();
+    }
+
+    @Override
+    public boolean remove(final Object o) {
+        throw unsupported();
+    }
+    @Override
+    public boolean retainAll(final Collection<?> c) {
+        throw unsupported();
+    }
+
+    @Override
+    public boolean removeAll(final Collection<?> c) {
+        throw unsupported();
+    }
+}

diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableTrieMap.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableTrieMap.java
index 0949f99db66ddb344ad152336f02ceae11a88858..17391cfcfb4ab798c45e3171c923333761e0725e 100644 (file)
--- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableTrieMap.java
+++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/ImmutableTrieMap.java
@@ -123,6 +123,11 @@ public final class ImmutableTrieMap<K, V> extends TrieMap<K, V> {
         return new ImmutableEntrySet<>(this);
     }
 
+    @Override
+    ImmutableKeySet<K> createKeySet() {
+        return new ImmutableKeySet<>(this);
+    }
+
     @Override
     boolean isReadOnly() {
         return true;

diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableKeySet.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableKeySet.java
new file mode 100644 (file)
index 0000000..f6d5d2c
--- /dev/null
+++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableKeySet.java
@@ -0,0 +1,62 @@
+/*
+ * (C) Copyright 2016 Pantheon Technologies, s.r.o. and others.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.opendaylight.yangtools.triemap;
+
+import java.util.Iterator;
+
+/**
+ * A mutable view of a TrieMap's key set.
+ *
+ * @author Robert Varga
+ *
+ * @param <K> the type of keys
+ */
+final class MutableKeySet<K> extends AbstractKeySet<K> {
+    MutableKeySet(final MutableTrieMap<K, ?> map) {
+        super(map);
+    }
+
+    @Override
+    public Iterator<K> iterator() {
+        final AbstractIterator<K, ?> itr = map().iterator();
+        return new Iterator<K>() {
+            @Override
+            public boolean hasNext() {
+                return itr.hasNext();
+            }
+
+            @Override
+            public K next() {
+                return itr.next().getKey();
+            }
+
+            @Override
+            public void remove() {
+                itr.remove();
+            }
+        };
+    }
+
+    @Override
+    public void clear() {
+        map().clear();
+    }
+
+    @Override
+    public boolean remove(final Object o) {
+        return map().remove(o) != null;
+    }
+}

diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableTrieMap.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableTrieMap.java
index fa74bf0bb1ee52982affd9dea4ac065eb07dd984..ed12e7c2e4a8d0f97b383df140639e3d0679608a 100644 (file)
--- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableTrieMap.java
+++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/MutableTrieMap.java
@@ -140,6 +140,11 @@ final class MutableTrieMap<K, V> extends TrieMap<K, V> {
         return new MutableEntrySet<>(this);
     }
 
+    @Override
+    MutableKeySet<K> createKeySet() {
+        return new MutableKeySet<>(this);
+    }
+
     @Override
     MutableIterator<K, V> iterator() {
         return new MutableIterator<>(this);

diff --git a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/TrieMap.java b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/TrieMap.java
index 2a0111af41b03e0ed2d3c7b901923d7f6b35ee86..a7a92ee1bc1687ac1a6209dcb8284f1908f76408 100644 (file)
--- a/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/TrieMap.java
+++ b/third-party/triemap/src/main/java/org/opendaylight/yangtools/triemap/TrieMap.java
@@ -44,6 +44,7 @@ public abstract class TrieMap<K, V> extends AbstractMap<K, V> implements Concurr
     private final Equivalence<? super K> equiv;
 
     private AbstractEntrySet<K, V> entrySet;
+    private AbstractKeySet<K> keySet;
 
     TrieMap(final Equivalence<? super K> equiv) {
         this.equiv = equiv;
@@ -99,6 +100,15 @@ public abstract class TrieMap<K, V> extends AbstractMap<K, V> implements Concurr
         return ret;
     }
 
+    @Override
+    public final Set<K> keySet() {
+        AbstractKeySet<K> ret = keySet;
+        if (ret == null) {
+            keySet = ret = createKeySet();
+        }
+        return ret;
+    }
+
     @Override
     public final V get(final Object key) {
         @SuppressWarnings("unchecked")
@@ -134,6 +144,8 @@ public abstract class TrieMap<K, V> extends AbstractMap<K, V> implements Concurr
 
     abstract AbstractEntrySet<K, V> createEntrySet();
 
+    abstract AbstractKeySet<K> createKeySet();
+
     abstract boolean isReadOnly();
 
     abstract INode<K, V> RDCSS_READ_ROOT(boolean abort);