import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.lang.reflect.Field;
+import java.util.AbstractMap.SimpleImmutableEntry;
import java.util.AbstractSet;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
-import java.util.Objects;
import java.util.Set;
import javax.annotation.Nonnull;
* 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.
*
- * This map supports creation of value objects on the fly. To achieve that, subclasses should override {@link #valueToObject(Object)},
- * {@link #objectToValue(Object, Object)}, {@link #clone()} and {@link #toModifiableMap()} methods.
- *
* @param <K> the type of keys maintained by this map
* @param <V> the type of mapped values
*/
@Beta
-public class ImmutableOffsetMap<K, V> extends AbstractLazyValueMap<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 Map<K, Integer> offsets, final V[] objects) {
+ super(offsets, objects);
+ }
+
+ @Override
+ public 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 Map<K, Integer> offsets, final V[] objects) {
+ super(offsets, objects);
+ }
+
+ @Override
+ public MutableOffsetMap<K, V> toModifiableMap() {
+ return MutableOffsetMap.unorderedCopyOf(this);
+ }
+
+ @Override
+ void setFields(final List<K> keys, final V[] values) throws IOException {
+ final Map<K, Integer> offsets = OffsetMapCache.unorderedOffsets(keys);
+
+ setField(this, OFFSETS_FIELD, offsets);
+ setField(this, ARRAY_FIELD, OffsetMapCache.adjustedArray(offsets, keys, values));
+ }
+ }
+
private static final long serialVersionUID = 1L;
- private final Map<K, Integer> offsets;
- private final Object[] objects;
+ private transient final Map<K, Integer> offsets;
+ private transient final 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 Object[] objects) {
+ 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);
}
+ @Override
+ public abstract 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} 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 m Input map, may not be null.
+ * @return An isolated, immutable copy of the input map
+ * @deprecated Use {@link #orderedCopyOf(Map)} or {@link #unorderedCopyOf(Map)} instead.
*/
- protected ImmutableOffsetMap(@Nonnull final ImmutableOffsetMap<K, V> m) {
- this.offsets = m.offsets;
- this.objects = m.objects;
+ @Deprecated
+ @Nonnull public static <K, V> Map<K, V> copyOf(@Nonnull final Map<K, V> m) {
+ return orderedCopyOf(m);
}
/**
* @param m Input map, may not be null.
* @return An isolated, immutable copy of the input map
*/
- @Nonnull public static <K, V> Map<K, V> copyOf(@Nonnull final Map<K, V> m) {
- // Prevent a copy
- if (m instanceof ImmutableOffsetMap) {
+ @Nonnull public static <K, V> Map<K, V> orderedCopyOf(@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;
}
- // Better-packed
+ // Familiar and efficient to copy
+ if (m instanceof MutableOffsetMap) {
+ return ((MutableOffsetMap<K, V>) m).toUnmodifiableMap();
+ }
+
final int size = m.size();
if (size == 0) {
+ // Shares a single object
return ImmutableMap.of();
}
if (size == 1) {
- return ImmutableMap.copyOf(m);
+ // Efficient single-entry implementation
+ final Entry<K, V> e = m.entrySet().iterator().next();
+ return SharedSingletonMap.orderedOf(e.getKey(), e.getValue());
+ }
+
+ final Map<K, Integer> offsets = OffsetMapCache.orderedOffsets(m.keySet());
+ @SuppressWarnings("unchecked")
+ final V[] array = (V[]) new Object[offsets.size()];
+ for (Entry<K, V> e : m.entrySet()) {
+ array[offsets.get(e.getKey())] = e.getValue();
}
- // Familiar and efficient
+ 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}. Iterator order is not
+ * guaranteed to be retained.
+ *
+ * @param m Input map, may not be null.
+ * @return An isolated, immutable copy of the input map
+ */
+ @Nonnull public static <K, V> Map<K, V> unorderedCopyOf(@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();
}
- final Map<K, Integer> offsets = OffsetMapCache.offsetsFor(m.keySet());
+ final int size = m.size();
+ if (size == 0) {
+ // Shares a single object
+ return ImmutableMap.of();
+ }
+ if (size == 1) {
+ // Efficient single-entry implementation
+ final Entry<K, V> e = m.entrySet().iterator().next();
+ return SharedSingletonMap.unorderedOf(e.getKey(), e.getValue());
+ }
+
+ final Map<K, Integer> offsets = OffsetMapCache.unorderedOffsets(m.keySet());
@SuppressWarnings("unchecked")
final V[] array = (V[]) new Object[offsets.size()];
for (Entry<K, V> e : m.entrySet()) {
array[offsets.get(e.getKey())] = e.getValue();
}
- return new ImmutableOffsetMap<>(offsets, array);
+ return new Unordered<>(offsets, array);
}
@Override
}
@Override
- public boolean equals(final Object o) {
+ public final int hashCode() {
+ if (hashCode != 0) {
+ return hashCode;
+ }
+
+ int result = 0;
+ for (Entry<K, Integer> e : offsets.entrySet()) {
+ result += e.getKey().hashCode() ^ objects[e.getValue()].hashCode();
+ }
+
+ hashCode = result;
+ return result;
+ }
+
+ @Override
+ public final boolean equals(final Object o) {
if (o == this) {
return true;
}
- if (o == null) {
+ if (!(o 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 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) {
// Let MutableOffsetMap do the actual work.
return o.equals(this);
- } else if (o instanceof Map) {
- final Map<?, ?> om = (Map<?, ?>)o;
+ }
- // Size and key sets have to match
- if (size() != om.size() || !keySet().equals(om.keySet())) {
- return false;
- }
+ final Map<?, ?> other = (Map<?, ?>)o;
+
+ // 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()) {
- final V v = objectToValue(e.getKey(), objects[e.getValue()]);
- if (!v.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() and indicate 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
@Override
public final boolean containsValue(final Object value) {
- @SuppressWarnings("unchecked")
- final Object obj = valueToObject((V)value);
for (Object o : objects) {
- if (Objects.equals(obj, o)) {
+ if (value.equals(o)) {
return true;
}
}
return false;
}
- @SuppressWarnings("unchecked")
@Override
public final V get(final Object key) {
final Integer offset = offsets.get(key);
- if (offset == null) {
- return null;
- }
-
- return objectToValue((K) key, objects[offset]);
+ return offset == null ? null : objects[offset];
}
@Override
throw new UnsupportedOperationException();
}
+ @Override
+ public final V put(final K key, final V value) {
+ throw new UnsupportedOperationException();
+ }
+
@Override
public final void putAll(final Map<? extends K, ? extends V> m) {
throw new UnsupportedOperationException();
return offsets.keySet();
}
+ @Override
+ public final Collection<V> values() {
+ return new ConstantArrayCollection<>(objects);
+ }
+
@Override
public final Set<Entry<K, V>> entrySet() {
return new EntrySet();
}
@Override
- public MutableOffsetMap<K, V> toModifiableMap() {
- return new MutableOffsetMap<>(this);
+ public final String toString() {
+ final StringBuilder sb = new StringBuilder("{");
+ final Iterator<K> it = offsets.keySet().iterator();
+ int i = 0;
+ while (it.hasNext()) {
+ sb.append(it.next());
+ sb.append('=');
+ sb.append(objects[i++]);
+
+ if (it.hasNext()) {
+ sb.append(", ");
+ }
+ }
+
+ return sb.append('}').toString();
}
- Map<K, Integer> offsets() {
+ final Map<K, Integer> offsets() {
return offsets;
}
- Object[] objects() {
+ final V[] objects() {
return objects;
}
@Override
public Entry<K, V> next() {
final Entry<K, Integer> e = it.next();
- return new SimpleEntry<>(e.getKey(), objectToValue(e.getKey(), objects[e.getValue()]));
+ return new SimpleImmutableEntry<>(e.getKey(), objects[e.getValue()]);
}
};
}
return f;
}
- private void setField(final Field field, final Object value) throws IOException {
+ private static void setField(final ImmutableOffsetMap<?, ?> map, final 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);
}
values[i] = (V)in.readObject();
}
- setField(OFFSETS_FIELD, OffsetMapCache.offsetsFor(keys));
- setField(ARRAY_FIELD, values);
+ setFields(keys, values);
}
}
Code Review / yangtools.git / blobdiff