*/
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;
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.
*
+ * <p>
+ * In case the set of keys is statically known, you can use {@link ImmutableOffsetMapTemplate} to efficiently create
+ * {@link ImmutableOffsetMap} instances.
+ *
* @param <K> the type of keys maintained by this map
* @param <V> the type of mapped values
*/
@Beta
-public final class ImmutableOffsetMap<K, V> implements UnmodifiableMapPhase<K, V>, Serializable {
+public abstract class ImmutableOffsetMap<K, V> implements UnmodifiableMapPhase<K, V>, Serializable {
+ static final class Ordered<K, V> extends ImmutableOffsetMap<K, V> {
+ private static final long serialVersionUID = 1L;
+
+ Ordered(final ImmutableMap<K, Integer> offsets, final V[] objects) {
+ super(offsets, objects);
+ }
+
+ @Override
+ public @NonNull MutableOffsetMap<K, V> toModifiableMap() {
+ return MutableOffsetMap.orderedCopyOf(this);
+ }
+
+ @Override
+ void setFields(final List<K> keys, final V[] values) throws IOException {
+ setField(this, OFFSETS_FIELD, OffsetMapCache.orderedOffsets(keys));
+ setField(this, ARRAY_FIELD, values);
+ }
+ }
+
+ static final class Unordered<K, V> extends ImmutableOffsetMap<K, V> {
+ private static final long serialVersionUID = 1L;
+
+ Unordered(final ImmutableMap<K, Integer> offsets, final V[] objects) {
+ super(offsets, objects);
+ }
+
+ @Override
+ public @NonNull MutableOffsetMap<K, V> toModifiableMap() {
+ return MutableOffsetMap.unorderedCopyOf(this);
+ }
+
+ @Override
+ void setFields(final List<K> keys, final V[] values) throws IOException {
+ final Map<K, Integer> newOffsets = OffsetMapCache.unorderedOffsets(keys);
+
+ setField(this, OFFSETS_FIELD, newOffsets);
+ setField(this, ARRAY_FIELD, OffsetMapCache.adjustedArray(newOffsets, keys, values));
+ }
+ }
+
private static final long serialVersionUID = 1L;
- private final Map<K, Integer> offsets;
- private final V[] objects;
- private int hashCode;
+ private final transient @NonNull ImmutableMap<K, Integer> offsets;
+ private final transient @NonNull V[] objects;
+ private transient int hashCode;
/**
* Construct a new instance backed by specified key-to-offset map and array of objects.
* @param objects Array of value object, may not be null. The array is stored as is, the caller
* is responsible for ensuring its contents remain unmodified.
*/
- ImmutableOffsetMap(@Nonnull final Map<K, Integer> offsets, @Nonnull final V[] objects) {
- this.offsets = Preconditions.checkNotNull(offsets);
- this.objects = Preconditions.checkNotNull(objects);
- Preconditions.checkArgument(offsets.size() == objects.length);
+ ImmutableOffsetMap(final ImmutableMap<K, Integer> offsets, final V[] objects) {
+ this.offsets = requireNonNull(offsets);
+ this.objects = requireNonNull(objects);
+ checkArgument(offsets.size() == objects.length);
}
+ @Override
+ public abstract @NonNull MutableOffsetMap<K, V> toModifiableMap();
+
+ abstract void setFields(List<K> keys, V[] values) throws IOException;
+
/**
- * Construct a new instance based on some other instance.
+ * 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 Instance to share data with, 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.
*/
- ImmutableOffsetMap(@Nonnull final ImmutableOffsetMap<K, V> m) {
- this.offsets = m.offsets;
- this.objects = m.objects;
+ public static <K, V> @NonNull Map<K, V> orderedCopyOf(final @NonNull Map<K, V> map) {
+ final Map<K, V> common = commonCopy(map);
+ if (common != null) {
+ return common;
+ }
+
+ final int size = map.size();
+ if (size == 1) {
+ // Efficient single-entry implementation
+ final Entry<K, V> e = map.entrySet().iterator().next();
+ return SharedSingletonMap.orderedOf(e.getKey(), e.getValue());
+ }
+
+ final ImmutableMap<K, Integer> offsets = OffsetMapCache.orderedOffsets(map.keySet());
+ @SuppressWarnings("unchecked")
+ final V[] array = (V[]) new Object[offsets.size()];
+ for (Entry<K, V> e : map.entrySet()) {
+ array[offsets.get(e.getKey())] = e.getValue();
+ }
+
+ return new Ordered<>(offsets, array);
}
/**
- * 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}. Iterator order is not guaranteed to be retained.
*
- * @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 <K, V> Map<K, V> copyOf(@Nonnull final Map<K, V> 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<K, V>) m).toUnmodifiableMap();
+ public static <K, V> @NonNull Map<K, V> unorderedCopyOf(final @NonNull Map<K, V> map) {
+ final Map<K, V> common = commonCopy(map);
+ if (common != null) {
+ return common;
}
- 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<K, V> e = m.entrySet().iterator().next();
- return SharedSingletonMap.of(e.getKey(), e.getValue());
+ final Entry<K, V> e = map.entrySet().iterator().next();
+ return SharedSingletonMap.unorderedOf(e.getKey(), e.getValue());
}
- final Map<K, Integer> offsets = OffsetMapCache.offsetsFor(m.keySet());
+ final ImmutableMap<K, Integer> offsets = OffsetMapCache.unorderedOffsets(map.keySet());
@SuppressWarnings("unchecked")
final V[] array = (V[]) new Object[offsets.size()];
- for (Entry<K, V> e : m.entrySet()) {
+ for (Entry<K, V> e : map.entrySet()) {
array[offsets.get(e.getKey())] = e.getValue();
}
- return new ImmutableOffsetMap<>(offsets, array);
+ return new Unordered<>(offsets, array);
+ }
+
+ private static <K, V> @Nullable Map<K, V> commonCopy(final @NonNull Map<K, V> 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<K, V>) map).toUnmodifiableMap();
+ }
+
+ if (map.isEmpty()) {
+ // Shares a single object
+ return ImmutableMap.of();
+ }
+
+ return null;
}
@Override
- public int size() {
+ public final int size() {
return offsets.size();
}
@Override
- public boolean isEmpty() {
+ public final boolean isEmpty() {
return offsets.isEmpty();
}
@Override
- public int hashCode() {
+ public final int hashCode() {
if (hashCode != 0) {
return hashCode;
}
}
@Override
- public boolean equals(final Object o) {
- if (o == this) {
+ public final boolean equals(final Object obj) {
+ if (obj == this) {
return true;
}
- if (o == null) {
+ if (!(obj instanceof Map)) {
return false;
}
- if (o instanceof ImmutableOffsetMap) {
- final ImmutableOffsetMap<?, ?> om = (ImmutableOffsetMap<?, ?>) o;
- if (offsets.equals(om.offsets) && Arrays.deepEquals(objects, om.objects)) {
- return true;
+ 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);
- } else if (o instanceof Map) {
- final Map<?, ?> om = (Map<?, ?>)o;
+ return obj.equals(this);
+ }
- // Size and key sets have to match
- if (size() != om.size() || !keySet().equals(om.keySet())) {
- return false;
- }
+ final Map<?, ?> other = (Map<?, ?>)obj;
+
+ // Size and key sets have to match
+ if (size() != other.size() || !keySet().equals(other.keySet())) {
+ return false;
+ }
- try {
- // Ensure all objects are present
- for (Entry<K, Integer> e : offsets.entrySet()) {
- if (!objects[e.getValue()].equals(om.get(e.getKey()))) {
- return false;
- }
+ try {
+ // Ensure all objects are present
+ for (Entry<K, Integer> e : offsets.entrySet()) {
+ if (!objects[e.getValue()].equals(other.get(e.getKey()))) {
+ return false;
}
- } catch (ClassCastException e) {
- // Can be thrown by om.get() indicating we have incompatible key types
- return false;
}
-
- return true;
+ } catch (ClassCastException e) {
+ // Can be thrown by other.get() indicating we have incompatible key types
+ return false;
}
- return false;
+ return true;
}
@Override
- public boolean containsKey(final Object key) {
+ public final boolean containsKey(final Object key) {
return offsets.containsKey(key);
}
@Override
- public boolean containsValue(final Object value) {
+ public final boolean containsValue(final Object value) {
for (Object o : objects) {
if (value.equals(o)) {
return true;
}
@Override
- public V get(final Object key) {
- final Integer offset = offsets.get(key);
- return offset == null ? null : objects[offset];
+ public final V get(final Object key) {
+ Integer offset;
+ return (offset = offsets.get(key)) == null ? null : objects[offset];
}
@Override
- public V remove(final Object key) {
+ public final V remove(final Object key) {
throw new UnsupportedOperationException();
}
@Override
- public V put(final K key, final V value) {
+ public final V put(final K key, final V value) {
throw new UnsupportedOperationException();
}
@Override
- public void putAll(final Map<? extends K, ? extends V> m) {
+ @SuppressWarnings("checkstyle:parameterName")
+ public final void putAll(final Map<? extends K, ? extends V> m) {
throw new UnsupportedOperationException();
}
@Override
- public void clear() {
+ public final void clear() {
throw new UnsupportedOperationException();
}
@Override
- public Set<K> keySet() {
+ public final Set<K> keySet() {
return offsets.keySet();
}
@Override
- public Collection<V> values() {
+ public final @NonNull Collection<V> values() {
return new ConstantArrayCollection<>(objects);
}
@Override
- public Set<Entry<K, V>> entrySet() {
+ public final @NonNull Set<Entry<K, V>> entrySet() {
return new EntrySet();
}
@Override
- public MutableOffsetMap<K, V> toModifiableMap() {
- return new MutableOffsetMap<>(this);
- }
-
- @Override
- public String toString() {
+ public final String toString() {
final StringBuilder sb = new StringBuilder("{");
final Iterator<K> 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(", ");
return sb.append('}').toString();
}
- Map<K, Integer> offsets() {
+ final @NonNull ImmutableMap<K, Integer> offsets() {
return offsets;
}
- V[] objects() {
+ final @NonNull V[] objects() {
return objects;
}
private final class EntrySet extends AbstractSet<Entry<K, V>> {
@Override
- public Iterator<Entry<K, V>> iterator() {
+ public @NonNull Iterator<Entry<K, V>> iterator() {
final Iterator<Entry<K, Integer>> it = offsets.entrySet().iterator();
-
- return new UnmodifiableIterator<Entry<K, V>>() {
+ return new UnmodifiableIterator<>() {
@Override
public boolean hasNext() {
return it.hasNext();
private static final Field OFFSETS_FIELD = fieldFor("offsets");
private static final Field ARRAY_FIELD = fieldFor("objects");
- private static Field fieldFor(final String name) {
+ private static @NonNull Field fieldFor(final @NonNull String name) {
final Field f;
try {
f = ImmutableOffsetMap.class.getDeclaredField(name);
return f;
}
- private void setField(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(this, value);
+ field.set(map, value);
} catch (IllegalArgumentException | IllegalAccessException e) {
throw new IOException("Failed to set field " + field, e);
}
}
@SuppressWarnings("unchecked")
- private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException {
+ private void readObject(final @NonNull ObjectInputStream in) throws IOException, ClassNotFoundException {
final int s = in.readInt();
final List<K> keys = new ArrayList<>(s);
values[i] = (V)in.readObject();
}
- setField(OFFSETS_FIELD, OffsetMapCache.offsetsFor(keys));
- setField(ARRAY_FIELD, values);
+ setFields(keys, values);
}
}
Code Review / yangtools.git / blobdiff