drv.Maps.drv Maven / Gradle / Ivy
/*
* Copyright (C) 2002-2017 Sebastiano Vigna
*
* 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 PACKAGE;
import it.unimi.dsi.fastutil.objects.ObjectSet;
import it.unimi.dsi.fastutil.objects.ObjectSets;
import VALUE_PACKAGE.VALUE_COLLECTION;
import VALUE_PACKAGE.VALUE_COLLECTIONS;
#if ! VALUE_CLASS_Object
import VALUE_PACKAGE.VALUE_SETS;
#endif
import java.util.Map;
/** A class providing static methods and objects that do useful things with type-specific maps.
*
* @see it.unimi.dsi.fastutil.Maps
* @see java.util.Collections
*/
public class MAPS {
private MAPS() {}
/** An immutable class representing an empty type-specific map.
*
* This class may be useful to implement your own in case you subclass
* a type-specific map.
*/
public static class EmptyMap KEY_VALUE_GENERIC extends FUNCTIONS.EmptyFunction KEY_VALUE_GENERIC implements MAP KEY_VALUE_GENERIC, java.io.Serializable, Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected EmptyMap() {}
@Override
public boolean containsValue(final VALUE_TYPE v) { return false; }
#if VALUES_PRIMITIVE
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
public boolean containsValue(final Object ov) { return false; }
#endif
@Override
public void putAll(final Map m) { throw new UnsupportedOperationException(); }
@SuppressWarnings("unchecked")
@Override
public ObjectSet ENTRYSET() { return ObjectSets.EMPTY_SET; }
#if KEYS_PRIMITIVE || VALUES_PRIMITIVE
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
#else
/** {@inheritDoc} */
#endif
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
public ObjectSet> entrySet() { return (ObjectSet)ENTRYSET(); }
SUPPRESS_WARNINGS_KEY_UNCHECKED
@Override
public SET KEY_GENERIC keySet() { return SETS.EMPTY_SET; }
SUPPRESS_WARNINGS_VALUE_UNCHECKED
@Override
public VALUE_COLLECTION VALUE_GENERIC values() { return VALUE_SETS.EMPTY_SET; }
private Object readResolve() { return EMPTY_MAP; }
@Override
public Object clone() { return EMPTY_MAP; }
@Override
public boolean isEmpty() { return true; }
@Override
public int hashCode() { return 0; }
@Override
public boolean equals(final Object o) {
if (! (o instanceof Map)) return false;
return ((Map)o).isEmpty();
}
@Override
public String toString() { return "{}"; }
}
/** An empty type-specific map (immutable). It is serializable and cloneable.
*/
SUPPRESS_WARNINGS_KEY_VALUE_RAWTYPES
public static final EmptyMap EMPTY_MAP = new EmptyMap();
#if KEYS_REFERENCE || VALUES_REFERENCE
/** Returns an empty map (immutable). It is serializable and cloneable.
*
* This method provides a typesafe access to {@link #EMPTY_MAP}.
* @return an empty map (immutable).
*/
@SuppressWarnings("unchecked")
public static KEY_VALUE_GENERIC MAP KEY_VALUE_GENERIC emptyMap() {
return EMPTY_MAP;
}
#endif
/** An immutable class representing a type-specific singleton map.
*
*
This class may be useful to implement your own in case you subclass
* a type-specific map.
*/
public static class Singleton KEY_VALUE_GENERIC extends FUNCTIONS.Singleton KEY_VALUE_GENERIC implements MAP KEY_VALUE_GENERIC, java.io.Serializable, Cloneable {
private static final long serialVersionUID = -7046029254386353129L;
protected transient ObjectSet entries;
protected transient SET KEY_GENERIC keys;
protected transient VALUE_COLLECTION VALUE_GENERIC values;
protected Singleton(final KEY_GENERIC_TYPE key, final VALUE_GENERIC_TYPE value) {
super(key, value);
}
@Override
public boolean containsValue(final VALUE_TYPE v) { return VALUE_EQUALS(value, v); }
#if VALUES_PRIMITIVE
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
public boolean containsValue(final Object ov) { return VALUE_EQUALS(VALUE_OBJ2TYPE(ov), value); }
#endif
@Override
public void putAll(final Map m) { throw new UnsupportedOperationException(); }
@Override
public ObjectSet ENTRYSET() { if (entries == null) entries = ObjectSets.singleton((MAP.Entry KEY_VALUE_GENERIC)new ABSTRACT_MAP.BasicEntry KEY_VALUE_GENERIC(key, value)); return entries; }
#if KEYS_PRIMITIVE || VALUES_PRIMITIVE
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
#else
/** {@inheritDoc} */
#endif
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
public ObjectSet> entrySet() { return (ObjectSet)ENTRYSET(); }
@Override
public SET KEY_GENERIC keySet() { if (keys == null) keys = SETS.singleton(key); return keys; }
@Override
public VALUE_COLLECTION VALUE_GENERIC values() { if (values == null) values = VALUE_SETS.singleton(value); return values; }
@Override
public boolean isEmpty() { return false; }
@Override
public int hashCode() { return KEY2JAVAHASH(key) ^ VALUE2JAVAHASH(value); }
@Override
public boolean equals(final Object o) {
if (o == this) return true;
if (! (o instanceof Map)) return false;
Map m = (Map)o;
if (m.size() != 1) return false;
return m.entrySet().iterator().next().equals(entrySet().iterator().next());
}
@Override
public String toString() { return "{" + key + "=>" + value + "}"; }
}
/** Returns a type-specific immutable map containing only the specified pair. The returned map is serializable and cloneable.
*
* Note that albeit the returned map is immutable, its default return value may be changed.
*
* @param key the only key of the returned map.
* @param value the only value of the returned map.
* @return a type-specific immutable map containing just the pair <key,value>.
*/
public static KEY_VALUE_GENERIC MAP KEY_VALUE_GENERIC singleton(final KEY_GENERIC_TYPE key, VALUE_GENERIC_TYPE value) {
return new Singleton KEY_VALUE_GENERIC(key, value);
}
#if KEYS_PRIMITIVE || VALUES_PRIMITIVE
/** Returns a type-specific immutable map containing only the specified pair. The returned map is serializable and cloneable.
*
*
Note that albeit the returned map is immutable, its default return value may be changed.
*
* @param key the only key of the returned map.
* @param value the only value of the returned map.
* @return a type-specific immutable map containing just the pair <key,value>.
*/
public static KEY_VALUE_GENERIC MAP KEY_VALUE_GENERIC singleton(final KEY_GENERIC_CLASS key, final VALUE_GENERIC_CLASS value) {
return new Singleton KEY_VALUE_GENERIC(KEY_CLASS2TYPE(key), VALUE_CLASS2TYPE(value));
}
#endif
/** A synchronized wrapper class for maps. */
public static class SynchronizedMap KEY_VALUE_GENERIC extends FUNCTIONS.SynchronizedFunction KEY_VALUE_GENERIC implements MAP KEY_VALUE_GENERIC, java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected final MAP KEY_VALUE_GENERIC map;
protected transient ObjectSet entries;
protected transient SET KEY_GENERIC keys;
protected transient VALUE_COLLECTION VALUE_GENERIC values;
protected SynchronizedMap(final MAP KEY_VALUE_GENERIC m, final Object sync) {
super(m, sync);
this.map = m;
}
protected SynchronizedMap(final MAP KEY_VALUE_GENERIC m) {
super(m);
this.map = m;
}
@Override
public boolean containsValue(final VALUE_TYPE v) { synchronized(sync) { return map.containsValue(v); } }
#if VALUES_PRIMITIVE
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public boolean containsValue(final Object ov) { synchronized(sync) { return map.containsValue(ov); } }
#endif
@Override
public void putAll(final Map m) { synchronized(sync) { map.putAll(m); } }
@Override
public ObjectSet ENTRYSET() {
synchronized(sync) { if (entries == null) entries = ObjectSets.synchronize(map.ENTRYSET(), sync); return entries; }
}
#if KEYS_PRIMITIVE || VALUES_PRIMITIVE
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
#else
/** {@inheritDoc} */
#endif
@Override
@SuppressWarnings({ "unchecked", "rawtypes" })
public ObjectSet> entrySet() { return (ObjectSet)ENTRYSET(); }
@Override
public SET KEY_GENERIC keySet() {
synchronized(sync) { if (keys == null) keys = SETS.synchronize(map.keySet(), sync); return keys; }
}
@Override
public VALUE_COLLECTION VALUE_GENERIC values() {
synchronized(sync) { if (values == null) return VALUE_COLLECTIONS.synchronize(map.values(), sync); return values; }
}
@Override
public boolean isEmpty() { synchronized(sync) { return map.isEmpty(); } }
@Override
public int hashCode() { synchronized(sync) { return map.hashCode(); } }
@Override
public boolean equals(final Object o) { if (o == this) return true; synchronized(sync) { return map.equals(o); } }
private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException {
synchronized(sync) { s.defaultWriteObject(); }
}
}
/** Returns a synchronized type-specific map backed by the given type-specific map.
*
* @param m the map to be wrapped in a synchronized map.
* @return a synchronized view of the specified map.
* @see java.util.Collections#synchronizedMap(Map)
*/
public static KEY_VALUE_GENERIC MAP KEY_VALUE_GENERIC synchronize(final MAP KEY_VALUE_GENERIC m) { return new SynchronizedMap KEY_VALUE_GENERIC(m); }
/** Returns a synchronized type-specific map backed by the given type-specific map, using an assigned object to synchronize.
*
* @param m the map to be wrapped in a synchronized map.
* @param sync an object that will be used to synchronize the access to the map.
* @return a synchronized view of the specified map.
* @see java.util.Collections#synchronizedMap(Map)
*/
public static KEY_VALUE_GENERIC MAP KEY_VALUE_GENERIC synchronize(final MAP KEY_VALUE_GENERIC m, final Object sync) { return new SynchronizedMap KEY_VALUE_GENERIC(m, sync); }
/** An unmodifiable wrapper class for maps. */
public static class UnmodifiableMap KEY_VALUE_GENERIC extends FUNCTIONS.UnmodifiableFunction KEY_VALUE_GENERIC implements MAP KEY_VALUE_GENERIC, java.io.Serializable {
private static final long serialVersionUID = -7046029254386353129L;
protected final MAP KEY_VALUE_GENERIC map;
protected transient ObjectSet entries;
protected transient SET KEY_GENERIC keys;
protected transient VALUE_COLLECTION VALUE_GENERIC values;
protected UnmodifiableMap(final MAP KEY_VALUE_GENERIC m) {
super(m);
this.map = m;
}
@Override
public boolean containsValue(final VALUE_TYPE v) { return map.containsValue(v); }
#if VALUES_PRIMITIVE
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
@Override
public boolean containsValue(final Object ov) { return map.containsValue(ov); }
#endif
@Override
public boolean isEmpty() { return map.isEmpty(); }
@Override
public void putAll(final Map m) { throw new UnsupportedOperationException(); }
@Override
public ObjectSet ENTRYSET() { if (entries == null) entries = ObjectSets.unmodifiable(map.ENTRYSET()); return entries; }
#if KEYS_PRIMITIVE || VALUES_PRIMITIVE
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead. */
@Deprecated
#else
/** {@inheritDoc} */
#endif
@Override
@SuppressWarnings({ "unchecked", "rawtypes" })
public ObjectSet> entrySet() { return (ObjectSet)ENTRYSET(); }
@Override
public SET KEY_GENERIC keySet() { if (keys == null) keys = SETS.unmodifiable(map.keySet()); return keys; }
@Override
public VALUE_COLLECTION VALUE_GENERIC values() { if (values == null) return VALUE_COLLECTIONS.unmodifiable(map.values()); return values; }
}
/** Returns an unmodifiable type-specific map backed by the given type-specific map.
*
* @param m the map to be wrapped in an unmodifiable map.
* @return an unmodifiable view of the specified map.
* @see java.util.Collections#unmodifiableMap(Map)
*/
public static KEY_VALUE_GENERIC MAP KEY_VALUE_GENERIC unmodifiable(final MAP KEY_VALUE_GENERIC m) { return new UnmodifiableMap KEY_VALUE_GENERIC(m); }
}