com.gs.collections.impl.map.mutable

Class SynchronizedMutableMap<K,V>

java.lang.Object

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

com.gs.collections.impl.map.mutable.SynchronizedMutableMap<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>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<V>, java.util.Map<K,V>

public class SynchronizedMutableMap<K,V>
extends SynchronizedMapIterable<K,V>
implements com.gs.collections.api.map.MutableMap<K,V>

A synchronized view of a MutableMap. It is imperative that the user manually synchronize on the collection when iterating over it using the standard JDK iterator or JDK 5 for loop, as per Collections.synchronizedCollection(Collection).

See Also:

MutableMap.asSynchronized(), Serialized Form

Nested Class Summary

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

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

Field Summary

Fields inherited from class com.gs.collections.impl.map.SynchronizedMapIterable

lock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SynchronizedMutableMap(com.gs.collections.api.map.MutableMap<K,V> newMap)
protected	SynchronizedMutableMap(com.gs.collections.api.map.MutableMap<K,V> newMap, java.lang.Object newLock)

Method Summary

Methods

Modifier and Type	Method and Description
<K2,V2> com.gs.collections.api.map.MutableMap<K2,V2>	aggregateBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy, com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory, com.gs.collections.api.block.function.Function2<? super V2,? super V,? extends V2> nonMutatingAggregator) Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
<K2,V2> com.gs.collections.api.map.MutableMap<K2,V2>	aggregateInPlaceBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy, com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory, com.gs.collections.api.block.procedure.Procedure2<? super V2,? super V> mutatingAggregator) Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
com.gs.collections.api.map.MutableMap<K,V>	asSynchronized() Returns a synchronized (thread-safe) map backed by the specified map.
com.gs.collections.api.map.MutableMap<K,V>	asUnmodifiable() Returns an unmodifiable view of this map.
void	clear()
com.gs.collections.api.map.MutableMap<K,V>	clone()
<A> com.gs.collections.api.collection.MutableCollection<A>	collect(com.gs.collections.api.block.function.Function<? super V,? extends A> function) Returns a new collection with the results of applying the specified function on each element of the source collection.
<K2,V2> com.gs.collections.api.map.MutableMap<K2,V2>	collect(com.gs.collections.api.block.function.Function2<? super K,? super V,com.gs.collections.api.tuple.Pair<K2,V2>> pairFunction) For each key and value of the map the function is evaluated.
com.gs.collections.api.collection.primitive.MutableBooleanCollection	collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super V> booleanFunction) Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.collection.primitive.MutableByteCollection	collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super V> byteFunction) Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.collection.primitive.MutableCharCollection	collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super V> charFunction) Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.collection.primitive.MutableDoubleCollection	collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super V> doubleFunction) Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.collection.primitive.MutableFloatCollection	collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super V> floatFunction) Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection.
<A> com.gs.collections.api.collection.MutableCollection<A>	collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate, com.gs.collections.api.block.function.Function<? super V,? extends A> function) Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.
com.gs.collections.api.collection.primitive.MutableIntCollection	collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super V> intFunction) Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection.
<E> com.gs.collections.api.map.MutableMap<K,V>	collectKeysAndValues(java.util.Collection<E> collection, com.gs.collections.api.block.function.Function<? super E,? extends K> keyFunction, com.gs.collections.api.block.function.Function<? super E,? extends V> function) Adds all the entries derived from collection to this.
com.gs.collections.api.collection.primitive.MutableLongCollection	collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super V> longFunction) Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection.
com.gs.collections.api.collection.primitive.MutableShortCollection	collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super V> shortFunction) Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection.
<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.
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
boolean	equals(java.lang.Object o) Follows the same general contract as Map.equals(Object).
<A> com.gs.collections.api.collection.MutableCollection<A>	flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<A>> function) flatCollect is a special case of RichIterable.collect(Function).
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.
<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.
V	getIfAbsentPutWithKey(K key, com.gs.collections.api.block.function.Function<? super K,? extends V> function) Get and return the value in the Map at the specified key.
com.gs.collections.api.map.MutableMap<K,V>	getMutableMap()
<KK> com.gs.collections.api.multimap.MutableMultimap<KK,V>	groupBy(com.gs.collections.api.block.function.Function<? super V,? extends KK> function) For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
<KK> com.gs.collections.api.multimap.MutableMultimap<KK,V>	groupByEach(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<KK>> function) Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
int	hashCode() Follows the same general contract as Map.hashCode().
java.util.Set<K>	keySet()
com.gs.collections.api.RichIterable<K>	keysView() Returns an unmodifiable lazy iterable wrapped around the keySet for the map
com.gs.collections.api.RichIterable<com.gs.collections.api.tuple.Pair<K,V>>	keyValuesView() Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map
com.gs.collections.api.map.MutableMap<K,V>	newEmpty() Creates a new instance of the same type, using the default capacity and growth parameters.
static <K,V,M extends java.util.Map<K,V>> SynchronizedMutableMap<K,V>	of(M map) This method will take a MutableMap and wrap it directly in a SynchronizedMutableMap.
com.gs.collections.api.partition.PartitionMutableCollection<V>	partition(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
V	put(K key, V value)
void	putAll(java.util.Map<? extends K,? extends V> map)
com.gs.collections.api.collection.MutableCollection<V>	reject(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns all elements of the source collection that return false when evaluating of the predicate.
com.gs.collections.api.map.MutableMap<K,V>	reject(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate) For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.
V	remove(java.lang.Object key)
V	removeKey(K key) Remove an entry from the map at the specified key.
com.gs.collections.api.collection.MutableCollection<V>	select(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns all elements of the source collection that return true when evaluating the predicate.
com.gs.collections.api.map.MutableMap<K,V>	select(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate) For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.
<S> com.gs.collections.api.collection.MutableCollection<S>	selectInstancesOf(java.lang.Class<S> clazz) Returns all elements of the source collection that are instances of the Class clazz.
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()
com.gs.collections.api.RichIterable<V>	valuesView() Returns an unmodifiable lazy iterable wrapped around the values for the map
com.gs.collections.api.map.MutableMap<K,V>	withAllKeyValueArguments(com.gs.collections.api.tuple.Pair<? extends K,? extends V>... keyValuePairs) Convenience var-args version of withAllKeyValues
com.gs.collections.api.map.MutableMap<K,V>	withAllKeyValues(java.lang.Iterable<? extends com.gs.collections.api.tuple.Pair<? extends K,? extends V>> keyValues) This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.
com.gs.collections.api.map.MutableMap<K,V>	withKeyValue(K key, V value) This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.
com.gs.collections.api.map.MutableMap<K,V>	withoutAllKeys(java.lang.Iterable<? extends K> keys) This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.
com.gs.collections.api.map.MutableMap<K,V>	withoutKey(K key) This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.
<S> com.gs.collections.api.collection.MutableCollection<com.gs.collections.api.tuple.Pair<V,S>>	zip(java.lang.Iterable<S> that) Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs.
com.gs.collections.api.collection.MutableCollection<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>>	zipWithIndex() Zips this RichIterable with its indices.

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

allSatisfy, anySatisfy, appendString, appendString, appendString, asLazy, chunk, collect, collectIf, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsKey, containsValue, count, detect, detect, detectIfNone, flatCollect, forEach, forEachKey, forEachKeyValue, forEachValue, forEachWith, forEachWithIndex, get, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, getMap, groupBy, groupByEach, ifPresentApply, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, iterator, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, notEmpty, reject, rejectWith, select, selectWith, size, 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.api.map.MapIterable

containsKey, containsValue, detect, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, ifPresentApply

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

allSatisfy, anySatisfy, appendString, appendString, appendString, asLazy, chunk, collect, collectIf, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, detect, detectIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, notEmpty, reject, rejectWith, select, selectWith, size, 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, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface java.util.Map

containsKey, containsValue, get, isEmpty, size

Constructor Detail

SynchronizedMutableMap

protected SynchronizedMutableMap(com.gs.collections.api.map.MutableMap<K,V> newMap)

SynchronizedMutableMap

protected SynchronizedMutableMap(com.gs.collections.api.map.MutableMap<K,V> newMap,
                      java.lang.Object newLock)

Method Detail

of

public static <K,V,M extends java.util.Map<K,V>> SynchronizedMutableMap<K,V> of(M map)

This method will take a MutableMap and wrap it directly in a SynchronizedMutableMap. It will take any other non-GS-map and first adapt it will a MapAdapter, and then return a SynchronizedMutableMap that wraps the adapter.

getMutableMap

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

select

public com.gs.collections.api.map.MutableMap<K,V> select(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)

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

For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.

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

Specified by:

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

Specified by:

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

Specified by:

select in interface com.gs.collections.api.map.UnsortedMapIterable<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.UnsortedMapIterable<K,V>

collect

public <K2,V2> com.gs.collections.api.map.MutableMap<K2,V2> collect(com.gs.collections.api.block.function.Function2<? super K,? super V,com.gs.collections.api.tuple.Pair<K2,V2>> pairFunction)

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.collect(new Function2<City, Person, String>()
 {
     public String value(City city, Person person)
     {
         return Pair.of(city.getCountry(), person.getAddress().getCity());
     }
 });
 

Specified by:

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

Specified by:

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

Specified by:

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

reject

public com.gs.collections.api.map.MutableMap<K,V> reject(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)

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

For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.

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

Specified by:

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

Specified by:

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

Specified by:

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

select

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

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

Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.

e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.getAddress().getCity().equals("Metuchen");
     }
 });
 

