SynchronizedMapIterable (Goldman Sachs Collections

java.lang.Object
- com.gs.collections.impl.map.SynchronizedMapIterable<K,V>

All Implemented Interfaces:

com.gs.collections.api.InternalIterable<V>, com.gs.collections.api.map.MapIterable<K,V>, com.gs.collections.api.RichIterable<V>, java.io.Serializable, java.lang.Iterable<V>

Direct Known Subclasses:

SynchronizedMutableMap, SynchronizedSortedMap
```
public abstract class SynchronizedMapIterable<K,V>
extends java.lang.Object
implements com.gs.collections.api.map.MapIterable<K,V>, java.io.Serializable
```
A synchronized view of a map.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.Object lock

Fields
Modifier and Type	Field and Description
`protected java.lang.Object`	`lock`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SynchronizedMapIterable(com.gs.collections.api.map.MapIterable<K,V> newMap)`
`protected`	`SynchronizedMapIterable(com.gs.collections.api.map.MapIterable<K,V> newMap, java.lang.Object newLock)`

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`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.
`void`	`appendString(java.lang.Appendable appendable)` Prints a string representation of this collection onto the given `Appendable`.
`void`	`appendString(java.lang.Appendable appendable, java.lang.String separator)` Prints a string representation of this collection onto the given `Appendable`.
`void`	`appendString(java.lang.Appendable appendable, java.lang.String start, java.lang.String separator, java.lang.String end)` Prints a string representation of this collection onto the given `Appendable`.
`com.gs.collections.api.LazyIterable<V>`	`asLazy()` Returns a deferred iterable, most likely implemented by calling LazyIterate.defer(this).
`com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<V>>`	`chunk(int size)` Partitions elements in fixed size chunks.
`<A,R extends java.util.Collection<A>> R`	`collect(com.gs.collections.api.block.function.Function<? super V,? extends A> function, R target)` Same as `RichIterable.collect(Function)`, except that the results are gathered into the specified `target` collection.
`com.gs.collections.api.BooleanIterable`	`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.ByteIterable`	`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.CharIterable`	`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.DoubleIterable`	`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.FloatIterable`	`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,R extends java.util.Collection<A>> R`	`collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate, com.gs.collections.api.block.function.Function<? super V,? extends A> function, R target)` Same as the collectIf method with two parameters but uses the specified target collection for the results.
`com.gs.collections.api.IntIterable`	`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.
`com.gs.collections.api.LongIterable`	`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.ShortIterable`	`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.
`<P,A,R extends java.util.Collection<A>> R`	`collectWith(com.gs.collections.api.block.function.Function2<? super V,? super P,? extends A> function, P parameter, R targetCollection)` Same as collectWith but with a targetCollection parameter to gather the results.
`boolean`	`contains(java.lang.Object object)` Returns true if the iterable has an element which responds true to element.equals(object).
`boolean`	`containsAll(java.util.Collection<?> source)`
`boolean`	`containsAllArguments(java.lang.Object... elements)` Returns true if all elements in the specified var arg array are contained in this collection.
`boolean`	`containsAllIterable(java.lang.Iterable<?> source)` Returns true if all elements in source are contained in this collection.
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`int`	`count(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)` Return the total number of elements that answer true to the specified predicate.
`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.
`<A,R extends java.util.Collection<A>> R`	`flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<A>> function, R target)` Same as flatCollect, only the results are collected into the target collection.
`void`	`forEach(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)` The procedure is executed for each element in the iterable.
`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> procedure2)` 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> procedure2, 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)`
`V`	`getFirst()` Returns the first element of an iterable.
`V`	`getIfAbsent(K key, com.gs.collections.api.block.function.Function0<? extends V> function)` Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified Function0.
`V`	`getIfAbsentValue(K key, V value)` Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return `value`.
`<P> V`	`getIfAbsentWith(K key, com.gs.collections.api.block.function.Function<? super P,? extends V> function, P parameter)` Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified function and parameter.
`V`	`getLast()` Returns the last element of an iterable.
`protected com.gs.collections.api.map.MapIterable<K,V>`	`getMap()`
`<KK,R extends com.gs.collections.api.multimap.MutableMultimap<KK,V>> R`	`groupBy(com.gs.collections.api.block.function.Function<? super V,? extends KK> function, R target)` Same as `RichIterable.groupBy(Function)`, except that the results are gathered into the specified `target` multimap.
`<KK,R extends com.gs.collections.api.multimap.MutableMultimap<KK,V>> R`	`groupByEach(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<KK>> function, R target)` Same as `RichIterable.groupByEach(Function)`, except that the results are gathered into the specified `target` multimap.
`<A> A`	`ifPresentApply(K key, com.gs.collections.api.block.function.Function<? super V,? extends A> function)` If there is a value in the Map that corresponds to the specified key return the result of applying the specified Function on the value, otherwise return null.
`double`	`injectInto(double injectedValue, com.gs.collections.api.block.function.primitive.DoubleObjectToDoubleFunction<? super V> function)` Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`float`	`injectInto(float injectedValue, com.gs.collections.api.block.function.primitive.FloatObjectToFloatFunction<? super V> function)` Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`int`	`injectInto(int injectedValue, com.gs.collections.api.block.function.primitive.IntObjectToIntFunction<? super V> function)` Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`<IV> IV`	`injectInto(IV injectedValue, com.gs.collections.api.block.function.Function2<? super IV,? super V,? extends IV> function)` Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`long`	`injectInto(long injectedValue, com.gs.collections.api.block.function.primitive.LongObjectToLongFunction<? super V> function)` Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`boolean`	`isEmpty()` Returns true if this iterable has zero items.
`java.util.Iterator<V>`	`iterator()`
`abstract com.gs.collections.api.RichIterable<K>`	`keysView()` Returns an unmodifiable lazy iterable wrapped around the keySet for the map
`java.lang.String`	`makeString()` Returns a string representation of this collection by delegating to `RichIterable.makeString(String)` and defaulting the separator parameter to the characters `", "` (comma and space).
`java.lang.String`	`makeString(java.lang.String separator)` Returns a string representation of this collection by delegating to `RichIterable.makeString(String, String, String)` and defaulting the start and end parameters to `""` (the empty String).
`java.lang.String`	`makeString(java.lang.String start, java.lang.String separator, java.lang.String end)` Returns a string representation of this collection.
`V`	`max()` Returns the maximum element out of this container based on the natural order.
`V`	`max(java.util.Comparator<? super V> comparator)` Returns the maximum element out of this container based on the comparator.
`<A extends java.lang.Comparable<? super A>> V`	`maxBy(com.gs.collections.api.block.function.Function<? super V,? extends A> function)` Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
`V`	`min()` Returns the minimum element out of this container based on the natural order.
`V`	`min(java.util.Comparator<? super V> comparator)` Returns the minimum element out of this container based on the comparator.
`<A extends java.lang.Comparable<? super A>> V`	`minBy(com.gs.collections.api.block.function.Function<? super V,? extends A> function)` Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
`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.
`boolean`	`notEmpty()` The English equivalent of !this.isEmpty()
`<R extends java.util.Collection<V>> R`	`reject(com.gs.collections.api.block.predicate.Predicate<? super V> predicate, R target)` Same as the reject method with one parameter but uses the specified target collection for the results.
`<P,R extends java.util.Collection<V>> R`	`rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter, R targetCollection)` Similar to `RichIterable.reject(Predicate, Collection)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`<R extends java.util.Collection<V>> R`	`select(com.gs.collections.api.block.predicate.Predicate<? super V> predicate, R target)` Same as the select method with one parameter but uses the specified target collection for the results.
`<P,R extends java.util.Collection<V>> R`	`selectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter, R targetCollection)` Similar to `RichIterable.select(Predicate, Collection)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`int`	`size()` Returns the number of items in this iterable.
`double`	`sumOfDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super V> function)` Returns the final double result of evaluating function for each element of the iterable and adding the results together.
`double`	`sumOfFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super V> function)` Returns the final double result of evaluating function for each element of the iterable and adding the results together.
`long`	`sumOfInt(com.gs.collections.api.block.function.primitive.IntFunction<? super V> function)` Returns the final long result of evaluating function for each element of the iterable and adding the results together.
`long`	`sumOfLong(com.gs.collections.api.block.function.primitive.LongFunction<? super V> function)` Returns the final long result of evaluating function for each element of the iterable and adding the results together.
`java.lang.Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`
`com.gs.collections.api.bag.MutableBag<V>`	`toBag()` Converts the collection to the default MutableBag implementation.
`com.gs.collections.api.list.MutableList<V>`	`toList()` Converts the collection to a MutableList implementation.
`<NK,NV> com.gs.collections.api.map.MutableMap<NK,NV>`	`toMap(com.gs.collections.api.block.function.Function<? super V,? extends NK> keyFunction, com.gs.collections.api.block.function.Function<? super V,? extends NV> valueFunction)` Converts the collection to a MutableMap implementation using the specified key and value functions.
`com.gs.collections.api.set.MutableSet<V>`	`toSet()` Converts the collection to a MutableSet implementation.
`com.gs.collections.api.list.MutableList<V>`	`toSortedList()` Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
`com.gs.collections.api.list.MutableList<V>`	`toSortedList(java.util.Comparator<? super V> comparator)` Converts the collection to a MutableList implementation and sorts it using the specified comparator.
`<A extends java.lang.Comparable<? super A>> com.gs.collections.api.list.MutableList<V>`	`toSortedListBy(com.gs.collections.api.block.function.Function<? super V,? extends A> function)` Converts the collection to a MutableList implementation and sorts it based on the natural order of the attribute returned by `function`.
`<NK,NV> com.gs.collections.api.map.sorted.MutableSortedMap<NK,NV>`	`toSortedMap(java.util.Comparator<? super NK> comparator, com.gs.collections.api.block.function.Function<? super V,? extends NK> keyFunction, com.gs.collections.api.block.function.Function<? super V,? extends NV> valueFunction)` Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator.
`<NK,NV> com.gs.collections.api.map.sorted.MutableSortedMap<NK,NV>`	`toSortedMap(com.gs.collections.api.block.function.Function<? super V,? extends NK> keyFunction, com.gs.collections.api.block.function.Function<? super V,? extends NV> valueFunction)` Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.
`com.gs.collections.api.set.sorted.MutableSortedSet<V>`	`toSortedSet()` Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.
`com.gs.collections.api.set.sorted.MutableSortedSet<V>`	`toSortedSet(java.util.Comparator<? super V> comparator)` Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.
`<A extends java.lang.Comparable<? super A>> com.gs.collections.api.set.sorted.MutableSortedSet<V>`	`toSortedSetBy(com.gs.collections.api.block.function.Function<? super V,? extends A> function)` Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the attribute returned by `function`.
`abstract com.gs.collections.api.RichIterable<V>`	`valuesView()` Returns an unmodifiable lazy iterable wrapped around the values for the map
`<S,R extends java.util.Collection<com.gs.collections.api.tuple.Pair<V,S>>> R`	`zip(java.lang.Iterable<S> that, R target)` Same as `RichIterable.zip(Iterable)` but uses `target` for output.
`<R extends java.util.Collection<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>>> R`	`zipWithIndex(R target)` Same as `RichIterable.zipWithIndex()` but uses `target` for output.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.gs.collections.api.map.MapIterable
collect, collectValues, equals, hashCode, keyValuesView, reject, select, toString

Methods inherited from interface com.gs.collections.api.RichIterable
aggregateBy, aggregateInPlaceBy, collect, collectIf, flatCollect, groupBy, groupByEach, partition, reject, select, selectInstancesOf, zip, zipWithIndex

- Field Detail
  - lock
```
protected final java.lang.Object lock
```
- Constructor Detail
  - SynchronizedMapIterable
```
protected SynchronizedMapIterable(com.gs.collections.api.map.MapIterable<K,V> newMap)
```
  - SynchronizedMapIterable
```
protected SynchronizedMapIterable(com.gs.collections.api.map.MapIterable<K,V> newMap,
                       java.lang.Object newLock)
