com.gs.collections.api.map

Interface MutableMap<K,V>

All Superinterfaces:

java.lang.Cloneable, InternalIterable<V>, java.lang.Iterable<V>, java.util.Map<K,V>, MapIterable<K,V>, RichIterable<V>, UnsortedMapIterable<K,V>

All Known Subinterfaces:

ConcurrentMutableMap<K,V>, FixedSizeMap<K,V>, MutableBiMap<K,V>

public interface MutableMap<K,V>
extends UnsortedMapIterable<K,V>, java.util.Map<K,V>, java.lang.Cloneable

A MutableMap is similar to a JCF Map but adds additional useful internal iterator methods. The MutableMap interface additionally implements some of the methods in the Smalltalk Dictionary protocol.

Nested Class Summary

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

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

Method Summary

Methods

Modifier and Type	Method and Description
V	add(Pair<K,V> keyValuePair) This method allows mutable map the ability to add an element in the form of Pair.
<K2,V2> MutableMap<K2,V2>	aggregateBy(Function<? super V,? extends K2> groupBy, Function0<? extends V2> zeroValueFactory, 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> MutableMap<K2,V2>	aggregateInPlaceBy(Function<? super V,? extends K2> groupBy, Function0<? extends V2> zeroValueFactory, Procedure2<? super V2,? super V> mutatingAggregator) Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
MutableMap<K,V>	asSynchronized() Returns a synchronized (thread-safe) map backed by the specified map.
MutableMap<K,V>	asUnmodifiable() Returns an unmodifiable view of this map.
MutableMap<K,V>	clone()
<R> MutableCollection<R>	collect(Function<? super V,? extends R> function) Returns a new collection with the results of applying the specified function on each element of the source collection.
<K2,V2> MutableMap<K2,V2>	collect(Function2<? super K,? super V,Pair<K2,V2>> function) For each key and value of the map the function is evaluated.
MutableBooleanCollection	collectBoolean(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.
MutableByteCollection	collectByte(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.
MutableCharCollection	collectChar(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.
MutableDoubleCollection	collectDouble(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.
MutableFloatCollection	collectFloat(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.
<R> MutableCollection<R>	collectIf(Predicate<? super V> predicate, Function<? super V,? extends R> 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.
MutableIntCollection	collectInt(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> MutableMap<K,V>	collectKeysAndValues(java.lang.Iterable<E> iterable, Function<? super E,? extends K> keyFunction, Function<? super E,? extends V> valueFunction) Adds all the entries derived from collection to this.
MutableLongCollection	collectLong(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.
MutableShortCollection	collectShort(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> MutableMap<K,R>	collectValues(Function2<? super K,? super V,? extends R> function) For each key and value of the map the function is evaluated.
<R> MutableCollection<R>	flatCollect(Function<? super V,? extends java.lang.Iterable<R>> function) flatCollect is a special case of RichIterable.collect(Function).
MutableSetMultimap<V,K>	flip() Given a map from Domain -> Range return a multimap from Range -> Domain.
MutableMap<V,K>	flipUniqueValues() Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.
V	getIfAbsentPut(K key, 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, Function<? super P,? extends V> function, P parameter) Get and return the value in the Map at the specified key.
V	getIfAbsentPutWithKey(K key, Function<? super K,? extends V> function) Get and return the value in the Map at the specified key.
<VV> MutableMultimap<VV,V>	groupBy(Function<? super V,? extends VV> 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.
<VV> MutableMultimap<VV,V>	groupByEach(Function<? super V,? extends java.lang.Iterable<VV>> function) Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<V1> MutableMap<V1,V>	groupByUniqueKey(Function<? super V,? extends V1> function) For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key.
MutableMap<K,V>	newEmpty() Creates a new instance of the same type, using the default capacity and growth parameters.
PartitionMutableCollection<V>	partition(Predicate<? super V> predicate) Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
<P> PartitionMutableCollection<V>	partitionWith(Predicate2<? super V,? super P> predicate, P parameter) Filters a collection into a PartitionIterable based on the evaluation of the predicate.
MutableCollection<V>	reject(Predicate<? super V> predicate) Returns all elements of the source collection that return false when evaluating of the predicate.
MutableMap<K,V>	reject(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	removeKey(K key) Remove an entry from the map at the specified key.
MutableCollection<V>	select(Predicate<? super V> predicate) Returns all elements of the source collection that return true when evaluating the predicate.
MutableMap<K,V>	select(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> MutableCollection<S>	selectInstancesOf(java.lang.Class<S> clazz) Returns all elements of the source collection that are instances of the Class clazz.
ImmutableMap<K,V>	toImmutable() Returns an immutable copy of this map.
V	updateValue(K key, Function0<? extends V> factory, 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, Function0<? extends V> factory, Function2<? super V,? super P,? extends V> function, P parameter) Same as updateValue(Object, Function0, Function) with a Function2 and specified parameter which is passed to the function.
MutableMap<K,V>	withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs) Convenience var-args version of withAllKeyValues
MutableMap<K,V>	withAllKeyValues(java.lang.Iterable<? extends Pair<? extends K,? extends V>> keyValues) This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.
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.
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.
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> MutableCollection<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.
MutableCollection<Pair<V,java.lang.Integer>>	zipWithIndex() Zips this RichIterable with its indices.

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

containsKey, containsValue, detect, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, keysView, keyValuesView, toString, valuesView

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

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, rejectWith, select, selectWith, 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

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

newEmpty

MutableMap<K,V> newEmpty()

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

collectKeysAndValues

<E> MutableMap<K,V> collectKeysAndValues(java.lang.Iterable<E> iterable,
                                       Function<? super E,? extends K> keyFunction,
                                       Function<? super E,? extends V> valueFunction)

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.

removeKey

V removeKey(K key)

Remove an entry from the map at the specified key.

Returns:

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

See Also:

Map.remove(Object)

getIfAbsentPut

V getIfAbsentPut(K key,
               Function0<? extends V> function)

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.

getIfAbsentPut

V getIfAbsentPut(K key,
               V value)

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.

Since:

5.0

getIfAbsentPutWithKey

V getIfAbsentPutWithKey(K key,
                      Function<? super K,? extends V> function)

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.

getIfAbsentPutWith

<P> V getIfAbsentPutWith(K key,
                       Function<? super P,? extends V> function,
                       P parameter)

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.

clone

MutableMap<K,V> clone()

asUnmodifiable

MutableMap<K,V> asUnmodifiable()

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.

Returns:

an unmodifiable view of this map.

toImmutable

ImmutableMap<K,V> toImmutable()

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 UnsortedMapIterable<K,V>

asSynchronized

MutableMap<K,V> asSynchronized()

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.

flip

MutableSetMultimap<V,K> flip()

Description copied from interface: MapIterable

Given a map from Domain -> Range return a multimap from Range -> Domain. We chose the name 'flip' rather than 'invert' or 'transpose' since this method does not have the property of applying twice returns the original.

Since the keys in the input are unique, the values in the output are unique, so the return type should be a SetMultimap. However since SetMultimap and SortedSetMultimap don't inherit from one another, SetMultimap here does not allow SortedMapIterable to have a SortedSetMultimap return. Thus we compromise and call this Multimap, even though all implementations will be a SetMultimap or SortedSetMultimap.

Specified by:

flip in interface MapIterable<K,V>

Specified by:

flip in interface UnsortedMapIterable<K,V>

select

MutableMap<K,V> select(Predicate2<? super K,? super V> predicate)

Description copied from interface: 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 MapIterable<K,V>

Specified by:

select in interface UnsortedMapIterable<K,V>

collectValues

<R> MutableMap<K,R> collectValues(Function2<? super K,? super V,? extends R> function)

Description copied from interface: 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 MapIterable<K,V>

Specified by:

collectValues in interface UnsortedMapIterable<K,V>

collect

<K2,V2> MutableMap<K2,V2> collect(Function2<? super K,? super V,Pair<K2,V2>> function)

Description copied from interface: 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 MapIterable<K,V>

Specified by:

collect in interface UnsortedMapIterable<K,V>

reject

MutableMap<K,V> reject(Predicate2<? super K,? super V> predicate)

Description copied from interface: 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 MapIterable<K,V>

Specified by:

reject in interface UnsortedMapIterable<K,V>

collect

<R> MutableCollection<R> collect(Function<? super V,? extends R> function)

Description copied from interface: 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 RichIterable<V>

collectBoolean

MutableBooleanCollection collectBoolean(BooleanFunction<? super V> booleanFunction)

Description copied from interface: 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 RichIterable<V>

collectByte

MutableByteCollection collectByte(ByteFunction<? super V> byteFunction)

Description copied from interface: 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 RichIterable<V>

collectChar

MutableCharCollection collectChar(CharFunction<? super V> charFunction)

Description copied from interface: 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 RichIterable<V>

collectDouble

MutableDoubleCollection collectDouble(DoubleFunction<? super V> doubleFunction)

Description copied from interface: 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 RichIterable<V>

collectFloat

MutableFloatCollection collectFloat(FloatFunction<? super V> floatFunction)

Description copied from interface: 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 RichIterable<V>

collectInt

MutableIntCollection collectInt(IntFunction<? super V> intFunction)

Description copied from interface: 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 RichIterable<V>

collectLong

MutableLongCollection collectLong(LongFunction<? super V> longFunction)

Description copied from interface: 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 RichIterable<V>

collectShort

MutableShortCollection collectShort(ShortFunction<? super V> shortFunction)

Description copied from interface: 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 RichIterable<V>

collectIf

<R> MutableCollection<R> collectIf(Predicate<? super V> predicate,
                                 Function<? super V,? extends R> function)

Description copied from interface: 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 RichIterable<V>

flatCollect

<R> MutableCollection<R> flatCollect(Function<? super V,? extends java.lang.Iterable<R>> function)

Description copied from interface: 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 RichIterable<V>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

reject

MutableCollection<V> reject(Predicate<? super V> predicate)

Description copied from interface: 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 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

select

MutableCollection<V> select(Predicate<? super V> predicate)

Description copied from interface: 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 RichIterable<V>

partition

PartitionMutableCollection<V> partition(Predicate<? super V> predicate)

Description copied from interface: 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 RichIterable<V>

partitionWith

<P> PartitionMutableCollection<V> partitionWith(Predicate2<? super V,? super P> predicate,
                                              P parameter)

Description copied from interface: RichIterable

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

e.g.
 return people.partitionWith(new Predicate2<Person, String>()
 {
     public boolean accept(Person person, String state)
     {
         return person.getAddress().getState().getName().equals(state);
     }
 }, "New York");
 

Specified by:

partitionWith in interface RichIterable<V>

selectInstancesOf

<S> MutableCollection<S> selectInstancesOf(java.lang.Class<S> clazz)

Description copied from interface: RichIterable

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

Specified by:

selectInstancesOf in interface RichIterable<V>

zip

<S> MutableCollection<Pair<V,S>> zip(java.lang.Iterable<S> that)

Description copied from interface: 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 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

MutableCollection<Pair<V,java.lang.Integer>> zipWithIndex()

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface 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)

flipUniqueValues

MutableMap<V,K> flipUniqueValues()

Description copied from interface: MapIterable

Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.

     MapIterable map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
     MapIterable result = map.flipUniqueValues();
     Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
 

Specified by:

flipUniqueValues in interface MapIterable<K,V>

add

V add(Pair<K,V> keyValuePair)

This method allows mutable map the ability to add an element in the form of Pair.

See Also:

Map.put(Object, Object)

withKeyValue

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

See Also:

Map.put(Object, Object)

withAllKeyValues

MutableMap<K,V> withAllKeyValues(java.lang.Iterable<? extends Pair<? extends K,? extends V>> keyValues)

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.

See Also:

Map.put(Object, Object)

withAllKeyValueArguments

MutableMap<K,V> withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)

Convenience var-args version of withAllKeyValues

See Also:

withAllKeyValues(Iterable)

withoutKey

MutableMap<K,V> withoutKey(K key)

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.

See Also:

Map.remove(Object)

withoutAllKeys

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

See Also:

Map.remove(Object)

groupBy

<VV> MutableMultimap<VV,V> groupBy(Function<? super V,? extends VV> function)

Description copied from interface: 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 RichIterable<V>

groupByEach

<VV> MutableMultimap<VV,V> groupByEach(Function<? super V,? extends java.lang.Iterable<VV>> function)

Description copied from interface: 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 RichIterable<V>

groupByUniqueKey

<V1> MutableMap<V1,V> groupByUniqueKey(Function<? super V,? extends V1> function)

Description copied from interface: RichIterable

For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.

Specified by:

groupByUniqueKey in interface RichIterable<V>

See Also:

RichIterable.groupBy(Function)

aggregateInPlaceBy

<K2,V2> MutableMap<K2,V2> aggregateInPlaceBy(Function<? super V,? extends K2> groupBy,
                                           Function0<? extends V2> zeroValueFactory,
                                           Procedure2<? super V2,? super V> mutatingAggregator)

Description copied from interface: 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 RichIterable<V>

aggregateBy

<K2,V2> MutableMap<K2,V2> aggregateBy(Function<? super V,? extends K2> groupBy,
                                    Function0<? extends V2> zeroValueFactory,
                                    Function2<? super V2,? super V,? extends V2> nonMutatingAggregator)

Description copied from interface: 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. Integer.valueOf(0)).

Specified by:

aggregateBy in interface RichIterable<V>

updateValue

V updateValue(K key,
            Function0<? extends V> factory,
            Function<? super V,? extends V> function)

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.

updateValueWith

<P> V updateValueWith(K key,
                    Function0<? extends V> factory,
                    Function2<? super V,? super P,? extends V> function,
                    P parameter)

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