com.gs.collections.impl.map.strategy.mutable

Class UnifiedMapWithHashingStrategy<K,V>

java.lang.Object

com.gs.collections.impl.map.AbstractMapIterable<K,V>

com.gs.collections.impl.map.mutable.AbstractMutableMap<K,V>

com.gs.collections.impl.map.strategy.mutable.UnifiedMapWithHashingStrategy<K,V>

All Implemented Interfaces:

com.gs.collections.api.InternalIterable<V>, com.gs.collections.api.map.MapIterable<K,V>, com.gs.collections.api.map.MutableMap<K,V>, com.gs.collections.api.map.UnsortedMapIterable<K,V>, com.gs.collections.api.RichIterable<V>, BatchIterable<V>, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<V>, java.util.Map<K,V>

@NotThreadSafe
public class UnifiedMapWithHashingStrategy<K,V>
extends AbstractMutableMap<K,V>
implements java.io.Externalizable, BatchIterable<V>

UnifiedMapWithHashingStrategy stores key/value pairs in a single array, where alternate slots are keys and values. This is nicer to CPU caches as consecutive memory addresses are very cheap to access. Entry objects are not stored in the table like in java.util.HashMap. Instead of trying to deal with collisions in the main array using Entry objects, we put a special object in the key slot and put a regular Object[] in the value slot. The array contains the key value pairs in consecutive slots, just like the main array, but it's a linear list with no hashing.

The difference between UnifiedMap and UnifiedMapWithHashingStrategy is that a HashingStrategy based UnifiedMap does not rely on the hashCode or equality of the object at the key, but instead relies on a HashingStrategy implementation provided by a developer to compute the hashCode and equals for the objects stored in the map.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	UnifiedMapWithHashingStrategy.EntrySet
protected class	UnifiedMapWithHashingStrategy.EntrySetIterator
protected class	UnifiedMapWithHashingStrategy.KeySet
protected class	UnifiedMapWithHashingStrategy.KeySetIterator
protected class	UnifiedMapWithHashingStrategy.PositionalIterator<T>
protected class	UnifiedMapWithHashingStrategy.ValuesCollection
protected class	UnifiedMapWithHashingStrategy.ValuesIterator
protected static class	UnifiedMapWithHashingStrategy.WeakBoundEntry<K,V>

Nested classes/interfaces inherited from class com.gs.collections.impl.map.mutable.AbstractMutableMap

AbstractMutableMap.ValuesCollectionCommon<V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Object	CHAINED_KEY
protected static int	DEFAULT_INITIAL_CAPACITY
protected static float	DEFAULT_LOAD_FACTOR
protected float	loadFactor
protected int	maxSize
protected static java.lang.Object	NULL_KEY
protected int	occupied
protected java.lang.Object[]	table

Constructor Summary

Constructors

Constructor and Description
UnifiedMapWithHashingStrategy() Deprecated. No argument default constructor used for serialization. Instantiating an UnifiedMapWithHashingStrategyMultimap with this constructor will have a null hashingStrategy and throw NullPointerException when used.
UnifiedMapWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy)
UnifiedMapWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, int initialCapacity)
UnifiedMapWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, int initialCapacity, float loadFactor)
UnifiedMapWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, java.util.Map<? extends K,? extends V> map)
UnifiedMapWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, com.gs.collections.api.tuple.Pair<K,V>... pairs)

Method Summary

Methods