Specified by:

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

Specified by:

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

reject

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

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

Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).

e.g.
 return people.reject(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 });
 

e.g.
 return people.reject(Predicates.attributeEqual("lastName", "Smith"));
 

Specified by:

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

Specified by:

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

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false

partition

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

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

Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

e.g.
 return people.partition(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.getAddress().getState().getName().equals("New York");
     }
 });
 

Specified by:

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

Specified by:

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

selectInstancesOf

public <S> com.gs.collections.api.collection.MutableCollection<S> selectInstancesOf(java.lang.Class<S> clazz)

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

Returns all elements of the source collection that are instances of the Class clazz.

Specified by:

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

Specified by:

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

zip

public <S> com.gs.collections.api.collection.MutableCollection<com.gs.collections.api.tuple.Pair<V,S>> zip(java.lang.Iterable<S> that)

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

Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.

Specified by:

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

Specified by:

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

Type Parameters:

S - the type of the second half of the returned pairs

Parameters:

that - The RichIterable providing the second half of each result pair

Returns:

A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.

zipWithIndex

public com.gs.collections.api.collection.MutableCollection<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>> zipWithIndex()

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

Zips this RichIterable with its indices.

Specified by:

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

Specified by:

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

Returns:

A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.

See Also:

RichIterable.zip(Iterable)