```
- Method Detail
  - getMap
```
protected com.gs.collections.api.map.MapIterable<K,V> getMap()
```
  - get
```
public V get(java.lang.Object key)
```
    Specified by:
    
    get in interface com.gs.collections.api.map.MapIterable<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>
    
    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>
    
    See Also:
    Map.containsValue(Object)
  - 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>
  - 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>
  - forEachKeyValue
```
public void forEachKeyValue(com.gs.collections.api.block.procedure.Procedure2<? super K,? super V> procedure2)
```
    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>
  - getIfAbsent
```
public V getIfAbsent(K key,
            com.gs.collections.api.block.function.Function0<? extends V> function)
```
    Description copied from interface: com.gs.collections.api.map.MapIterable
    
    Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified Function0.
    
    Specified by:
    
    getIfAbsent in interface com.gs.collections.api.map.MapIterable<K,V>
  - getIfAbsentValue
```
public V getIfAbsentValue(K key,
                 V value)
```
    Description copied from interface: com.gs.collections.api.map.MapIterable
    
    Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return value.
    
    Specified by:
    
    getIfAbsentValue in interface com.gs.collections.api.map.MapIterable<K,V>
  - getIfAbsentWith
```
public <P> V getIfAbsentWith(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.MapIterable
    
    Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified function and parameter.
    
    Specified by:
    
    getIfAbsentWith in interface com.gs.collections.api.map.MapIterable<K,V>
  - ifPresentApply
```
public <A> A ifPresentApply(K key,
                   com.gs.collections.api.block.function.Function<? super V,? extends A> function)
```
    Description copied from interface: com.gs.collections.api.map.MapIterable
    
    If there is a value in the Map that corresponds to the specified key return the result of applying the specified Function on the value, otherwise return null.
    
    Specified by:
    
    ifPresentApply in interface com.gs.collections.api.map.MapIterable<K,V>
  - keysView
```
public abstract 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>
  - valuesView
```
public abstract 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>
  - 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>
  - 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>
  - 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>
  - notEmpty
```
public boolean notEmpty()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    The English equivalent of !this.isEmpty()
    
    Specified by:
    
    notEmpty in interface com.gs.collections.api.RichIterable<V>
  - getFirst
```
public V getFirst()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the first element of an iterable. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.
    The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.
    
    Specified by:
    
    getFirst in interface com.gs.collections.api.RichIterable<V>
  - getLast
```
public V getLast()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the last element of an iterable. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.
    The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.
    
    Specified by:
    
    getLast in interface com.gs.collections.api.RichIterable<V>
  - contains
```
public boolean contains(java.lang.Object object)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns true if the iterable has an element which responds true to element.equals(object).
    
    Specified by:
    
    contains in interface com.gs.collections.api.RichIterable<V>
  - containsAllIterable
```
public boolean containsAllIterable(java.lang.Iterable<?> source)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns true if all elements in source are contained in this collection.
    
    Specified by:
    
    containsAllIterable in interface com.gs.collections.api.RichIterable<V>
  - containsAll
```
public boolean containsAll(java.util.Collection<?> source)
```
    Specified by:
    
    containsAll in interface com.gs.collections.api.RichIterable<V>
    
    See Also:
    Collection.containsAll(Collection)
  - containsAllArguments
```
public boolean containsAllArguments(java.lang.Object... elements)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns true if all elements in the specified var arg array are contained in this collection.
    
    Specified by:
    
    containsAllArguments in interface com.gs.collections.api.RichIterable<V>
  - select
```
public <R extends java.util.Collection<V>> R select(com.gs.collections.api.block.predicate.Predicate<? super V> predicate,
                                           R target)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    Same as the select method with one parameter but uses the specified target collection for the results.
```
e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 }, Lists.mutable.of());
 