Modifier and Type	Method and Description
protected int	allocate(int capacity)
protected void	allocateTable(int sizeToAllocate)
void	batchForEach(com.gs.collections.api.block.procedure.Procedure<? super V> procedure, int sectionIndex, int sectionCount)
void	clear()
UnifiedMapWithHashingStrategy<K,V>	clone() Returns a string representation of this map.
<E> com.gs.collections.api.map.MutableMap<K,V>	collectKeysAndValues(java.lang.Iterable<E> iterable, com.gs.collections.api.block.function.Function<? super E,? extends K> keyFunction, com.gs.collections.api.block.function.Function<? super E,? extends V> valueFunction) Adds all the entries derived from collection to this.
protected void	computeMaxSize(int capacity)
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
protected void	copyMap(UnifiedMapWithHashingStrategy<K,V> unifiedMap)
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
boolean	equals(java.lang.Object object) Follows the same general contract as Map.equals(Object).
void	forEachKey(com.gs.collections.api.block.procedure.Procedure<? super K> procedure) Calls the procedure with each key of the map.
void	forEachKeyValue(com.gs.collections.api.block.procedure.Procedure2<? super K,? super V> procedure) Calls the procedure with each key-value pair of the map.
void	forEachValue(com.gs.collections.api.block.procedure.Procedure<? super V> procedure) Calls the procedure with each value of the map.
<P> void	forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super V,? super P> procedure, P parameter) The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
void	forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super V> objectIntProcedure) Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
V	get(java.lang.Object key)
int	getBatchCount(int batchSize)
int	getCollidingBuckets()
V	getIfAbsentPut(K key, com.gs.collections.api.block.function.Function0<? extends V> function) Get and return the value in the Map at the specified key.
V	getIfAbsentPut(K key, V value) Get and return the value in the Map at the specified key.
<P> V	getIfAbsentPutWith(K key, com.gs.collections.api.block.function.Function<? super P,? extends V> function, P parameter) Get and return the value in the Map at the specified key.
int	getMapMemoryUsedInWords() Returns the number of JVM words that is used by this map.
int	hashCode() Follows the same general contract as Map.hashCode().
com.gs.collections.api.block.HashingStrategy<? super K>	hashingStrategy()
protected int	index(K key)
protected int	init(int initialCapacity)
boolean	isEmpty() Returns true if this iterable has zero items.
java.util.Set<K>	keySet()
com.gs.collections.api.map.MutableMap<K,V>	newEmpty() Creates a new instance of the same type, using the default capacity and growth parameters.
com.gs.collections.api.map.MutableMap<K,V>	newEmpty(int capacity) Creates a new instance of the same type, using the given capacity and the default growth parameters.
static <K,V> UnifiedMapWithHashingStrategy<K,V>	newMap(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy)
static <K,V> UnifiedMapWithHashingStrategy<K,V>	newMap(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, int size)
static <K,V> UnifiedMapWithHashingStrategy<K,V>	newMap(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, int size, float loadFactor)
static <K,V> UnifiedMapWithHashingStrategy<K,V>	newMap(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, java.util.Map<? extends K,? extends V> map)
static <K,V> UnifiedMapWithHashingStrategy<K,V>	newMap(UnifiedMapWithHashingStrategy<K,V> map)
static <K,V> UnifiedMapWithHashingStrategy<K,V>	newMapWith(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, com.gs.collections.api.tuple.Pair<K,V>... pairs)
static <K,V> UnifiedMapWithHashingStrategy<K,V>	newWithKeysValues(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, K key, V value)
static <K,V> UnifiedMapWithHashingStrategy<K,V>	newWithKeysValues(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, K key1, V value1, K key2, V value2)
static <K,V> UnifiedMapWithHashingStrategy<K,V>	newWithKeysValues(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, K key1, V value1, K key2, V value2, K key3, V value3)
static <K,V> UnifiedMapWithHashingStrategy<K,V>	newWithKeysValues(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy, K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4)
V	put(K key, V value)
void	putAll(java.util.Map<? extends K,? extends V> map)
void	readExternal(java.io.ObjectInput in)
protected void	rehash(int newCapacity)
V	remove(java.lang.Object key)
V	removeKey(K key) Remove an entry from the map at the specified key.
int	size() Returns the number of items in this iterable.
com.gs.collections.api.map.ImmutableMap<K,V>	toImmutable() Returns an immutable copy of this map.
java.lang.String	toString() Returns a string representation of this MapIterable.
V	updateValue(K key, com.gs.collections.api.block.function.Function0<? extends V> factory, com.gs.collections.api.block.function.Function<? super V,? extends V> function) Looks up the value associated with key, applies the function to it, and replaces the value.
<P> V	updateValueWith(K key, com.gs.collections.api.block.function.Function0<? extends V> factory, com.gs.collections.api.block.function.Function2<? super V,? super P,? extends V> function, P parameter) Same as MutableMap.updateValue(Object, Function0, Function) with a Function2 and specified parameter which is passed to the function.
java.util.Collection<V>	values()
UnifiedMapWithHashingStrategy<K,V>	withKeysValues(K key, V value)
UnifiedMapWithHashingStrategy<K,V>	withKeysValues(K key1, V value1, K key2, V value2)
UnifiedMapWithHashingStrategy<K,V>	withKeysValues(K key1, V value1, K key2, V value2, K key3, V value3)
UnifiedMapWithHashingStrategy<K,V>	withKeysValues(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4)
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class com.gs.collections.impl.map.mutable.AbstractMutableMap