flatCollect

public <A> com.gs.collections.api.collection.MutableCollection<A> flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<A>> function)

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

flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:

 Function<Person, List<Address>> addressFunction = new Function<Person, List<Address>>() {
     public List<Address> valueOf(Person person) {
         return person.getAddresses();
     }
 };
 MutableList<Person> people = ...;
 

Using collect returns a collection of collections of addresses.

 MutableList<List<Address>> addresses = people.collect(addressFunction);
 

Using flatCollect returns a single flattened list of addresses.

 MutableList<Address> addresses = people.flatCollect(addressFunction);
 

Specified by:

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

Specified by:

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

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

collectIf

public <A> com.gs.collections.api.collection.MutableCollection<A> collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate,
                                                                   com.gs.collections.api.block.function.Function<? super V,? extends A> function)

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

Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the the optimized equivalent of calling iterable.select(predicate).collect(function).

e.g.
 Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
 

Specified by:

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

Specified by:

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

collect

public <A> com.gs.collections.api.collection.MutableCollection<A> collect(com.gs.collections.api.block.function.Function<? super V,? extends A> function)

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

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collect(new Function<Person, String>()
 {
     public String valueOf(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 

Specified by:

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

Specified by:

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

collectBoolean

public com.gs.collections.api.collection.primitive.MutableBooleanCollection collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super V> booleanFunction)

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

Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectBoolean(new BooleanFunction<Person>()
 {
     public boolean booleanValueOf(Person person)
     {
         return person.hasDrivingLicense();
     }
 });
 

Specified by:

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

Specified by:

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

Overrides:

collectBoolean in class SynchronizedMapIterable<K,V>

collectByte

public com.gs.collections.api.collection.primitive.MutableByteCollection collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super V> byteFunction)

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

Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectByte(new ByteFunction<Person>()
 {
     public byte byteValueOf(Person person)
     {
         return person.getCode();
     }
 });
 

Specified by:

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

Specified by:

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

Overrides:

collectByte in class SynchronizedMapIterable<K,V>

collectChar

public com.gs.collections.api.collection.primitive.MutableCharCollection collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super V> charFunction)

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

Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectChar(new CharFunction<Person>()
 {
     public char charValueOf(Person person)
     {
         return person.getMiddleInitial();
     }
 });
 