```
```
e.g.
 return collection.select(Predicates.attributeEqual("lastName", "Smith"), new ArrayList());
 
```
    Specified by:
    
    select in interface com.gs.collections.api.RichIterable<V>
    
    Parameters:
    predicate - a Predicate to use as the select criteria
    target - the Collection to append to for all elements in this RichIterable that meet select criteria predicate
    
    Returns:
    target, which contains appended elements as a result of the select criteria
    See Also:
    RichIterable.select(Predicate)
  - selectWith
```
public <P,R extends java.util.Collection<V>> R selectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                                                 P parameter,
                                                 R targetCollection)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
    
    Specified by:
    
    selectWith in interface com.gs.collections.api.RichIterable<V>
    
    Parameters:
    predicate - a Predicate2 to use as the select criteria
    parameter - a parameter to pass in for evaluation of the second argument P in predicate
    targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria predicate
    
    Returns:
    targetCollection, which contains appended elements as a result of the select criteria
    See Also:
    RichIterable.select(Predicate), RichIterable.select(Predicate, Collection)
  - reject
```
public <R extends java.util.Collection<V>> R reject(com.gs.collections.api.block.predicate.Predicate<? super V> predicate,
                                           R target)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    Same as the reject method with one parameter but uses the specified target collection for the results.
```
e.g.
 return people.reject(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 }, Lists.mutable.of());
 