add, aggregateBy, aggregateInPlaceBy, asSynchronized, asUnmodifiable, collect, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectValues, collectWith, detect, flatCollect, flip, flipUniqueValues, getIfAbsentPutWithKey, groupBy, groupByEach, groupByUniqueKey, iterator, keysView, keyValuesView, partition, partitionWith, reject, reject, select, select, selectInstancesOf, selectWith, valuesView, withAllKeyValueArguments, withAllKeyValues, withKeyValue, withoutAllKeys, withoutKey, zip, zipWithIndex

Methods inherited from class com.gs.collections.impl.map.AbstractMapIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, forEach, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, groupBy, groupByEach, ifPresentApply, injectInto, injectInto, injectInto, injectInto, injectInto, isAbsent, keyAndValueEquals, keyAndValueHashCode, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gs.collections.impl.parallel.BatchIterable

forEach

Methods inherited from interface com.gs.collections.api.map.MapIterable

getIfAbsent, getIfAbsentValue, getIfAbsentWith, ifPresentApply

Methods inherited from interface com.gs.collections.api.RichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable

forEach

Field Detail

NULL_KEY

protected static final java.lang.Object NULL_KEY

CHAINED_KEY

protected static final java.lang.Object CHAINED_KEY

DEFAULT_LOAD_FACTOR

protected static final float DEFAULT_LOAD_FACTOR

See Also:

Constant Field Values

DEFAULT_INITIAL_CAPACITY

protected static final int DEFAULT_INITIAL_CAPACITY

See Also:

Constant Field Values

table

protected transient java.lang.Object[] table

occupied

protected transient int occupied

loadFactor

protected float loadFactor

maxSize

protected int maxSize

Constructor Detail

UnifiedMapWithHashingStrategy

@Deprecated
public UnifiedMapWithHashingStrategy()

Deprecated. No argument default constructor used for serialization. Instantiating an UnifiedMapWithHashingStrategyMultimap with this constructor will have a null hashingStrategy and throw NullPointerException when used.

UnifiedMapWithHashingStrategy

public UnifiedMapWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy)

UnifiedMapWithHashingStrategy

public UnifiedMapWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                             int initialCapacity)

UnifiedMapWithHashingStrategy

public UnifiedMapWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                             int initialCapacity,
                             float loadFactor)

UnifiedMapWithHashingStrategy

public UnifiedMapWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                             java.util.Map<? extends K,? extends V> map)

UnifiedMapWithHashingStrategy

public UnifiedMapWithHashingStrategy(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                             com.gs.collections.api.tuple.Pair<K,V>... pairs)

Method Detail

newMap

public static <K,V> UnifiedMapWithHashingStrategy<K,V> newMap(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy)

newMap

public static <K,V> UnifiedMapWithHashingStrategy<K,V> newMap(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                                              int size)

newMap

public static <K,V> UnifiedMapWithHashingStrategy<K,V> newMap(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                                              int size,
                                              float loadFactor)

newMap

public static <K,V> UnifiedMapWithHashingStrategy<K,V> newMap(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                                              java.util.Map<? extends K,? extends V> map)

newMap

public static <K,V> UnifiedMapWithHashingStrategy<K,V> newMap(UnifiedMapWithHashingStrategy<K,V> map)

newMapWith

public static <K,V> UnifiedMapWithHashingStrategy<K,V> newMapWith(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                                                  com.gs.collections.api.tuple.Pair<K,V>... pairs)

newWithKeysValues

public static <K,V> UnifiedMapWithHashingStrategy<K,V> newWithKeysValues(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                                                         K key,
                                                         V value)

newWithKeysValues

public static <K,V> UnifiedMapWithHashingStrategy<K,V> newWithKeysValues(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                                                         K key1,
                                                         V value1,
                                                         K key2,
                                                         V value2)

newWithKeysValues

public static <K,V> UnifiedMapWithHashingStrategy<K,V> newWithKeysValues(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                                                         K key1,
                                                         V value1,
                                                         K key2,
                                                         V value2,
                                                         K key3,
                                                         V value3)

newWithKeysValues

