com.gs.collections.impl.map.mutable

Class UnifiedMap<K,V>

java.lang.Object

com.gs.collections.impl.AbstractRichIterable<V>

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

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

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

com.gs.collections.impl.map.mutable.UnifiedMap<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.MutableMapIterable<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 UnifiedMap<K,V>
extends AbstractMutableMap<K,V>
implements java.io.Externalizable, BatchIterable<V>

UnifiedMap 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 final result is a Map implementation that's leaner than java.util.HashMap and faster than Trove's THashMap. The best of both approaches unified together, and thus the name UnifiedMap.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	UnifiedMap.EntrySet
protected class	UnifiedMap.EntrySetIterator
protected class	UnifiedMap.KeySet
protected class	UnifiedMap.KeySetIterator
protected class	UnifiedMap.PositionalIterator<T>
protected class	UnifiedMap.ValuesCollection
protected class	UnifiedMap.ValuesIterator
protected static class	UnifiedMap.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
UnifiedMap()
UnifiedMap(int initialCapacity)
UnifiedMap(int initialCapacity, float loadFactor)
UnifiedMap(java.util.Map<? extends K,? extends V> map)
UnifiedMap(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)
boolean	allSatisfy(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty.
<P> boolean	allSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter) Returns true if the predicate evaluates to true for every element of the collection, or returns false.
boolean	anySatisfy(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns true if the predicate evaluates to true for any element of the iterable.
<P> boolean	anySatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter) Returns true if the predicate evaluates to true for any element of the collection, or return false.
void	batchForEach(com.gs.collections.api.block.procedure.Procedure<? super V> procedure, int sectionIndex, int sectionCount)
void	clear()
UnifiedMap<K,V>	clone()
<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 iterable to this.
<R> com.gs.collections.api.map.MutableMap<K,R>	collectValues(com.gs.collections.api.block.function.Function2<? super K,? super V,? extends R> function) For each key and value of the map the function is evaluated.
protected void	computeMaxSize(int capacity)
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
protected void	copyMap(UnifiedMap<K,V> unifiedMap)
V	detect(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true.
com.gs.collections.api.tuple.Pair<K,V>	detect(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate) Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments.
V	detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super V> predicate, com.gs.collections.api.block.function.Function0<? extends V> function) Returns the first element of the iterable for which the predicate evaluates to true.
<P> V	detectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter) Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.
<P> V	detectWithIfNone(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter, com.gs.collections.api.block.function.Function0<? extends V> function) Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.
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().
protected int	index(java.lang.Object 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> UnifiedMap<K,V>	newMap()
static <K,V> UnifiedMap<K,V>	newMap(int size)
static <K,V> UnifiedMap<K,V>	newMap(int size, float loadFactor)
static <K,V> UnifiedMap<K,V>	newMap(java.util.Map<? extends K,? extends V> map)
static <K,V> UnifiedMap<K,V>	newMapWith(java.lang.Iterable<com.gs.collections.api.tuple.Pair<K,V>> inputIterable)
static <K,V> UnifiedMap<K,V>	newMapWith(com.gs.collections.api.tuple.Pair<K,V>... pairs)
static <K,V> UnifiedMap<K,V>	newWithKeysValues(K key, V value)
static <K,V> UnifiedMap<K,V>	newWithKeysValues(K key1, V value1, K key2, V value2)
static <K,V> UnifiedMap<K,V>	newWithKeysValues(K key1, V value1, K key2, V value2, K key3, V value3)
static <K,V> UnifiedMap<K,V>	newWithKeysValues(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4)
boolean	noneSatisfy(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty.
<P> boolean	noneSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter) Returns true if the predicate evaluates to false for every element of the collection, or return false.
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 collection.
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 MutableMapIterable.updateValue(Object, Function0, Function) with a Function2 and specified parameter which is passed to the function.
java.util.Collection<V>	values()
UnifiedMap<K,V>	withKeysValues(K key, V value)
UnifiedMap<K,V>	withKeysValues(K key1, V value1, K key2, V value2)
UnifiedMap<K,V>	withKeysValues(K key1, V value1, K key2, V value2, K key3, V value3)
UnifiedMap<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

asSynchronized, asUnmodifiable, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, flatCollect, flip, groupBy, groupByEach, partition, partitionWith, reject, reject, rejectWith, select, select, selectInstancesOf, selectWith, tap, withAllKeyValueArguments, withAllKeyValues, withKeyValue, withoutAllKeys, withoutKey, zip, zipWithIndex

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

add, aggregateBy, aggregateInPlaceBy, collect, flipUniqueValues, getIfAbsentPutWithKey, groupByUniqueKey, iterator, keysView, keyValuesView, valuesView

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

asLazy, chunk, contains, each, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, ifPresentApply, isAbsent, keyAndValueEquals, keyAndValueHashCode, toArray, toArray

Methods inherited from class com.gs.collections.impl.AbstractRichIterable

appendString, appendString, appendString, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAll, containsAllArguments, containsAllIterable, count, countWith, flatCollect, forEach, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, notEmpty, reject, rejectWith, select, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, 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.MutableMap

aggregateBy, aggregateInPlaceBy, collect, flipUniqueValues, groupByUniqueKey

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

add, getIfAbsentPutWithKey

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

getIfAbsent, getIfAbsentValue, getIfAbsentWith, ifPresentApply, keysView, keyValuesView, valuesView

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

appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, each, flatCollect, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, notEmpty, reject, rejectWith, select, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

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

forEach

Methods inherited from interface java.lang.Iterable

iterator

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

UnifiedMap

public UnifiedMap()

UnifiedMap

public UnifiedMap(int initialCapacity)

UnifiedMap

public UnifiedMap(int initialCapacity,
          float loadFactor)

UnifiedMap

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

UnifiedMap

public UnifiedMap(com.gs.collections.api.tuple.Pair<K,V>... pairs)

Method Detail

newMap

public static <K,V> UnifiedMap<K,V> newMap()

newMap

public static <K,V> UnifiedMap<K,V> newMap(int size)

newMap

public static <K,V> UnifiedMap<K,V> newMap(int size,
                           float loadFactor)

newMap

public static <K,V> UnifiedMap<K,V> newMap(java.util.Map<? extends K,? extends V> map)

newMapWith

public static <K,V> UnifiedMap<K,V> newMapWith(com.gs.collections.api.tuple.Pair<K,V>... pairs)

newMapWith

public static <K,V> UnifiedMap<K,V> newMapWith(java.lang.Iterable<com.gs.collections.api.tuple.Pair<K,V>> inputIterable)

newWithKeysValues

public static <K,V> UnifiedMap<K,V> newWithKeysValues(K key,
                                      V value)

newWithKeysValues

public static <K,V> UnifiedMap<K,V> newWithKeysValues(K key1,
                                      V value1,
                                      K key2,
                                      V value2)

newWithKeysValues

public static <K,V> UnifiedMap<K,V> newWithKeysValues(K key1,
                                      V value1,
                                      K key2,
                                      V value2,
                                      K key3,
                                      V value3)

newWithKeysValues

public static <K,V> UnifiedMap<K,V> newWithKeysValues(K key1,
                                      V value1,
                                      K key2,
                                      V value2,
                                      K key3,
                                      V value3,
                                      K key4,
                                      V value4)

withKeysValues

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

withKeysValues

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

withKeysValues

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

withKeysValues

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

clone

public UnifiedMap<K,V> clone()

Specified by:

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

Specified by:

clone in class AbstractMutableMap<K,V>

newEmpty

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

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

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>

Specified by:

newEmpty in interface com.gs.collections.api.map.MutableMapIterable<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(java.lang.Object 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.MutableMapIterable

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.MutableMapIterable<K,V>

Overrides:

updateValue in class AbstractMutableMapIterable<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.MutableMapIterable

Same as MutableMapIterable.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.MutableMapIterable<K,V>

Overrides:

updateValueWith in class AbstractMutableMapIterable<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.MutableMapIterable

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.MutableMapIterable<K,V>

Overrides:

getIfAbsentPut in class AbstractMutableMapIterable<K,V>

getIfAbsentPut

public V getIfAbsentPut(K key,
               V value)

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

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.MutableMapIterable<K,V>

Overrides:

getIfAbsentPut in class AbstractMutableMapIterable<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.MutableMapIterable

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.MutableMapIterable<K,V>

Overrides:

getIfAbsentPutWith in class AbstractMutableMapIterable<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 iterable 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 its 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.MutableMapIterable

Remove an entry from the map at the specified key.

Specified by:

removeKey in interface com.gs.collections.api.map.MutableMapIterable<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 AbstractRichIterable<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(UnifiedMap<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 class: AbstractRichIterable

Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String.valueOf(Object).

This implementation creates an empty string buffer, appends a left square bracket, and iterates over the collection appending the string representation of each element in turn. After appending each element except the last, the string ", " is appended. Finally a right bracket is appended. A string is obtained from the string buffer, and returned.

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 AbstractRichIterable<V>

Returns:

a string representation of this collection.

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.

Example using a Java 8 lambda:

 people.forEachWithIndex((Person person, int index) -> LOGGER.info("Index: " + index + " person: " + person.getName()));
 

Example using an anonymous inner class:

 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.

Example using a Java 8 lambda:

 people.forEachWith((Person person, Person other) ->
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }, fred);
 

Example using an anonymous inner class:

 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>

collectValues

public <R> com.gs.collections.api.map.MutableMap<K,R> collectValues(com.gs.collections.api.block.function.Function2<? super K,? super V,? extends R> function)

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

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.

e.g.
 peopleByCity.collectValues(new Function2<City, Person, String>()
 {
     public String value(City city, Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

collectValues in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

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

Overrides:

collectValues in class AbstractMutableMap<K,V>

detect

public com.gs.collections.api.tuple.Pair<K,V> detect(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)

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

Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments. The predicate will only be evaluated until such pair is found or until all of the keys and values of the map have been used as arguments. That is, there may be keys and values of the map that are never used as arguments to the predicate. The result is null if predicate does not evaluate to true for any key/value combination.

e.g.
 peopleByCity.detect(new Predicate2<City, Person>()
 {
     public boolean accept(City city, Person person)
     {
         return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
     }
 });
 

Specified by:

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

Overrides:

detect in class AbstractMutableMapIterable<K,V>

detect

public V detect(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

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

Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find.

Example using a Java 8 lambda expression:

 Person person =
     people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
 

Example using an anonymous inner class:

 Person person =
     people.detect(new Predicate<Person>()
     {
         public boolean value(Person person)
         {
             return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
         }
     });
 

Specified by:

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

Overrides:

detect in class AbstractMapIterable<K,V>

detectWith

public <P> V detectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
               P parameter)

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

Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.

Example using a Java 8 lambda expression:

 Person person =
     people.detectWith((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
 

Example using an anonymous inner class:

 Person person =
     people.detectWith(new Predicate2<Person, String>()
     {
         public boolean value(Person person, String fullName)
         {
             return person.getFullName().equals(fullName);
         }
     }, "John Smith");
 

Specified by:

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

Overrides:

detectWith in class AbstractMapIterable<K,V>

detectIfNone

public V detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super V> predicate,
             com.gs.collections.api.block.function.Function0<? extends V> function)

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

Returns the first element of the iterable for which the predicate evaluates to true. If no element matches the predicate, then returns the value of applying the specified function.

Specified by:

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

Overrides:

detectIfNone in class AbstractMapIterable<K,V>

detectWithIfNone

public <P> V detectWithIfNone(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                     P parameter,
                     com.gs.collections.api.block.function.Function0<? extends V> function)

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

Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.

Specified by:

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

Overrides:

detectWithIfNone in class AbstractMapIterable<K,V>

anySatisfy

public boolean anySatisfy(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

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

Returns true if the predicate evaluates to true for any element of the iterable. Returns false if the iterable is empty, or if no element returned true when evaluating the predicate.

Specified by:

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

Overrides:

anySatisfy in class AbstractMapIterable<K,V>

anySatisfyWith

public <P> boolean anySatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                         P parameter)

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

Returns true if the predicate evaluates to true for any element of the collection, or return false. Returns false if the collection is empty.

Specified by:

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

Overrides:

anySatisfyWith in class AbstractMapIterable<K,V>

allSatisfy

public boolean allSatisfy(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

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

Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty. Otherwise, returns false.

Specified by:

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

Overrides:

allSatisfy in class AbstractMapIterable<K,V>

allSatisfyWith

public <P> boolean allSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                         P parameter)

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

Returns true if the predicate evaluates to true for every element of the collection, or returns false.

Specified by:

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

Overrides:

allSatisfyWith in class AbstractMapIterable<K,V>

noneSatisfy

public boolean noneSatisfy(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

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

Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. Otherwise, returns false.

Specified by:

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

Overrides:

noneSatisfy in class AbstractMapIterable<K,V>

noneSatisfyWith

public <P> boolean noneSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                          P parameter)

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

Returns true if the predicate evaluates to false for every element of the collection, or return false. Returns true if the collection is empty.

Specified by:

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

Overrides:

noneSatisfyWith 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.MutableMapIterable

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

Specified by:

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

Specified by:

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

Specified by:

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

Overrides:

toImmutable in class AbstractMutableMap<K,V>