X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=common%2Futil%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fyangtools%2Futil%2FImmutableOffsetMap.java;h=844086df746c1c314f3a2625dd1aa268543cc0ef;hb=4f66528ebcf1603108218b8ebf48147d8ed3ad38;hp=909ab5583305110f8c92dfb070acb5c7d6220e1a;hpb=178b951cbabbc81d3bcf00749a7c97964ed20296;p=yangtools.git
diff --git a/common/util/src/main/java/org/opendaylight/yangtools/util/ImmutableOffsetMap.java b/common/util/src/main/java/org/opendaylight/yangtools/util/ImmutableOffsetMap.java
index 909ab55833..844086df74 100644
--- a/common/util/src/main/java/org/opendaylight/yangtools/util/ImmutableOffsetMap.java
+++ b/common/util/src/main/java/org/opendaylight/yangtools/util/ImmutableOffsetMap.java
@@ -7,10 +7,13 @@
*/
package org.opendaylight.yangtools.util;
+import static com.google.common.base.Preconditions.checkArgument;
+import static java.util.Objects.requireNonNull;
+
import com.google.common.annotations.Beta;
-import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.UnmodifiableIterator;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
@@ -25,13 +28,18 @@ import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
-import javax.annotation.Nonnull;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
/**
* Implementation of the {@link Map} interface which stores a set of immutable mappings using a key-to-offset map and
* a backing array. This is useful for situations where the same key set is shared across a multitude of maps, as this
* class uses a global cache to share the key-to-offset mapping.
*
+ *
+ * In case the set of keys is statically known, you can use {@link ImmutableOffsetMapTemplate} to efficiently create
+ * {@link ImmutableOffsetMap} instances.
+ *
* @param the type of keys maintained by this map
* @param the type of mapped values
*/
@@ -40,12 +48,12 @@ public abstract class ImmutableOffsetMap implements UnmodifiableMapPhase extends ImmutableOffsetMap {
private static final long serialVersionUID = 1L;
- Ordered(final Map offsets, final V[] objects) {
+ Ordered(final ImmutableMap offsets, final V[] objects) {
super(offsets, objects);
}
@Override
- public MutableOffsetMap toModifiableMap() {
+ public @NonNull MutableOffsetMap toModifiableMap() {
return MutableOffsetMap.orderedCopyOf(this);
}
@@ -59,12 +67,12 @@ public abstract class ImmutableOffsetMap implements UnmodifiableMapPhase extends ImmutableOffsetMap {
private static final long serialVersionUID = 1L;
- Unordered(final Map offsets, final V[] objects) {
+ Unordered(final ImmutableMap offsets, final V[] objects) {
super(offsets, objects);
}
@Override
- public MutableOffsetMap toModifiableMap() {
+ public @NonNull MutableOffsetMap toModifiableMap() {
return MutableOffsetMap.unorderedCopyOf(this);
}
@@ -79,8 +87,8 @@ public abstract class ImmutableOffsetMap implements UnmodifiableMapPhase offsets;
- private final transient V[] objects;
+ private final transient @NonNull ImmutableMap offsets;
+ private final transient @NonNull V[] objects;
private transient int hashCode;
/**
@@ -90,58 +98,46 @@ public abstract class ImmutableOffsetMap implements UnmodifiableMapPhase offsets, @Nonnull final V[] objects) {
- this.offsets = Preconditions.checkNotNull(offsets);
- this.objects = Preconditions.checkNotNull(objects);
- Preconditions.checkArgument(offsets.size() == objects.length);
+ ImmutableOffsetMap(final ImmutableMap offsets, final V[] objects) {
+ this.offsets = requireNonNull(offsets);
+ this.objects = requireNonNull(objects);
+ checkArgument(offsets.size() == objects.length);
}
@Override
- public abstract MutableOffsetMap toModifiableMap();
+ public abstract @NonNull MutableOffsetMap toModifiableMap();
abstract void setFields(List keys, V[] values) throws IOException;
/**
- * Create an {@link ImmutableOffsetMap} as a copy of an existing map. This
- * is actually not completely true, as this method returns an
- * {@link ImmutableMap} for empty and singleton inputs, as those are more
- * memory-efficient. This method also recognizes {@link ImmutableOffsetMap}
- * on input, and returns it back without doing anything else. It also
- * recognizes {@link MutableOffsetMap} (as returned by
- * {@link #toModifiableMap()}) and makes an efficient copy of its contents.
- * All other maps are converted to an {@link ImmutableOffsetMap} with the
- * same iteration order as input.
+ * Create an {@link ImmutableOffsetMap} as a copy of an existing map. This is actually not completely true, as this
+ * method returns an {@link ImmutableMap} for empty and singleton inputs, as those are more memory-efficient. This
+ * method also recognizes {@link ImmutableOffsetMap} and {@link SharedSingletonMap} on input, and returns it back
+ * without doing anything else. It also recognizes {@link MutableOffsetMap} (as returned by
+ * {@link #toModifiableMap()}) and makes an efficient copy of its contents. All other maps are converted to an
+ * {@link ImmutableOffsetMap} with the same iteration order as input.
*
- * @param m
- * Input map, may not be null.
+ * @param map Input map, may not be null.
* @return An isolated, immutable copy of the input map
+ * @throws NullPointerException if {@code map} or any of its elements is null.
*/
- @Nonnull public static Map orderedCopyOf(@Nonnull final Map m) {
- // Prevent a copy. Note that ImmutableMap is not listed here because of its potentially larger keySet overhead.
- if (m instanceof ImmutableOffsetMap || m instanceof SharedSingletonMap) {
- return m;
- }
-
- // Familiar and efficient to copy
- if (m instanceof MutableOffsetMap) {
- return ((MutableOffsetMap) m).toUnmodifiableMap();
+ public static @NonNull Map orderedCopyOf(final @NonNull Map map) {
+ final Map common = commonCopy(map);
+ if (common != null) {
+ return common;
}
- final int size = m.size();
- if (size == 0) {
- // Shares a single object
- return ImmutableMap.of();
- }
+ final int size = map.size();
if (size == 1) {
// Efficient single-entry implementation
- final Entry e = m.entrySet().iterator().next();
+ final Entry e = map.entrySet().iterator().next();
return SharedSingletonMap.orderedOf(e.getKey(), e.getValue());
}
- final Map offsets = OffsetMapCache.orderedOffsets(m.keySet());
+ final ImmutableMap offsets = OffsetMapCache.orderedOffsets(map.keySet());
@SuppressWarnings("unchecked")
final V[] array = (V[]) new Object[offsets.size()];
- for (Entry e : m.entrySet()) {
+ for (Entry e : map.entrySet()) {
array[offsets.get(e.getKey())] = e.getValue();
}
@@ -149,52 +145,58 @@ public abstract class ImmutableOffsetMap implements UnmodifiableMapPhase Map unorderedCopyOf(@Nonnull final Map m) {
- // Prevent a copy. Note that ImmutableMap is not listed here because of its potentially larger keySet overhead.
- if (m instanceof ImmutableOffsetMap || m instanceof SharedSingletonMap) {
- return m;
+ public static @NonNull Map unorderedCopyOf(final @NonNull Map map) {
+ final Map common = commonCopy(map);
+ if (common != null) {
+ return common;
}
- // Familiar and efficient to copy
- if (m instanceof MutableOffsetMap) {
- return ((MutableOffsetMap) m).toUnmodifiableMap();
- }
-
- final int size = m.size();
- if (size == 0) {
- // Shares a single object
- return ImmutableMap.of();
- }
- if (size == 1) {
+ if (map.size() == 1) {
// Efficient single-entry implementation
- final Entry e = m.entrySet().iterator().next();
+ final Entry e = map.entrySet().iterator().next();
return SharedSingletonMap.unorderedOf(e.getKey(), e.getValue());
}
- final Map offsets = OffsetMapCache.unorderedOffsets(m.keySet());
+ final ImmutableMap offsets = OffsetMapCache.unorderedOffsets(map.keySet());
@SuppressWarnings("unchecked")
final V[] array = (V[]) new Object[offsets.size()];
- for (Entry e : m.entrySet()) {
+ for (Entry e : map.entrySet()) {
array[offsets.get(e.getKey())] = e.getValue();
}
return new Unordered<>(offsets, array);
}
+ private static @Nullable Map commonCopy(final @NonNull Map map) {
+ // Prevent a copy. Note that ImmutableMap is not listed here because of its potentially larger keySet overhead.
+ if (map instanceof ImmutableOffsetMap || map instanceof SharedSingletonMap) {
+ return map;
+ }
+
+ // Familiar and efficient to copy
+ if (map instanceof MutableOffsetMap) {
+ return ((MutableOffsetMap) map).toUnmodifiableMap();
+ }
+
+ if (map.isEmpty()) {
+ // Shares a single object
+ return ImmutableMap.of();
+ }
+
+ return null;
+ }
+
@Override
public final int size() {
return offsets.size();
@@ -221,27 +223,27 @@ public abstract class ImmutableOffsetMap implements UnmodifiableMapPhase om = (ImmutableOffsetMap, ?>) o;
+ if (obj instanceof ImmutableOffsetMap) {
+ final ImmutableOffsetMap, ?> om = (ImmutableOffsetMap, ?>) obj;
// If the offset match, the arrays have to match, too
if (offsets.equals(om.offsets)) {
return Arrays.deepEquals(objects, om.objects);
}
- } else if (o instanceof MutableOffsetMap) {
+ } else if (obj instanceof MutableOffsetMap) {
// Let MutableOffsetMap do the actual work.
- return o.equals(this);
+ return obj.equals(this);
}
- 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())) {
@@ -280,8 +282,8 @@ public abstract class ImmutableOffsetMap implements UnmodifiableMapPhase implements UnmodifiableMapPhase m) {
throw new UnsupportedOperationException();
}
@@ -310,12 +313,12 @@ public abstract class ImmutableOffsetMap implements UnmodifiableMapPhase values() {
+ public final @NonNull Collection values() {
return new ConstantArrayCollection<>(objects);
}
@Override
- public final Set> entrySet() {
+ public final @NonNull Set> entrySet() {
return new EntrySet();
}
@@ -323,11 +326,9 @@ public abstract class ImmutableOffsetMap implements UnmodifiableMapPhase it = offsets.keySet().iterator();
- int i = 0;
+ int offset = 0;
while (it.hasNext()) {
- sb.append(it.next());
- sb.append('=');
- sb.append(objects[i++]);
+ sb.append(it.next()).append('=').append(objects[offset++]);
if (it.hasNext()) {
sb.append(", ");
@@ -337,20 +338,19 @@ public abstract class ImmutableOffsetMap implements UnmodifiableMapPhase offsets() {
+ final @NonNull ImmutableMap offsets() {
return offsets;
}
- final V[] objects() {
+ final @NonNull V[] objects() {
return objects;
}
private final class EntrySet extends AbstractSet> {
@Override
- public Iterator> iterator() {
+ public @NonNull Iterator> iterator() {
final Iterator> it = offsets.entrySet().iterator();
-
- return new UnmodifiableIterator>() {
+ return new UnmodifiableIterator<>() {
@Override
public boolean hasNext() {
return it.hasNext();
@@ -381,7 +381,7 @@ public abstract class ImmutableOffsetMap implements UnmodifiableMapPhase implements UnmodifiableMapPhase map, final Field field, final Object value)
- throws IOException {
+ @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD",
+ justification = "https://github.com/spotbugs/spotbugs/issues/811")
+ private static void setField(final @NonNull ImmutableOffsetMap, ?> map, final @NonNull Field field,
+ final Object value) throws IOException {
try {
field.set(map, value);
} catch (IllegalArgumentException | IllegalAccessException e) {
@@ -403,7 +405,7 @@ public abstract class ImmutableOffsetMap implements UnmodifiableMapPhase keys = new ArrayList<>(s);