public static <K,V> UnifiedMapWithHashingStrategy<K,V> newWithKeysValues(com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy,
                                                         K key1,
                                                         V value1,
                                                         K key2,
                                                         V value2,
                                                         K key3,
                                                         V value3,
                                                         K key4,
                                                         V value4)

withKeysValues

public UnifiedMapWithHashingStrategy<K,V> withKeysValues(K key,
                                                V value)

withKeysValues

public UnifiedMapWithHashingStrategy<K,V> withKeysValues(K key1,
                                                V value1,
                                                K key2,
                                                V value2)

withKeysValues

public UnifiedMapWithHashingStrategy<K,V> withKeysValues(K key1,
                                                V value1,
                                                K key2,
                                                V value2,
                                                K key3,
                                                V value3)

withKeysValues

public UnifiedMapWithHashingStrategy<K,V> withKeysValues(K key1,
                                                V value1,
                                                K key2,
                                                V value2,
                                                K key3,
                                                V value3,
                                                K key4,
                                                V value4)

hashingStrategy

public com.gs.collections.api.block.HashingStrategy<? super K> hashingStrategy()

clone

public UnifiedMapWithHashingStrategy<K,V> clone()

Description copied from class: AbstractMutableMap

Returns a string representation of this map. The string representation consists of a list of key-value mappings in the order returned by the map's entrySet view's iterator, enclosed in braces ("{}"). Adjacent mappings are separated by the characters ", " (comma and space). Each key-value mapping is rendered as the key followed by an equals sign ("=") followed by the associated value. Keys and values are converted to strings as by String.valueOf(Object).

This implementation creates an empty string buffer, appends a left brace, and iterates over the map's entrySet view, appending the string representation of each map.entry in turn. After appending each entry except the last, the string ", " is appended. Finally a right brace is appended. A string is obtained from the stringbuffer, and returned.

Specified by:

clone in interface com.gs.collections.api.map.MutableMap<K,V>

Specified by:

clone in class AbstractMutableMap<K,V>

Returns:

a String representation of this map.

newEmpty

public com.gs.collections.api.map.MutableMap<K,V> newEmpty()

Description copied from interface: com.gs.collections.api.map.MutableMap

Creates a new instance of the same type, using the default capacity and growth parameters.

Specified by:

newEmpty in interface com.gs.collections.api.map.MutableMap<K,V>

newEmpty

public com.gs.collections.api.map.MutableMap<K,V> newEmpty(int capacity)

Description copied from class: AbstractMutableMap

Creates a new instance of the same type, using the given capacity and the default growth parameters.

Specified by:

newEmpty in class AbstractMutableMap<K,V>

init

protected int init(int initialCapacity)

allocate

protected int allocate(int capacity)

allocateTable

protected void allocateTable(int sizeToAllocate)

computeMaxSize

protected void computeMaxSize(int capacity)

index

protected final int index(K key)

clear

public void clear()

Specified by:

clear in interface java.util.Map<K,V>

put

public V put(K key,
    V value)

Specified by:

put in interface java.util.Map<K,V>

updateValue

public V updateValue(K key,
            com.gs.collections.api.block.function.Function0<? extends V> factory,
            com.gs.collections.api.block.function.Function<? super V,? extends V> function)

Description copied from interface: com.gs.collections.api.map.MutableMap

Looks up the value associated with key, applies the function to it, and replaces the value. If there is no value associated with key, starts it off with a value supplied by factory.

Specified by:

updateValue in interface com.gs.collections.api.map.MutableMap<K,V>

Overrides:

updateValue in class AbstractMutableMap<K,V>

updateValueWith

public <P> V updateValueWith(K key,
                    com.gs.collections.api.block.function.Function0<? extends V> factory,
                    com.gs.collections.api.block.function.Function2<? super V,? super P,? extends V> function,
                    P parameter)

Description copied from interface: com.gs.collections.api.map.MutableMap

Same as MutableMap.updateValue(Object, Function0, Function) with a Function2 and specified parameter which is passed to the function.

Specified by:

updateValueWith in interface com.gs.collections.api.map.MutableMap<K,V>

Overrides:

updateValueWith in class AbstractMutableMap<K,V>

getIfAbsentPut

public V getIfAbsentPut(K key,
               com.gs.collections.api.block.function.Function0<? extends V> function)

Description copied from interface: com.gs.collections.api.map.MutableMap

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map at the key, return the result of evaluating the specified Function0, and put that value in the map at the specified key.

Specified by:

getIfAbsentPut in interface com.gs.collections.api.map.MutableMap<K,V>

Overrides:

getIfAbsentPut in class AbstractMutableMap<K,V>

getIfAbsentPut

public V getIfAbsentPut(K key,
               V value)

Description copied from interface: com.gs.collections.api.map.MutableMap

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map at the key, return the specified value, and put that value in the map at the specified key.

Specified by:

getIfAbsentPut in interface com.gs.collections.api.map.MutableMap<K,V>

Overrides:

getIfAbsentPut in class AbstractMutableMap<K,V>

getIfAbsentPutWith

public <P> V getIfAbsentPutWith(K key,
                       com.gs.collections.api.block.function.Function<? super P,? extends V> function,
                       P parameter)

Description copied from interface: com.gs.collections.api.map.MutableMap

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map for that key return the result of evaluating the specified Function using the specified parameter, and put that value in the map at the specified key.

Specified by:

getIfAbsentPutWith in interface com.gs.collections.api.map.MutableMap<K,V>

Overrides:

getIfAbsentPutWith in class AbstractMutableMap<K,V>

getCollidingBuckets

public int getCollidingBuckets()

getMapMemoryUsedInWords

public int getMapMemoryUsedInWords()

Returns the number of JVM words that is used by this map. A word is 4 bytes in a 32bit VM and 8 bytes in a 64bit VM. Each array has a 2 word header, thus the formula is: words = (internal table length + 2) + sum (for all chains (chain length + 2))

Returns:

the number of JVM words that is used by this map.

rehash

protected void rehash(int newCapacity)

get

public V get(java.lang.Object key)

Specified by:

get in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

get in interface java.util.Map<K,V>

See Also:

Map.get(Object)

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

containsKey in interface java.util.Map<K,V>

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

containsValue in interface java.util.Map<K,V>

See Also:

Map.containsValue(Object)

forEachKeyValue

public void forEachKeyValue(com.gs.collections.api.block.procedure.Procedure2<? super K,? super V> procedure)

Description copied from interface: com.gs.collections.api.map.MapIterable

Calls the procedure with each key-value pair of the map.

     final Collection<String> collection = new ArrayList<String>();
     MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "One", 2, "Two", 3, "Three");
     map.forEachKeyValue(new Procedure2<Integer, String>()
     {
         public void value(final Integer key, final String value)
         {
             collection.add(String.valueOf(key) + value);
         }
     });
     Verify.assertContainsAll(collection, "1One", "2Two", "3Three");
 

Specified by:

forEachKeyValue in interface com.gs.collections.api.map.MapIterable<K,V>

collectKeysAndValues

public <E> com.gs.collections.api.map.MutableMap<K,V> collectKeysAndValues(java.lang.Iterable<E> iterable,
                                                                  com.gs.collections.api.block.function.Function<? super E,? extends K> keyFunction,
                                                                  com.gs.collections.api.block.function.Function<? super E,? extends V> valueFunction)

Description copied from interface: com.gs.collections.api.map.MutableMap

Adds all the entries derived from collection to this. The key and value for each entry is determined by applying the keyFunction and valueFunction to each item in collection. Any entry in map that has the same key as an entry in this will have it's value replaced by that in map.

Specified by:

collectKeysAndValues in interface com.gs.collections.api.map.MutableMap<K,V>

removeKey

public V removeKey(K key)

Description copied from interface: com.gs.collections.api.map.MutableMap

Remove an entry from the map at the specified key.

Specified by:

removeKey in interface com.gs.collections.api.map.MutableMap<K,V>

Returns:

The value removed from entry at key, or null if not found.

See Also:

Map.remove(Object)

getBatchCount

public int getBatchCount(int batchSize)

Specified by:

getBatchCount in interface BatchIterable<V>

batchForEach

public void batchForEach(com.gs.collections.api.block.procedure.Procedure<? super V> procedure,
                int sectionIndex,
                int sectionCount)

Specified by:

batchForEach in interface BatchIterable<V>

forEachKey

public void forEachKey(com.gs.collections.api.block.procedure.Procedure<? super K> procedure)

Description copied from interface: com.gs.collections.api.map.MapIterable

Calls the procedure with each key of the map.

     final Collection<Integer> result = new ArrayList<Integer>();
     MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
     map.forEachKey(new CollectionAddProcedure<Integer>(result));
     Verify.assertContainsAll(result, 1, 2, 3);
 

Specified by:

forEachKey in interface com.gs.collections.api.map.MapIterable<K,V>

Overrides:

forEachKey in class AbstractMapIterable<K,V>

forEachValue

public void forEachValue(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)

Description copied from interface: com.gs.collections.api.map.MapIterable

Calls the procedure with each value of the map.

     Set<String> result = UnifiedSet.newSet();
     MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "One", 2, "Two", 3, "Three", 4, "Four");
     map.forEachValue(new CollectionAddProcedure<String>(result));
     Verify.assertSetsEqual(UnifiedSet.newSetWith("One", "Two", "Three", "Four"), result);
 

Specified by:

forEachValue in interface com.gs.collections.api.map.MapIterable<K,V>

Overrides:

forEachValue in class AbstractMapIterable<K,V>

isEmpty

public boolean isEmpty()

Description copied from interface: com.gs.collections.api.RichIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface com.gs.collections.api.RichIterable<V>

Specified by:

isEmpty in interface java.util.Map<K,V>

Overrides:

isEmpty in class AbstractMapIterable<K,V>

putAll

public void putAll(java.util.Map<? extends K,? extends V> map)

Specified by:

putAll in interface java.util.Map<K,V>

copyMap

protected void copyMap(UnifiedMapWithHashingStrategy<K,V> unifiedMap)

remove

public V remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<K,V>

size

public int size()

Description copied from interface: com.gs.collections.api.RichIterable

Returns the number of items in this iterable.

Specified by:

size in interface com.gs.collections.api.RichIterable<V>

Specified by:

size in interface BatchIterable<V>

Specified by:

size in interface java.util.Map<K,V>

entrySet

public java.util.Set<java.util.Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface java.util.Map<K,V>

keySet

public java.util.Set<K> keySet()

Specified by:

keySet in interface java.util.Map<K,V>

values

public java.util.Collection<V> values()

Specified by:

values in interface java.util.Map<K,V>

equals

public boolean equals(java.lang.Object object)

Description copied from interface: com.gs.collections.api.map.MapIterable

Follows the same general contract as Map.equals(Object).

Specified by:

equals in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

equals in interface java.util.Map<K,V>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Description copied from interface: com.gs.collections.api.map.MapIterable

Follows the same general contract as Map.hashCode().

Specified by:

hashCode in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

hashCode in interface java.util.Map<K,V>

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Description copied from interface: com.gs.collections.api.map.MapIterable

Returns a string representation of this MapIterable. The string representation consists of a list of the map's key-value pairs in the order they are returned by its iterator. The key and value in each key-value pair are separated by a colon (":") and each pair is enclosed in square brackets ("[]"). Adjacent key-value pairs are separated by the characters ", " (comma and space). Keys and values are converted to strings as by String.valueOf(Object).

Specified by:

toString in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

toString in interface com.gs.collections.api.RichIterable<V>

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this MapIterable

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

forEachWithIndex

public void forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super V> objectIntProcedure)

Description copied from interface: com.gs.collections.api.InternalIterable

Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure

e.g.
 people.forEachWithIndex(new ObjectIntProcedure()
 {
     public void value(Person person, int index)
     {
         LOGGER.info("Index: " + index + " person: " + person.getName());
     }
 });
 

Specified by:

forEachWithIndex in interface com.gs.collections.api.InternalIterable<V>

Overrides:

forEachWithIndex in class AbstractMapIterable<K,V>

forEachWith

public <P> void forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super V,? super P> procedure,
                   P parameter)

Description copied from interface: com.gs.collections.api.InternalIterable

The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.

e.g.
 people.forEachWith(new Procedure2()
 {
     public void value(Person person, Person other)
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }
 }, fred);
 

Specified by:

forEachWith in interface com.gs.collections.api.InternalIterable<V>

Overrides:

forEachWith in class AbstractMapIterable<K,V>

toImmutable

public com.gs.collections.api.map.ImmutableMap<K,V> toImmutable()

Description copied from interface: com.gs.collections.api.map.MutableMap

Returns an immutable copy of this map. If the map is immutable, it returns itself.

The returned map will be Serializable if this map is Serializable.

Specified by:

toImmutable in interface com.gs.collections.api.map.MutableMap<K,V>

Specified by:

toImmutable in interface com.gs.collections.api.map.UnsortedMapIterable<K,V>

Overrides:

toImmutable in class AbstractMutableMap<K,V>