```
    Specified by:
    
    reject in interface com.gs.collections.api.RichIterable<V>
    
    Parameters:
    predicate - a Predicate to use as the reject criteria
    target - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false
    
    Returns:
    target, which contains appended elements as a result of the reject criteria
  - rejectWith
```
public <P,R extends java.util.Collection<V>> R rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                                                 P parameter,
                                                 R targetCollection)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    Similar to RichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
    E.g. return a Collection of Person elements where the person has a height greater than 100cm
```
 return people.reject(new Predicate2<Person, Integer>()
 {
     public boolean accept(Person p, Integer i)
     {
         return p.getHeightInCm() < i.intValue();
     }
 }, Integer.valueOf(100), FastList.newList());
 
```
    Specified by:
    
    rejectWith in interface com.gs.collections.api.RichIterable<V>
    
    Parameters:
    predicate - a Predicate2 to use as the reject criteria
    parameter - a parameter to pass in for evaluation of the second argument P in predicate
    targetCollection - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false
    
    Returns:
    targetCollection, which contains appended elements as a result of the reject criteria
    See Also:
    RichIterable.reject(Predicate), RichIterable.reject(Predicate, Collection)
  - 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.
```
e.g.
 return 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>
  - 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>
  - count
```
public int count(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    Return the total number of elements that answer true to the specified predicate.
```
e.g.
 return people.count(new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.getAddress().getState().getName().equals("New York");
     }
 });
 
```
    Specified by:
    
    count in interface com.gs.collections.api.RichIterable<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>
  - 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>
  - 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>
  - injectInto
```
public <IV> IV injectInto(IV injectedValue,
                 com.gs.collections.api.block.function.Function2<? super IV,? super V,? extends IV> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. This method is commonly called fold or sometimes reduce.
    
    Specified by:
    
    injectInto in interface com.gs.collections.api.RichIterable<V>
  - injectInto
```
public int injectInto(int injectedValue,
             com.gs.collections.api.block.function.primitive.IntObjectToIntFunction<? super V> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
    
    Specified by:
    
    injectInto in interface com.gs.collections.api.RichIterable<V>
  - injectInto
```
public long injectInto(long injectedValue,
              com.gs.collections.api.block.function.primitive.LongObjectToLongFunction<? super V> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
    
    Specified by:
    
    injectInto in interface com.gs.collections.api.RichIterable<V>
  - injectInto
```
public double injectInto(double injectedValue,
                com.gs.collections.api.block.function.primitive.DoubleObjectToDoubleFunction<? super V> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
    
    Specified by:
    
    injectInto in interface com.gs.collections.api.RichIterable<V>
  - injectInto
```
public float injectInto(float injectedValue,
               com.gs.collections.api.block.function.primitive.FloatObjectToFloatFunction<? super V> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
    
    Specified by:
    
    injectInto in interface com.gs.collections.api.RichIterable<V>
  - sumOfInt
```
public long sumOfInt(com.gs.collections.api.block.function.primitive.IntFunction<? super V> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the final long result of evaluating function for each element of the iterable and adding the results together.
    
    Specified by:
    
    sumOfInt in interface com.gs.collections.api.RichIterable<V>
  - sumOfFloat
```
public double sumOfFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super V> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the final double result of evaluating function for each element of the iterable and adding the results together.
    
    Specified by:
    
    sumOfFloat in interface com.gs.collections.api.RichIterable<V>
  - sumOfLong
```
public long sumOfLong(com.gs.collections.api.block.function.primitive.LongFunction<? super V> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the final long result of evaluating function for each element of the iterable and adding the results together.
    
    Specified by:
    
    sumOfLong in interface com.gs.collections.api.RichIterable<V>
  - sumOfDouble
```
public double sumOfDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super V> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the final double result of evaluating function for each element of the iterable and adding the results together.
    
    Specified by:
    
    sumOfDouble in interface com.gs.collections.api.RichIterable<V>
  - toList
```
public com.gs.collections.api.list.MutableList<V> toList()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts the collection to a MutableList implementation.
    
    Specified by:
    
    toList in interface com.gs.collections.api.RichIterable<V>
  - toSortedList
```
public com.gs.collections.api.list.MutableList<V> toSortedList()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
    
    Specified by:
    
    toSortedList in interface com.gs.collections.api.RichIterable<V>
  - toSortedList
```
public com.gs.collections.api.list.MutableList<V> toSortedList(java.util.Comparator<? super V> comparator)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts the collection to a MutableList implementation and sorts it using the specified comparator.
    
    Specified by:
    
    toSortedList in interface com.gs.collections.api.RichIterable<V>
  - toSortedSet
```
public com.gs.collections.api.set.sorted.MutableSortedSet<V> toSortedSet()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.
    
    Specified by:
    
    toSortedSet in interface com.gs.collections.api.RichIterable<V>
  - toSortedSet
```
public com.gs.collections.api.set.sorted.MutableSortedSet<V> toSortedSet(java.util.Comparator<? super V> comparator)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.
    
    Specified by:
    
    toSortedSet in interface com.gs.collections.api.RichIterable<V>
  - toSet
```
public com.gs.collections.api.set.MutableSet<V> toSet()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts the collection to a MutableSet implementation.
    
    Specified by:
    
    toSet in interface com.gs.collections.api.RichIterable<V>
  - toBag
```
public com.gs.collections.api.bag.MutableBag<V> toBag()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts the collection to the default MutableBag implementation.
    
    Specified by:
    
    toBag in interface com.gs.collections.api.RichIterable<V>
  - toMap
```
public <NK,NV> com.gs.collections.api.map.MutableMap<NK,NV> toMap(com.gs.collections.api.block.function.Function<? super V,? extends NK> keyFunction,
                                                         com.gs.collections.api.block.function.Function<? super V,? extends NV> valueFunction)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts the collection to a MutableMap implementation using the specified key and value functions.
    
    Specified by:
    
    toMap in interface com.gs.collections.api.RichIterable<V>
  - toSortedMap
```
public <NK,NV> com.gs.collections.api.map.sorted.MutableSortedMap<NK,NV> toSortedMap(com.gs.collections.api.block.function.Function<? super V,? extends NK> keyFunction,
                                                                            com.gs.collections.api.block.function.Function<? super V,? extends NV> valueFunction)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.
    
    Specified by:
    
    toSortedMap in interface com.gs.collections.api.RichIterable<V>
  - toSortedMap
```
public <NK,NV> com.gs.collections.api.map.sorted.MutableSortedMap<NK,NV> toSortedMap(java.util.Comparator<? super NK> comparator,
                                                                            com.gs.collections.api.block.function.Function<? super V,? extends NK> keyFunction,
                                                                            com.gs.collections.api.block.function.Function<? super V,? extends NV> valueFunction)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator.
    
    Specified by:
    
    toSortedMap in interface com.gs.collections.api.RichIterable<V>
  - asLazy
```
public com.gs.collections.api.LazyIterable<V> asLazy()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns a deferred iterable, most likely implemented by calling LazyIterate.defer(this).
    
    Specified by:
    
    asLazy in interface com.gs.collections.api.RichIterable<V>
  - toArray
```
public java.lang.Object[] toArray()
```
    Specified by:
    
    toArray in interface com.gs.collections.api.RichIterable<V>
    
    See Also:
    Collection.toArray()
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface com.gs.collections.api.RichIterable<V>
    
    See Also:
    Collection.toArray(Object[])
  - min
```
public V min(java.util.Comparator<? super V> comparator)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the minimum element out of this container based on the comparator.
    
    Specified by:
    
    min in interface com.gs.collections.api.RichIterable<V>
  - max
```
public V max(java.util.Comparator<? super V> comparator)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the maximum element out of this container based on the comparator.
    
    Specified by:
    
    max in interface com.gs.collections.api.RichIterable<V>
  - min
```
public V min()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the minimum element out of this container based on the natural order.
    
    Specified by:
    
    min in interface com.gs.collections.api.RichIterable<V>
  - max
```
public V max()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the maximum element out of this container based on the natural order.
    
    Specified by:
    
    max in interface com.gs.collections.api.RichIterable<V>
  - makeString
```
public java.lang.String makeString()
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns a string representation of this collection by delegating to RichIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
    
    Specified by:
    
    makeString in interface com.gs.collections.api.RichIterable<V>
    
    Returns:
    a string representation of this collection.
  - makeString
```
public java.lang.String makeString(java.lang.String separator)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns a string representation of this collection by delegating to RichIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
    
    Specified by:
    
    makeString in interface com.gs.collections.api.RichIterable<V>
    
    Returns:
    a string representation of this collection.
  - makeString
```
public java.lang.String makeString(java.lang.String start,
                          java.lang.String separator,
                          java.lang.String end)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    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 the start and end strings. Adjacent elements are separated by the separator string. Elements are converted to strings as by String.valueOf(Object).
    
    Specified by:
    
    makeString in interface com.gs.collections.api.RichIterable<V>
    
    Returns:
    a string representation of this collection.
  - appendString
```
public void appendString(java.lang.Appendable appendable)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString().
    
    Specified by:
    
    appendString in interface com.gs.collections.api.RichIterable<V>
  - appendString
```
public void appendString(java.lang.Appendable appendable,
                java.lang.String separator)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String).
    
    Specified by:
    
    appendString in interface com.gs.collections.api.RichIterable<V>
  - appendString
```
public void appendString(java.lang.Appendable appendable,
                java.lang.String start,
                java.lang.String separator,
                java.lang.String end)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String, String, String).
    
    Specified by:
    
    appendString in interface com.gs.collections.api.RichIterable<V>
  - zip
```
public <S,R extends java.util.Collection<com.gs.collections.api.tuple.Pair<V,S>>> R zip(java.lang.Iterable<S> that,
                                                                               R target)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Same as RichIterable.zip(Iterable) but uses target for output.
    
    Specified by:
    
    zip in interface com.gs.collections.api.RichIterable<V>
  - zipWithIndex
```
public <R extends java.util.Collection<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>>> R zipWithIndex(R target)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Same as RichIterable.zipWithIndex() but uses target for output.
    
    Specified by:
    
    zipWithIndex in interface com.gs.collections.api.RichIterable<V>
  - chunk
```
public com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<V>> chunk(int size)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Partitions elements in fixed size chunks.
    
    Specified by:
    
    chunk in interface com.gs.collections.api.RichIterable<V>
    
    Parameters:
    size - the number of elements per chunk
    
    Returns:
    A RichIterable containing RichIterables of size size, except the last will be truncated if the elements don't divide evenly.
  - groupBy
```
public <KK,R extends com.gs.collections.api.multimap.MutableMultimap<KK,V>> R groupBy(com.gs.collections.api.block.function.Function<? super V,? extends KK> function,
                                                                             R target)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.
```
e.g.
 return people.groupBy(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 }, new FastListMultimap<String, Person>());
 
```
    Specified by:
    
    groupBy in interface com.gs.collections.api.RichIterable<V>
  - groupByEach
```
public <KK,R extends com.gs.collections.api.multimap.MutableMultimap<KK,V>> R groupByEach(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<KK>> function,
                                                                                 R target)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.
    
    Specified by:
    
    groupByEach in interface com.gs.collections.api.RichIterable<V>
  - minBy
```
public <A extends java.lang.Comparable<? super A>> V minBy(com.gs.collections.api.block.function.Function<? super V,? extends A> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
    
    Specified by:
    
    minBy in interface com.gs.collections.api.RichIterable<V>
  - maxBy
```
public <A extends java.lang.Comparable<? super A>> V maxBy(com.gs.collections.api.block.function.Function<? super V,? extends A> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
    
    Specified by:
    
    maxBy in interface com.gs.collections.api.RichIterable<V>
  - toSortedSetBy
```
public <A extends java.lang.Comparable<? super A>> com.gs.collections.api.set.sorted.MutableSortedSet<V> toSortedSetBy(com.gs.collections.api.block.function.Function<? super V,? extends A> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the attribute returned by function.
    
    Specified by:
    
    toSortedSetBy in interface com.gs.collections.api.RichIterable<V>
  - toSortedListBy
```
public <A extends java.lang.Comparable<? super A>> com.gs.collections.api.list.MutableList<V> toSortedListBy(com.gs.collections.api.block.function.Function<? super V,? extends A> function)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Converts the collection to a MutableList implementation and sorts it based on the natural order of the attribute returned by function.
    
    Specified by:
    
    toSortedListBy in interface com.gs.collections.api.RichIterable<V>
  - flatCollect
```
public <A,R extends java.util.Collection<A>> R flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<A>> function,
                                                  R target)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Same as flatCollect, only the results are collected into the target collection.
    
    Specified by:
    
    flatCollect in interface com.gs.collections.api.RichIterable<V>
    
    Parameters:
    function - The Function to apply
    target - The collection into which results should be added.
    
    Returns:
    target, which will contain a flattened collection of results produced by applying the given function
    See Also:
    RichIterable.flatCollect(Function)
  - collectIf
```
public <A,R extends java.util.Collection<A>> R collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate,
                                                com.gs.collections.api.block.function.Function<? super V,? extends A> function,
                                                R target)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    
    Same as the collectIf method with two parameters but uses the specified target collection for the results.
    
    Specified by:
    
    collectIf in interface com.gs.collections.api.RichIterable<V>
    
    Parameters:
    predicate - a Predicate to use as the select criteria
    function - a Function to use as the collect transformation function
    target - the Collection to append to for all elements in this RichIterable that meet the collect criteria predicate
    
    Returns:
    targetCollection, which contains appended elements as a result of the collect criteria and transformation
    See Also:
    RichIterable.collectIf(Predicate, Function)
  - collectWith
```
public <P,A,R extends java.util.Collection<A>> R collectWith(com.gs.collections.api.block.function.Function2<? super V,? super P,? extends A> function,
                                                    P parameter,
                                                    R targetCollection)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    Same as collectWith but with a targetCollection parameter to gather the results.
```
e.g.
 Function2 addParameterFunction =
 new Function2()
 {
      public Integer value(final Integer each, final Integer parameter)
      {
          return each + parameter;
      }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1), UnifiedSet.newSet());
 
```
    Specified by:
    
    collectWith in interface com.gs.collections.api.RichIterable<V>
    
    Parameters:
    function - a Function2 to use as the collect transformation function
    parameter - a parameter to pass in for evaluation of the second argument P in function
    targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria function
    
    Returns:
    targetCollection, which contains appended elements as a result of the collect transformation
  - collect
```
public <A,R extends java.util.Collection<A>> R collect(com.gs.collections.api.block.function.Function<? super V,? extends A> function,
                                              R target)
```
    Description copied from interface: com.gs.collections.api.RichIterable
    Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.
```
e.g.
 return people.collect(new Function<Person, String>()
 {
     public String valueOf(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 }, Lists.mutable.of());
 
```
    Specified by:
    
    collect in interface com.gs.collections.api.RichIterable<V>
    
    Parameters:
    function - a Function to use as the collect transformation function
    target - the Collection to append to for all elements in this RichIterable that meet select criteria function
    
    Returns:
    target, which contains appended elements as a result of the collect transformation
    See Also:
    RichIterable.collect(Function)
  - collectBoolean
```
public com.gs.collections.api.BooleanIterable 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.RichIterable<V>
  - collectByte
```
public com.gs.collections.api.ByteIterable 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.RichIterable<V>
  - collectChar
```
public com.gs.collections.api.CharIterable 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.RichIterable<V>
  - collectDouble
```
public com.gs.collections.api.DoubleIterable 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.RichIterable<V>
  - collectFloat
```
public com.gs.collections.api.FloatIterable 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.RichIterable<V>
  - collectInt
```
public com.gs.collections.api.IntIterable 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.RichIterable<V>
  - collectLong
```
public com.gs.collections.api.LongIterable 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.RichIterable<V>
  - collectShort
```
public com.gs.collections.api.ShortIterable 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.RichIterable<V>
  - forEach
```
public void forEach(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)
```
    Description copied from interface: com.gs.collections.api.InternalIterable
    The procedure is executed for each element in the iterable.
```
e.g.
 people.forEach(new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 
```
    Specified by:
    
    forEach in interface com.gs.collections.api.InternalIterable<V>
  - forEachWithIndex
```
public void forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super V> objectIntProcedure)
```
    Description copied from interface: com.gs.collections.api.InternalIterable
    Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
```
e.g.
 people.forEachWithIndex(new ObjectIntProcedure()
 {
     public void value(Person person, int index)
     {
         LOGGER.info("Index: " + index + " person: " + person.getName());
     }
 });
 
```
    Specified by:
    
    forEachWithIndex in interface com.gs.collections.api.InternalIterable<V>
  - forEachWith
```
public <P> void forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super V,? super P> procedure2,
                   P parameter)
```
    Description copied from interface: com.gs.collections.api.InternalIterable
    The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
```
e.g.
 people.forEachWith(new Procedure2()
 {
     public void value(Person person, Person other)
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }
 }, fred);
 
```
    Specified by:
    
    forEachWith in interface com.gs.collections.api.InternalIterable<V>
  - iterator
```
public java.util.Iterator<V> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<V>

Class SynchronizedMapIterable<K,V>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Field Detail

lock

Constructor Detail

SynchronizedMapIterable

SynchronizedMapIterable

Method Detail

getMap

get

containsKey

containsValue

forEachValue

forEachKey

forEachKeyValue

getIfAbsent

getIfAbsentValue

getIfAbsentWith

ifPresentApply

keysView

valuesView

detect

size

isEmpty

notEmpty

getFirst

getLast

contains

containsAllIterable

containsAll

containsAllArguments

select

selectWith

reject

rejectWith

detect

detectIfNone

count

anySatisfy

allSatisfy

noneSatisfy

injectInto

injectInto

injectInto

injectInto

injectInto

sumOfInt

sumOfFloat

sumOfLong

sumOfDouble

toList

toSortedList

toSortedList

toSortedSet

toSortedSet

toSet

toBag

toMap

toSortedMap

toSortedMap

asLazy

toArray

toArray

min

max

min

max

makeString

makeString

makeString

appendString

appendString

appendString

zip

zipWithIndex