Specified by:

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

Specified by:

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

Overrides:

collectChar in class SynchronizedMapIterable<K,V>

collectDouble

public com.gs.collections.api.collection.primitive.MutableDoubleCollection collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super V> doubleFunction)

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

Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectDouble(new DoubleFunction<Person>()
 {
     public double doubleValueOf(Person person)
     {
         return person.getMilesFromNorthPole();
     }
 });
 

Specified by:

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

Specified by:

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

Overrides:

collectDouble in class SynchronizedMapIterable<K,V>

collectFloat

public com.gs.collections.api.collection.primitive.MutableFloatCollection collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super V> floatFunction)

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

Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectFloat(new FloatFunction<Person>()
 {
     public float floatValueOf(Person person)
     {
         return person.getHeightInInches();
     }
 });
 

Specified by:

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

Specified by:

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

Overrides:

collectFloat in class SynchronizedMapIterable<K,V>

collectInt

public com.gs.collections.api.collection.primitive.MutableIntCollection collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super V> intFunction)

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

Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectInt(new IntFunction<Person>()
 {
     public int intValueOf(Person person)
     {
         return person.getAge();
     }
 });
 

Specified by:

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

Specified by:

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

Overrides:

collectInt in class SynchronizedMapIterable<K,V>

collectLong

public com.gs.collections.api.collection.primitive.MutableLongCollection collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super V> longFunction)

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

Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectLong(new LongFunction<Person>()
 {
     public long longValueOf(Person person)
     {
         return person.getGuid();
     }
 });
 

Specified by:

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

Specified by:

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

Overrides:

collectLong in class SynchronizedMapIterable<K,V>

collectShort

public com.gs.collections.api.collection.primitive.MutableShortCollection collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super V> shortFunction)

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

Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

e.g.
 return people.collectShort(new ShortFunction<Person>()
 {
     public short shortValueOf(Person person)
     {
         return person.getNumberOfJunkMailItemsReceivedPerMonth();
     }
 });
 

Specified by:

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

Specified by:

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

Overrides:

collectShort in class SynchronizedMapIterable<K,V>

groupBy

public <KK> com.gs.collections.api.multimap.MutableMultimap<KK,V> groupBy(com.gs.collections.api.block.function.Function<? super V,? extends KK> function)

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

For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.

e.g.
 return people.groupBy(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 

Specified by:

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

Specified by:

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

groupByEach

public <KK> com.gs.collections.api.multimap.MutableMultimap<KK,V> groupByEach(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<KK>> function)

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

Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Specified by:

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

Specified by:

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

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>

collectKeysAndValues

public <E> com.gs.collections.api.map.MutableMap<K,V> collectKeysAndValues(java.util.Collection<E> collection,
                                                                  com.gs.collections.api.block.function.Function<? super E,? extends K> keyFunction,
                                                                  com.gs.collections.api.block.function.Function<? super E,? extends V> function)

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)

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>

getIfAbsentPutWithKey

public V getIfAbsentPutWithKey(K key,
                      com.gs.collections.api.block.function.Function<? super K,? 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 for that key return the result of evaluating the specified Function using the specified key, and put that value in the map at the specified key.

Specified by:

getIfAbsentPutWithKey in interface com.gs.collections.api.map.MutableMap<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>

clone

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

Specified by:

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

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

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

asUnmodifiable

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

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

Returns an unmodifiable view of this map. This method allows modules to provide users with "read-only" access to internal maps. Any query operations on the returned map that "read through" to this map and attempt to modify the returned map, whether direct or via its iterator, result in an UnsupportedOperationException. The returned map will be Serializable if this map is Serializable.

Specified by:

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

Returns:

an unmodifiable view of this map.

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>

asSynchronized

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

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

Returns a synchronized (thread-safe) map backed by the specified map. In order to guarantee serial access, it is critical that all access to the backing map is accomplished through the returned map.

It is imperative that the user manually synchronize on the returned map when iterating over any of its collection views:

  MutableMap map = myMutableMap.asSynchronized();
      ...
  Set set = map.keySet();  // Needn't be in synchronized block
      ...
  synchronized(map)
  {  // Synchronizing on map, not set!
      Iterator i = s.iterator(); // Must be in synchronized block
      while (i.hasNext())
          foo(i.next());
  }
 

Failure to follow this advice may result in non-deterministic behavior.

The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is properly synchronized internally.

  MutableMap map = myMutableMap.asSynchronized();
      ...
  Set set = map.keySet();  // Needn't be in synchronized block
     ...
  Iterate.forEach(set, new Procedure()
  {
      public void value(Object each)
      {
          ...
      }
  });
 

The returned map will be serializable if the specified map is serializable.

Specified by:

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

keyValuesView

public com.gs.collections.api.RichIterable<com.gs.collections.api.tuple.Pair<K,V>> keyValuesView()

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

Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map

Specified by:

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

keysView

public com.gs.collections.api.RichIterable<K> keysView()

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

Returns an unmodifiable lazy iterable wrapped around the keySet for the map

Specified by:

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

Specified by:

keysView in class SynchronizedMapIterable<K,V>

valuesView

public com.gs.collections.api.RichIterable<V> valuesView()

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

Returns an unmodifiable lazy iterable wrapped around the values for the map

Specified by:

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

Specified by:

valuesView in class SynchronizedMapIterable<K,V>

put

public V put(K key,
    V value)

Specified by:

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

remove

public V remove(java.lang.Object key)

Specified by:

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

putAll

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

Specified by:

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

clear

public void clear()

Specified by:

clear 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>

entrySet

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

Specified by:

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

withKeyValue

public com.gs.collections.api.map.MutableMap<K,V> withKeyValue(K key,
                                                      V value)

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

This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus the additional key and value. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:

 map = map.withKeyValue("new key", "new value");
 

In the case of FixedSizeMap, a new instance will be returned by withKeyValue, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.

Specified by:

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

See Also:

Map.put(Object, Object)

withAllKeyValueArguments

public com.gs.collections.api.map.MutableMap<K,V> withAllKeyValueArguments(com.gs.collections.api.tuple.Pair<? extends K,? extends V>... keyValuePairs)

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

Convenience var-args version of withAllKeyValues

Specified by:

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

See Also:

MutableMap.withAllKeyValues(Iterable)

withAllKeyValues

public com.gs.collections.api.map.MutableMap<K,V> withAllKeyValues(java.lang.Iterable<? extends com.gs.collections.api.tuple.Pair<? extends K,? extends V>> keyValues)

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

This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus all of the additional keys and values. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:

 map = map.withAllKeyValues(FastList.newListWith(PairImpl.of("new key", "new value")));
 

In the case of FixedSizeMap, a new instance will be returned by withAllKeyValues, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.

Specified by:

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

See Also:

Map.put(Object, Object)

withoutKey

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

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

This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus the key and value to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:

 map = map.withoutKey("key");
 

In the case of FixedSizeMap, a new instance will be returned by withoutKey, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.

Specified by:

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

See Also:

Map.remove(Object)

withoutAllKeys

public com.gs.collections.api.map.MutableMap<K,V> withoutAllKeys(java.lang.Iterable<? extends K> keys)

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

This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus all of the keys and values to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:

 map = map.withoutAllKeys(FastList.newListWith("key1", "key2"));
 

In the case of FixedSizeMap, a new instance will be returned by withoutAllKeys, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.

Specified by:

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

See Also:

Map.remove(Object)

aggregateInPlaceBy

public <K2,V2> com.gs.collections.api.map.MutableMap<K2,V2> aggregateInPlaceBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy,
                                                                      com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory,
                                                                      com.gs.collections.api.block.procedure.Procedure2<? super V2,? super V> mutatingAggregator)

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

Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).

Specified by:

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

Specified by:

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

aggregateBy

public <K2,V2> com.gs.collections.api.map.MutableMap<K2,V2> aggregateBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy,
                                                               com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory,
                                                               com.gs.collections.api.block.function.Function2<? super V2,? super V,? extends V2> nonMutatingAggregator)

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

Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with (i.e. new Integer(0)).

Specified by:

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

Specified by:

aggregateBy in interface com.gs.collections.api.RichIterable<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>

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>