Class UnmodifiableMutableMap<K,​V>

    • Constructor Detail

      • UnmodifiableMutableMap

        protected UnmodifiableMutableMap​(MutableMap<K,​V> map)
    • Method Detail

      • of

        public static <K,​V,​M extends java.util.Map<K,​V>> UnmodifiableMutableMap<K,​V> of​(M map)
        This method will take a MutableMap and wrap it directly in a UnmodifiableMutableMap. It will take any other non-Eclipse-Collections map and first adapt it will a MapAdapter, and then return a UnmodifiableMutableMap that wraps the adapter.
      • notEmpty

        public boolean notEmpty()
        Description copied from interface: RichIterable
        The English equivalent of !this.isEmpty()
        Specified by:
        notEmpty in interface RichIterable<K>
      • forEachValue

        public void forEachValue​(Procedure<? super V> procedure)
        Description copied from interface: 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 MapIterable<K,​V>
      • forEachKey

        public void forEachKey​(Procedure<? super K> procedure)
        Description copied from interface: 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 MapIterable<K,​V>
      • forEachKeyValue

        public void forEachKeyValue​(Procedure2<? super K,​? super V> procedure)
        Description copied from interface: 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((Integer key, String value) -> collection.add(String.valueOf(key) + value));
             Verify.assertContainsAll(collection, "1One", "2Two", "3Three");
         
        Specified by:
        forEachKeyValue in interface MapIterable<K,​V>
      • collectKeysAndValues

        public <E> MutableMap<K,​V> collectKeysAndValues​(java.lang.Iterable<E> iterable,
                                                              Function<? super E,​? extends K> keyFunction,
                                                              Function<? super E,​? extends V> valueFunction)
        Description copied from interface: MutableMap
        Adds all the entries derived from iterable to this. The key and value for each entry is determined by applying the keyFunction and valueFunction to each item in collection. Any entry in map that has the same key as an entry in this will have its value replaced by that in map.
        Specified by:
        collectKeysAndValues in interface MutableMap<K,​V>
      • removeKey

        public V removeKey​(K key)
        Description copied from interface: MutableMapIterable
        Remove an entry from the map at the specified key.
        Specified by:
        removeKey in interface MutableMapIterable<K,​V>
        Returns:
        The value removed from entry at key, or null if not found.
        See Also:
        Map.remove(Object)
      • removeAllKeys

        public boolean removeAllKeys​(java.util.Set<? extends K> keys)
        Description copied from interface: MutableMapIterable
        Remove entries from the map at the specified keys.
        Specified by:
        removeAllKeys in interface MutableMapIterable<K,​V>
        Returns:
        true if this map changed as a result of the call
      • removeIf

        public boolean removeIf​(Predicate2<? super K,​? super V> predicate)
        Description copied from interface: MutableMapIterable
        Remove an entry from the map if the predicate evaluates to true.
        Specified by:
        removeIf in interface MutableMapIterable<K,​V>
        Returns:
        true if any entry is removed.
      • updateValue

        public V updateValue​(K key,
                             Function0<? extends V> factory,
                             Function<? super V,​? extends V> function)
        Description copied from interface: MutableMapIterable
        Looks up the value associated with key, applies the function to it, and replaces the value. If there is no value associated with key, starts it off with a value supplied by factory.
        Specified by:
        updateValue in interface MutableMapIterable<K,​V>
      • getIfAbsentPut

        public V getIfAbsentPut​(K key,
                                Function0<? extends V> function)
        Description copied from interface: MutableMapIterable
        Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map at the key, return the result of evaluating the specified Function0, and put that value in the map at the specified key.
        Specified by:
        getIfAbsentPut in interface MutableMapIterable<K,​V>
      • getIfAbsentPut

        public V getIfAbsentPut​(K key,
                                V value)
        Description copied from interface: MutableMapIterable
        Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map at the key, return the specified value, and put that value in the map at the specified key.
        Specified by:
        getIfAbsentPut in interface MutableMapIterable<K,​V>
      • getIfAbsentPutWithKey

        public V getIfAbsentPutWithKey​(K key,
                                       Function<? super K,​? extends V> function)
        Description copied from interface: MutableMapIterable
        Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map for that key return the result of evaluating the specified Function using the specified key, and put that value in the map at the specified key.
        Specified by:
        getIfAbsentPutWithKey in interface MutableMapIterable<K,​V>
      • getIfAbsentPutWith

        public <P> V getIfAbsentPutWith​(K key,
                                        Function<? super P,​? extends V> function,
                                        P parameter)
        Description copied from interface: MutableMapIterable
        Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map for that key return the result of evaluating the specified Function using the specified parameter, and put that value in the map at the specified key.
        Specified by:
        getIfAbsentPutWith in interface MutableMapIterable<K,​V>
      • getIfAbsent

        public V getIfAbsent​(K key,
                             Function0<? extends V> function)
        Description copied from interface: 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 MapIterable<K,​V>
      • getIfAbsentValue

        public V getIfAbsentValue​(K key,
                                  V value)
        Description copied from interface: 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 MapIterable<K,​V>
      • getIfAbsentWith

        public <P> V getIfAbsentWith​(K key,
                                     Function<? super P,​? extends V> function,
                                     P parameter)
        Description copied from interface: 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 MapIterable<K,​V>
      • isAbsent

        private boolean isAbsent​(V result,
                                 K key)
      • ifPresentApply

        public <A> A ifPresentApply​(K key,
                                    Function<? super V,​? extends A> function)
        Description copied from interface: 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 MapIterable<K,​V>
      • putPair

        public V putPair​(Pair<? extends K,​? extends V> keyValuePair)
        Description copied from interface: MutableMapIterable
        This method allows mutable map the ability to add an element in the form of Pair<? extends K, ? extends V>.
        Specified by:
        putPair in interface MutableMapIterable<K,​V>
        See Also:
        Map.put(Object, Object)
      • add

        public V add​(Pair<? extends K,​? extends V> keyValuePair)
        Description copied from interface: MutableMapIterable
        This method allows mutable map the ability to add an element in the form of Pair<? extends K, ? extends V>.
        Specified by:
        add in interface MutableMapIterable<K,​V>
        Returns:
        previous value in the map for the key, or null if no value exists for the key.
        See Also:
        Map.put(Object, Object)
      • withKeyValue

        public MutableMap<K,​V> withKeyValue​(K key,
                                                  V value)
        Description copied from interface: MutableMapIterable
        This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus the additional key and value. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:
         map = map.withKeyValue("new key", "new value");
         
        In the case of FixedSizeMap, a new instance will be returned by withKeyValue, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.
        Specified by:
        withKeyValue in interface MutableMap<K,​V>
        Specified by:
        withKeyValue in interface MutableMapIterable<K,​V>
        See Also:
        Map.put(Object, Object)
      • withAllKeyValues

        public MutableMap<K,​V> withAllKeyValues​(java.lang.Iterable<? extends Pair<? extends K,​? extends V>> keyValues)
        Description copied from interface: MutableMapIterable
        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 the additional keys and values. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:
         map = map.withAllKeyValues(FastList.newListWith(PairImpl.of("new key", "new value")));
         
        In the case of FixedSizeMap, a new instance will be returned by withAllKeyValues, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.
        Specified by:
        withAllKeyValues in interface MutableMap<K,​V>
        Specified by:
        withAllKeyValues in interface MutableMapIterable<K,​V>
        See Also:
        Map.put(Object, Object)
      • withoutKey

        public MutableMap<K,​V> withoutKey​(K key)
        Description copied from interface: MutableMapIterable
        This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus the key and value to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:
         map = map.withoutKey("key");
         
        In the case of FixedSizeMap, a new instance will be returned by withoutKey, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.
        Specified by:
        withoutKey in interface MutableMap<K,​V>
        Specified by:
        withoutKey in interface MutableMapIterable<K,​V>
        See Also:
        Map.remove(Object)
      • withoutAllKeys

        public MutableMap<K,​V> withoutAllKeys​(java.lang.Iterable<? extends K> keys)
        Description copied from interface: MutableMapIterable
        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 the keys and values to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:
         map = map.withoutAllKeys(FastList.newListWith("key1", "key2"));
         
        In the case of FixedSizeMap, a new instance will be returned by withoutAllKeys, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.
        Specified by:
        withoutAllKeys in interface MutableMap<K,​V>
        Specified by:
        withoutAllKeys in interface MutableMapIterable<K,​V>
        See Also:
        Map.remove(Object)
      • flip

        public 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 MutableMap<K,​V>
        Specified by:
        flip in interface MutableMapIterable<K,​V>
        Specified by:
        flip in interface UnsortedMapIterable<K,​V>
      • asUnmodifiable

        public MutableMap<K,​V> asUnmodifiable()
        Description copied from interface: MutableMapIterable
        Returns an unmodifiable view of this map. This is the equivalent of using Collections.unmodifiableMap(this) only with a return type that supports the full iteration protocols available on MutableMapIterable. Methods which would mutate the underlying map will throw UnsupportedOperationExceptions.
        Specified by:
        asUnmodifiable in interface MutableMap<K,​V>
        Specified by:
        asUnmodifiable in interface MutableMapIterable<K,​V>
        Returns:
        an unmodifiable view of this map.
        See Also:
        Collections.unmodifiableMap(Map)
      • asSynchronized

        public MutableMap<K,​V> asSynchronized()
        Description copied from interface: MutableMapIterable
        Returns a synchronized wrapper backed by this map. This is the equivalent of calling Collections.synchronizedMap(this) only with the more feature rich return type of MutableMapIterable.

        The preferred way of iterating over a synchronized map is to use the forEachKey(), forEachValue() and forEachKeyValue() methods which are properly synchronized internally.

          MutableMap synchedMap = map.asSynchronized();
        
          synchedMap.forEachKey(key -> ... );
          synchedMap.forEachValue(value -> ... );
          synchedMap.forEachKeyValue((key, value) -> ... );
         

        If you want to iterate imperatively over the keySet(), values(), or entrySet(), you will need to protect the iteration by wrapping the code in a synchronized block on the map.

        Specified by:
        asSynchronized in interface MutableMap<K,​V>
        Specified by:
        asSynchronized in interface MutableMapIterable<K,​V>
        See Also:
        Collections.synchronizedMap(Map)
      • each

        public void each​(Procedure<? super V> procedure)
        Description copied from interface: RichIterable
        The procedure is executed for each element in the iterable.

        Example using a Java 8 lambda expression:

         people.each(person -> LOGGER.info(person.getName()));
         

        Example using an anonymous inner class:

         people.each(new Procedure<Person>()
         {
             public void value(Person person)
             {
                 LOGGER.info(person.getName());
             }
         });
         
        This method is a variant of InternalIterable.forEach(Procedure) that has a signature conflict with Iterable.forEach(java.util.function.Consumer).
        Specified by:
        each in interface RichIterable<K>
        See Also:
        InternalIterable.forEach(Procedure), Iterable.forEach(java.util.function.Consumer)
      • forEachWithIndex

        public void forEachWithIndex​(ObjectIntProcedure<? super V> objectIntProcedure)
        Description copied from interface: InternalIterable
        Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.

        Example using a Java 8 lambda:

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

        Example using an anonymous inner class:

         people.forEachWithIndex(new ObjectIntProcedure<Person>()
         {
             public void value(Person person, int index)
             {
                 LOGGER.info("Index: " + index + " person: " + person.getName());
             }
         });
         
        Specified by:
        forEachWithIndex in interface InternalIterable<K>
      • forEachWith

        public <P> void forEachWith​(Procedure2<? super V,​? super P> procedure,
                                    P parameter)
        Description copied from interface: InternalIterable
        The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.

        Example using a Java 8 lambda:

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

        Example using an anonymous inner class:

         people.forEachWith(new Procedure2<Person, Person>()
         {
             public void value(Person person, Person other)
             {
                 if (person.isRelatedTo(other))
                 {
                      LOGGER.info(person.getName());
                 }
             }
         }, fred);
         
        Specified by:
        forEachWith in interface InternalIterable<K>
      • iterator

        public java.util.Iterator<V> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<K>
      • hashCode

        public int hashCode()
        Description copied from interface: MapIterable
        Follows the same general contract as Map.hashCode().
        Specified by:
        hashCode in interface java.util.Map<K,​V>
        Specified by:
        hashCode in interface MapIterable<K,​V>
        Overrides:
        hashCode in class UnmodifiableMap<K,​V>
      • equals

        public boolean equals​(java.lang.Object obj)
        Description copied from interface: MapIterable
        Follows the same general contract as Map.equals(Object).
        Specified by:
        equals in interface java.util.Map<K,​V>
        Specified by:
        equals in interface MapIterable<K,​V>
        Overrides:
        equals in class UnmodifiableMap<K,​V>
      • getMutableMap

        protected MutableMap<K,​V> getMutableMap()
      • keysView

        public RichIterable<K> keysView()
        Description copied from interface: MapIterable
        Returns an unmodifiable lazy iterable wrapped around the keySet for the map.
        Specified by:
        keysView in interface MapIterable<K,​V>
      • valuesView

        public RichIterable<V> valuesView()
        Description copied from interface: MapIterable
        Returns an unmodifiable lazy iterable wrapped around the values for the map.
        Specified by:
        valuesView in interface MapIterable<K,​V>
      • keyValuesView

        public RichIterable<Pair<K,​V>> keyValuesView()
        Description copied from interface: MapIterable
        Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map.
        Specified by:
        keyValuesView in interface MapIterable<K,​V>
      • collectValues

        public <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.
         MapIterable<City, String> collected =
             peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName());
         
        Specified by:
        collectValues in interface MapIterable<K,​V>
        Specified by:
        collectValues in interface MutableMap<K,​V>
        Specified by:
        collectValues in interface MutableMapIterable<K,​V>
        Specified by:
        collectValues in interface UnsortedMapIterable<K,​V>
      • collect

        public <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.
         MapIterable<String, String> collected =
             peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity()));
         
        Specified by:
        collect in interface MapIterable<K,​V>
        Specified by:
        collect in interface MutableMap<K,​V>
        Specified by:
        collect in interface MutableMapIterable<K,​V>
        Specified by:
        collect in interface UnsortedMapIterable<K,​V>
      • select

        public 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.
         MapIterable<City, Person> selected =
             peopleByCity.select((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
         
        Specified by:
        select in interface MapIterable<K,​V>
        Specified by:
        select in interface MutableMap<K,​V>
        Specified by:
        select in interface MutableMapIterable<K,​V>
        Specified by:
        select in interface UnsortedMapIterable<K,​V>
      • reject

        public 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.
         MapIterable<City, Person> rejected =
             peopleByCity.reject((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
         
        Specified by:
        reject in interface MapIterable<K,​V>
        Specified by:
        reject in interface MutableMap<K,​V>
        Specified by:
        reject in interface MutableMapIterable<K,​V>
        Specified by:
        reject in interface UnsortedMapIterable<K,​V>
      • detect

        public Pair<K,​V> detect​(Predicate2<? super K,​? super V> predicate)
        Description copied from interface: 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 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.
         Pair<City, Person> detected =
             peopleByCity.detect((City city, Person person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
         
        Specified by:
        detect in interface MapIterable<K,​V>
      • detectOptional

        public java.util.Optional<Pair<K,​V>> detectOptional​(Predicate2<? super K,​? super V> predicate)
        Description copied from interface: MapIterable
        Return the first key and value of the map as an Optional 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 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.
         Optional<Pair<City, Person>> detected =
             peopleByCity.detectOptional((city, person)
                  -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
         
        Specified by:
        detectOptional in interface MapIterable<K,​V>
      • allSatisfy

        public boolean allSatisfy​(Predicate<? super V> predicate)
        Description copied from interface: 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 RichIterable<K>
      • allSatisfyWith

        public <P> boolean allSatisfyWith​(Predicate2<? super V,​? super P> predicate,
                                          P parameter)
        Description copied from interface: RichIterable
        Returns true if the predicate evaluates to true for every element of the collection, or returns false.
        Specified by:
        allSatisfyWith in interface RichIterable<K>
      • noneSatisfy

        public boolean noneSatisfy​(Predicate<? super V> predicate)
        Description copied from interface: 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 RichIterable<K>
      • noneSatisfyWith

        public <P> boolean noneSatisfyWith​(Predicate2<? super V,​? super P> predicate,
                                           P parameter)
        Description copied from interface: RichIterable
        Returns true if the predicate evaluates to false for every element of the collection, or return false. Returns true if the collection is empty.
        Specified by:
        noneSatisfyWith in interface RichIterable<K>
      • anySatisfy

        public boolean anySatisfy​(Predicate<? super V> predicate)
        Description copied from interface: 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 RichIterable<K>
      • anySatisfyWith

        public <P> boolean anySatisfyWith​(Predicate2<? super V,​? super P> predicate,
                                          P parameter)
        Description copied from interface: RichIterable
        Returns true if the predicate evaluates to true for any element of the collection, or return false. Returns false if the collection is empty.
        Specified by:
        anySatisfyWith in interface RichIterable<K>
      • appendString

        public void appendString​(java.lang.Appendable appendable)
        Description copied from interface: RichIterable
        Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString().
        Specified by:
        appendString in interface RichIterable<K>
      • appendString

        public void appendString​(java.lang.Appendable appendable,
                                 java.lang.String separator)
        Description copied from interface: 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 RichIterable<K>
      • toSortedBag

        public MutableSortedBag<V> toSortedBag()
        Description copied from interface: RichIterable
        Converts the collection to a MutableSortedBag implementation and sorts it using the natural order of the elements.
        Specified by:
        toSortedBag in interface RichIterable<K>
      • toSortedBag

        public MutableSortedBag<V> toSortedBag​(java.util.Comparator<? super V> comparator)
        Description copied from interface: RichIterable
        Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.
        Specified by:
        toSortedBag in interface RichIterable<K>
      • asLazy

        public LazyIterable<V> asLazy()
        Description copied from interface: RichIterable
        Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
        Specified by:
        asLazy in interface RichIterable<K>
      • into

        public <R extends java.util.Collection<V>> R into​(R target)
        Description copied from interface: RichIterable
        Adds all the elements in this iterable to the specific target Collection.
        Specified by:
        into in interface RichIterable<K>
      • toMap

        public <NK,​NV> MutableMap<NK,​NV> toMap​(Function<? super V,​? extends NK> keyFunction,
                                                           Function<? super V,​? extends NV> valueFunction)
        Description copied from interface: RichIterable
        Converts the collection to a MutableMap implementation using the specified key and value functions.
        Specified by:
        toMap in interface RichIterable<K>
      • toSortedMap

        public <NK,​NV> MutableSortedMap<NK,​NV> toSortedMap​(Function<? super V,​? extends NK> keyFunction,
                                                                       Function<? super V,​? extends NV> valueFunction)
        Description copied from interface: 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 RichIterable<K>
      • toSortedMap

        public <NK,​NV> MutableSortedMap<NK,​NV> toSortedMap​(java.util.Comparator<? super NK> comparator,
                                                                       Function<? super V,​? extends NK> keyFunction,
                                                                       Function<? super V,​? extends NV> valueFunction)
        Description copied from interface: 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 RichIterable<K>
      • toBiMap

        public <NK,​NV> MutableBiMap<NK,​NV> toBiMap​(Function<? super V,​? extends NK> keyFunction,
                                                               Function<? super V,​? extends NV> valueFunction)
        Description copied from interface: RichIterable
        Converts the collection to a BiMap implementation using the specified key and value functions.
        Specified by:
        toBiMap in interface RichIterable<K>
      • toSortedList

        public MutableList<V> toSortedList()
        Description copied from interface: RichIterable
        Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
        Specified by:
        toSortedList in interface RichIterable<K>
      • toSortedList

        public MutableList<V> toSortedList​(java.util.Comparator<? super V> comparator)
        Description copied from interface: RichIterable
        Converts the collection to a MutableList implementation and sorts it using the specified comparator.
        Specified by:
        toSortedList in interface RichIterable<K>
      • toSortedSet

        public MutableSortedSet<V> toSortedSet()
        Description copied from interface: RichIterable
        Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.
        Specified by:
        toSortedSet in interface RichIterable<K>
      • toSortedSet

        public MutableSortedSet<V> toSortedSet​(java.util.Comparator<? super V> comparator)
        Description copied from interface: RichIterable
        Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.
        Specified by:
        toSortedSet in interface RichIterable<K>
      • chunk

        public RichIterable<RichIterable<V>> chunk​(int size)
        Description copied from interface: RichIterable
        Partitions elements in fixed size chunks.
        Specified by:
        chunk in interface RichIterable<K>
        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.
      • collect

        public <R,​C extends java.util.Collection<R>> C collect​(Function<? super V,​? extends R> function,
                                                                     C target)
        Description copied from interface: RichIterable
        Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.

        Example using a Java 8 lambda expression:

         MutableList<String> names =
             people.collect(person -> person.getFirstName() + " " + person.getLastName(), Lists.mutable.empty());
         

        Example using an anonymous inner class:

         MutableList<String> names =
             people.collect(new Function<Person, String>()
             {
                 public String valueOf(Person person)
                 {
                     return person.getFirstName() + " " + person.getLastName();
                 }
             }, Lists.mutable.empty());
         
        Specified by:
        collect in interface RichIterable<K>
        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)
      • collectIf

        public <R,​C extends java.util.Collection<R>> C collectIf​(Predicate<? super V> predicate,
                                                                       Function<? super V,​? extends R> function,
                                                                       C target)
        Description copied from interface: RichIterable
        Same as the collectIf method with two parameters but uses the specified target collection for the results.
        Specified by:
        collectIf in interface RichIterable<K>
        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,​VV> MutableBag<VV> collectWith​(Function2<? super V,​? super P,​? extends VV> function,
                                                       P parameter)
        Description copied from interface: RichIterable
        Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.

        Example using a Java 8 lambda expression:

         RichIterable<Integer> integers =
             Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
         

        Example using an anonymous inner class:

         Function2<Integer, Integer, Integer> addParameterFunction =
             new Function2<Integer, Integer, Integer>()
             {
                 public Integer value(Integer each, Integer parameter)
                 {
                     return each + parameter;
                 }
             };
         RichIterable<Integer> integers =
             Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
         
        Specified by:
        collectWith in interface MutableMap<K,​V>
        Specified by:
        collectWith in interface RichIterable<K>
        Specified by:
        collectWith in interface UnsortedMapIterable<K,​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
        Returns:
        A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)
        See Also:
        RichIterable.collect(Function)
      • collectWith

        public <P,​R,​C extends java.util.Collection<R>> C collectWith​(Function2<? super V,​? super P,​? extends R> function,
                                                                                 P parameter,
                                                                                 C targetCollection)
        Description copied from interface: RichIterable
        Same as collectWith but with a targetCollection parameter to gather the results.

        Example using a Java 8 lambda expression:

         MutableSet<Integer> integers =
             Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1), Sets.mutable.empty());
         

        Example using an anonymous inner class:

         Function2<Integer, Integer, Integer> addParameterFunction =
             new Function2<Integer, Integer, Integer>()
             {
                 public Integer value(final Integer each, final Integer parameter)
                 {
                     return each + parameter;
                 }
             };
         MutableSet<Integer> integers =
             Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1), Sets.mutable.empty());
         
        Specified by:
        collectWith in interface RichIterable<K>
        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
      • contains

        public boolean contains​(java.lang.Object object)
        Description copied from interface: RichIterable
        Returns true if the iterable has an element which responds true to element.equals(object).
        Specified by:
        contains in interface RichIterable<K>
      • containsAllArguments

        public boolean containsAllArguments​(java.lang.Object... elements)
        Description copied from interface: RichIterable
        Returns true if all elements in the specified var arg array are contained in this collection.
        Specified by:
        containsAllArguments in interface RichIterable<K>
      • containsAllIterable

        public boolean containsAllIterable​(java.lang.Iterable<?> source)
        Description copied from interface: RichIterable
        Returns true if all elements in source are contained in this collection.
        Specified by:
        containsAllIterable in interface RichIterable<K>
      • containsAll

        public boolean containsAll​(java.util.Collection<?> source)
        Description copied from interface: RichIterable
        Returns true if all elements in source are contained in this collection.
        Specified by:
        containsAll in interface RichIterable<K>
        See Also:
        Collection.containsAll(Collection)
      • count

        public int count​(Predicate<? super V> predicate)
        Description copied from interface: RichIterable
        Return the total number of elements that answer true to the specified predicate.

        Example using a Java 8 lambda expression:

         int count =
             people.count(person -> person.getAddress().getState().getName().equals("New York"));
         

        Example using an anonymous inner class:

         int count =
             people.count(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.getAddress().getState().getName().equals("New York");
                 }
             });
         
        Specified by:
        count in interface RichIterable<K>
      • countWith

        public <P> int countWith​(Predicate2<? super V,​? super P> predicate,
                                 P parameter)
        Description copied from interface: RichIterable
        Returns the total number of elements that evaluate to true for the specified predicate.
        e.g.
         return lastNames.countWith(Predicates2.equal(), "Smith");
         
        Specified by:
        countWith in interface RichIterable<K>
      • detect

        public V detect​(Predicate<? super V> predicate)
        Description copied from interface: RichIterable
        Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find.

        Example using a Java 8 lambda expression:

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

        Example using an anonymous inner class:

         Person person =
             people.detect(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
                 }
             });
         
        Specified by:
        detect in interface RichIterable<K>
      • detectWith

        public <P> V detectWith​(Predicate2<? super V,​? super P> predicate,
                                P parameter)
        Description copied from interface: RichIterable
        Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.

        Example using a Java 8 lambda expression:

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

        Example using an anonymous inner class:

         Person person =
             people.detectWith(new Predicate2<Person, String>()
             {
                 public boolean accept(Person person, String fullName)
                 {
                     return person.getFullName().equals(fullName);
                 }
             }, "John Smith");
         
        Specified by:
        detectWith in interface RichIterable<K>
      • detectOptional

        public java.util.Optional<V> detectOptional​(Predicate<? super V> predicate)
        Description copied from interface: RichIterable
        Returns the first element of the iterable for which the predicate evaluates to true as an Optional. This method is commonly called find.

        Example using a Java 8 lambda expression:

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

        Specified by:
        detectOptional in interface RichIterable<K>
      • detectWithOptional

        public <P> java.util.Optional<V> detectWithOptional​(Predicate2<? super V,​? super P> predicate,
                                                            P parameter)
        Description copied from interface: RichIterable
        Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.

        Example using a Java 8 lambda expression:

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

        Specified by:
        detectWithOptional in interface RichIterable<K>
      • detectIfNone

        public V detectIfNone​(Predicate<? super V> predicate,
                              Function0<? extends V> function)
        Description copied from interface: 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 RichIterable<K>
      • detectWithIfNone

        public <P> V detectWithIfNone​(Predicate2<? super V,​? super P> predicate,
                                      P parameter,
                                      Function0<? extends V> function)
        Description copied from interface: RichIterable
        Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.
        Specified by:
        detectWithIfNone in interface RichIterable<K>
      • flatCollect

        public <R,​C extends java.util.Collection<R>> C flatCollect​(Function<? super V,​? extends java.lang.Iterable<R>> function,
                                                                         C target)
        Description copied from interface: RichIterable
        Same as flatCollect, only the results are collected into the target collection.
        Specified by:
        flatCollect in interface RichIterable<K>
        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)
      • getFirst

        public V getFirst()
        Description copied from interface: 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 RichIterable<K>
      • getLast

        public V getLast()
        Description copied from interface: 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 RichIterable<K>
      • getOnly

        public V getOnly()
        Description copied from interface: RichIterable
        Returns the element if the iterable has exactly one element. Otherwise, throw IllegalStateException.
        Specified by:
        getOnly in interface RichIterable<K>
        Returns:
        an element of an iterable.
      • groupBy

        public <R> MutableBagMultimap<R,​V> groupBy​(Function<? super V,​? extends R> 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.

        Example using a Java 8 method reference:

         Multimap<String, Person> peopleByLastName =
             people.groupBy(Person::getLastName);
         

        Example using an anonymous inner class:

         Multimap<String, Person> peopleByLastName =
             people.groupBy(new Function<Person, String>()
             {
                 public String valueOf(Person person)
                 {
                     return person.getLastName();
                 }
             });
         
        Specified by:
        groupBy in interface MutableMap<K,​V>
        Specified by:
        groupBy in interface MutableMapIterable<K,​V>
        Specified by:
        groupBy in interface RichIterable<K>
        Specified by:
        groupBy in interface UnsortedMapIterable<K,​V>
      • groupBy

        public <R,​C extends MutableMultimap<R,​V>> C groupBy​(Function<? super V,​? extends R> function,
                                                                        C target)
        Description copied from interface: RichIterable
        Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.

        Example using a Java 8 method reference:

         FastListMultimap<String, Person> peopleByLastName =
             people.groupBy(Person::getLastName, new FastListMultimap<String, Person>());
         

        Example using an anonymous inner class:

         FastListMultimap<String, Person> peopleByLastName =
             people.groupBy(new Function<Person, String>()
             {
                 public String valueOf(Person person)
                 {
                     return person.getLastName();
                 }
             }, new FastListMultimap<String, Person>());
         
        Specified by:
        groupBy in interface RichIterable<K>
      • injectInto

        public <IV> IV injectInto​(IV injectedValue,
                                  Function2<? super IV,​? super V,​? extends IV> function)
        Description copied from interface: 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 RichIterable<K>
      • injectInto

        public int injectInto​(int injectedValue,
                              IntObjectToIntFunction<? super V> function)
        Description copied from interface: 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 RichIterable<K>
      • injectInto

        public long injectInto​(long injectedValue,
                               LongObjectToLongFunction<? super V> function)
        Description copied from interface: 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 RichIterable<K>
      • injectInto

        public double injectInto​(double injectedValue,
                                 DoubleObjectToDoubleFunction<? super V> function)
        Description copied from interface: 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 RichIterable<K>
      • injectInto

        public float injectInto​(float injectedValue,
                                FloatObjectToFloatFunction<? super V> function)
        Description copied from interface: 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 RichIterable<K>
      • sumOfInt

        public long sumOfInt​(IntFunction<? super V> function)
        Description copied from interface: 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 RichIterable<K>
      • sumOfFloat

        public double sumOfFloat​(FloatFunction<? super V> function)
        Description copied from interface: RichIterable
        Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.
        Specified by:
        sumOfFloat in interface RichIterable<K>
      • sumOfLong

        public long sumOfLong​(LongFunction<? super V> function)
        Description copied from interface: 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 RichIterable<K>
      • sumOfDouble

        public double sumOfDouble​(DoubleFunction<? super V> function)
        Description copied from interface: RichIterable
        Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.
        Specified by:
        sumOfDouble in interface RichIterable<K>
      • makeString

        public java.lang.String makeString()
        Description copied from interface: 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 RichIterable<K>
        Returns:
        a string representation of this collection.
      • makeString

        public java.lang.String makeString​(java.lang.String separator)
        Description copied from interface: 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 RichIterable<K>
        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: RichIterable
        Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
        Specified by:
        makeString in interface RichIterable<K>
        Returns:
        a string representation of this collection.
      • max

        public V max()
        Description copied from interface: RichIterable
        Returns the maximum element out of this container based on the natural order.
        Specified by:
        max in interface RichIterable<K>
      • max

        public V max​(java.util.Comparator<? super V> comparator)
        Description copied from interface: RichIterable
        Returns the maximum element out of this container based on the comparator.
        Specified by:
        max in interface RichIterable<K>
      • maxBy

        public <R extends java.lang.Comparable<? super R>> V maxBy​(Function<? super V,​? extends R> function)
        Description copied from interface: 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 RichIterable<K>
      • min

        public V min()
        Description copied from interface: RichIterable
        Returns the minimum element out of this container based on the natural order.
        Specified by:
        min in interface RichIterable<K>
      • min

        public V min​(java.util.Comparator<? super V> comparator)
        Description copied from interface: RichIterable
        Returns the minimum element out of this container based on the comparator.
        Specified by:
        min in interface RichIterable<K>
      • minBy

        public <R extends java.lang.Comparable<? super R>> V minBy​(Function<? super V,​? extends R> function)
        Description copied from interface: 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 RichIterable<K>
      • toArray

        public java.lang.Object[] toArray()
        Description copied from interface: RichIterable
        Converts this iterable to an array.
        Specified by:
        toArray in interface RichIterable<K>
        See Also:
        Collection.toArray()
      • toArray

        public <T> T[] toArray​(T[] a)
        Description copied from interface: RichIterable
        Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
        Specified by:
        toArray in interface RichIterable<K>
        See Also:
        Collection.toArray(Object[])
      • collect

        public <R> MutableBag<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.

        Example using a Java 8 lambda expression:

         RichIterable<String> names =
             people.collect(person -> person.getFirstName() + " " + person.getLastName());
         

        Example using an anonymous inner class:

         RichIterable<String> names =
             people.collect(new Function<Person, String>()
             {
                 public String valueOf(Person person)
                 {
                     return person.getFirstName() + " " + person.getLastName();
                 }
             });
         
        Specified by:
        collect in interface MutableMap<K,​V>
        Specified by:
        collect in interface RichIterable<K>
        Specified by:
        collect in interface UnsortedMapIterable<K,​V>
      • collectBoolean

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

        Example using a Java 8 lambda expression:

         BooleanIterable licenses =
             people.collectBoolean(person -> person.hasDrivingLicense());
         

        Example using an anonymous inner class:

         BooleanIterable licenses =
             people.collectBoolean(new BooleanFunction<Person>()
             {
                 public boolean booleanValueOf(Person person)
                 {
                     return person.hasDrivingLicense();
                 }
             });
         
        Specified by:
        collectBoolean in interface MutableMap<K,​V>
        Specified by:
        collectBoolean in interface RichIterable<K>
        Specified by:
        collectBoolean in interface UnsortedMapIterable<K,​V>
      • collectBoolean

        public <R extends MutableBooleanCollection> R collectBoolean​(BooleanFunction<? super V> booleanFunction,
                                                                     R target)
        Description copied from interface: RichIterable
        Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target collection.

        Example using a Java 8 lambda expression:

         BooleanArrayList licenses =
             people.collectBoolean(person -> person.hasDrivingLicense(), new BooleanArrayList());
         

        Example using an anonymous inner class:

         BooleanArrayList licenses =
             people.collectBoolean(new BooleanFunction<Person>()
             {
                 public boolean booleanValueOf(Person person)
                 {
                     return person.hasDrivingLicense();
                 }
             }, new BooleanArrayList());
         
        Specified by:
        collectBoolean in interface RichIterable<K>
        Parameters:
        booleanFunction - a BooleanFunction to use as the collect transformation function
        target - the MutableBooleanCollection to append to for all elements in this RichIterable
        Returns:
        target, which contains appended elements as a result of the collect transformation
      • collectByte

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

        Example using a Java 8 lambda expression:

         ByteIterable bytes =
             people.collectByte(person -> person.getCode());
         

        Example using an anonymous inner class:

         ByteIterable bytes =
             people.collectByte(new ByteFunction<Person>()
             {
                 public byte byteValueOf(Person person)
                 {
                     return person.getCode();
                 }
             });
         
        Specified by:
        collectByte in interface MutableMap<K,​V>
        Specified by:
        collectByte in interface RichIterable<K>
        Specified by:
        collectByte in interface UnsortedMapIterable<K,​V>
      • collectByte

        public <R extends MutableByteCollection> R collectByte​(ByteFunction<? super V> byteFunction,
                                                               R target)
        Description copied from interface: RichIterable
        Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target collection.

        Example using a Java 8 lambda expression:

         ByteArrayList bytes =
             people.collectByte(person -> person.getCode(), new ByteArrayList());
         

        Example using an anonymous inner class:

         ByteArrayList bytes =
             people.collectByte(new ByteFunction<Person>()
             {
                 public byte byteValueOf(Person person)
                 {
                     return person.getCode();
                 }
             }, new ByteArrayList());
         
        Specified by:
        collectByte in interface RichIterable<K>
        Parameters:
        byteFunction - a ByteFunction to use as the collect transformation function
        target - the MutableByteCollection to append to for all elements in this RichIterable
        Returns:
        target, which contains appended elements as a result of the collect transformation
      • collectChar

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

        Example using a Java 8 lambda expression:

         CharIterable chars =
             people.collectChar(person -> person.getMiddleInitial());
         

        Example using an anonymous inner class:

         CharIterable chars =
             people.collectChar(new CharFunction<Person>()
             {
                 public char charValueOf(Person person)
                 {
                     return person.getMiddleInitial();
                 }
             });
         
        Specified by:
        collectChar in interface MutableMap<K,​V>
        Specified by:
        collectChar in interface RichIterable<K>
        Specified by:
        collectChar in interface UnsortedMapIterable<K,​V>
      • collectChar

        public <R extends MutableCharCollection> R collectChar​(CharFunction<? super V> charFunction,
                                                               R target)
        Description copied from interface: RichIterable
        Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target collection.

        Example using a Java 8 lambda expression:

         CharArrayList chars =
             people.collectChar(person -> person.getMiddleInitial(), new CharArrayList());
         

        Example using an anonymous inner class:

         CharArrayList chars =
             people.collectChar(new CharFunction<Person>()
             {
                 public char charValueOf(Person person)
                 {
                     return person.getMiddleInitial();
                 }
             }, new CharArrayList());
         
        Specified by:
        collectChar in interface RichIterable<K>
        Parameters:
        charFunction - a CharFunction to use as the collect transformation function
        target - the MutableCharCollection to append to for all elements in this RichIterable
        Returns:
        target, which contains appended elements as a result of the collect transformation
      • collectDouble

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

        Example using a Java 8 lambda expression:

         DoubleIterable doubles =
             people.collectDouble(person -> person.getMilesFromNorthPole());
         

        Example using an anonymous inner class:

         DoubleIterable doubles =
             people.collectDouble(new DoubleFunction<Person>()
             {
                 public double doubleValueOf(Person person)
                 {
                     return person.getMilesFromNorthPole();
                 }
             });
         
        Specified by:
        collectDouble in interface MutableMap<K,​V>
        Specified by:
        collectDouble in interface RichIterable<K>
        Specified by:
        collectDouble in interface UnsortedMapIterable<K,​V>
      • collectDouble

        public <R extends MutableDoubleCollection> R collectDouble​(DoubleFunction<? super V> doubleFunction,
                                                                   R target)
        Description copied from interface: RichIterable
        Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target collection.

        Example using a Java 8 lambda expression:

         DoubleArrayList doubles =
             people.collectDouble(person -> person.getMilesFromNorthPole(), new DoubleArrayList());
         

        Example using an anonymous inner class:

         DoubleArrayList doubles =
             people.collectDouble(new DoubleFunction<Person>()
             {
                 public double doubleValueOf(Person person)
                 {
                     return person.getMilesFromNorthPole();
                 }
             }, new DoubleArrayList());
         
        Specified by:
        collectDouble in interface RichIterable<K>
        Parameters:
        doubleFunction - a DoubleFunction to use as the collect transformation function
        target - the MutableDoubleCollection to append to for all elements in this RichIterable
        Returns:
        target, which contains appended elements as a result of the collect transformation
      • collectFloat

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

        Example using a Java 8 lambda expression:

         FloatIterable floats =
             people.collectFloat(person -> person.getHeightInInches());
         

        Example using an anonymous inner class:

         FloatIterable floats =
             people.collectFloat(new FloatFunction<Person>()
             {
                 public float floatValueOf(Person person)
                 {
                     return person.getHeightInInches();
                 }
             });
         
        Specified by:
        collectFloat in interface MutableMap<K,​V>
        Specified by:
        collectFloat in interface RichIterable<K>
        Specified by:
        collectFloat in interface UnsortedMapIterable<K,​V>
      • collectFloat

        public <R extends MutableFloatCollection> R collectFloat​(FloatFunction<? super V> floatFunction,
                                                                 R target)
        Description copied from interface: RichIterable
        Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target collection.

        Example using a Java 8 lambda expression:

         FloatArrayList floats =
             people.collectFloat(person -> person.getHeightInInches(), new FloatArrayList());
         

        Example using an anonymous inner class:

         FloatArrayList floats =
             people.collectFloat(new FloatFunction<Person>()
             {
                 public float floatValueOf(Person person)
                 {
                     return person.getHeightInInches();
                 }
             }, new FloatArrayList());
         
        Specified by:
        collectFloat in interface RichIterable<K>
        Parameters:
        floatFunction - a FloatFunction to use as the collect transformation function
        target - the MutableFloatCollection to append to for all elements in this RichIterable
        Returns:
        target, which contains appended elements as a result of the collect transformation
      • collectInt

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

        Example using a Java 8 lambda expression:

         IntIterable ints =
             people.collectInt(person -> person.getAge());
         

        Example using an anonymous inner class:

         IntIterable ints =
             people.collectInt(new IntFunction<Person>()
             {
                 public int intValueOf(Person person)
                 {
                     return person.getAge();
                 }
             });
         
        Specified by:
        collectInt in interface MutableMap<K,​V>
        Specified by:
        collectInt in interface RichIterable<K>
        Specified by:
        collectInt in interface UnsortedMapIterable<K,​V>
      • collectInt

        public <R extends MutableIntCollection> R collectInt​(IntFunction<? super V> intFunction,
                                                             R target)
        Description copied from interface: RichIterable
        Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target collection.

        Example using a Java 8 lambda expression:

         IntArrayList ints =
             people.collectInt(person -> person.getAge(), new IntArrayList());
         

        Example using an anonymous inner class:

         IntArrayList ints =
             people.collectInt(new IntFunction<Person>()
             {
                 public int intValueOf(Person person)
                 {
                     return person.getAge();
                 }
             }, new IntArrayList());
         
        Specified by:
        collectInt in interface RichIterable<K>
        Parameters:
        intFunction - a IntFunction to use as the collect transformation function
        target - the MutableIntCollection to append to for all elements in this RichIterable
        Returns:
        target, which contains appended elements as a result of the collect transformation
      • collectLong

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

        Example using a Java 8 lambda expression:

         LongIterable longs =
             people.collectLong(person -> person.getGuid());
         

        Example using an anonymous inner class:

         LongIterable longs =
             people.collectLong(new LongFunction<Person>()
             {
                 public long longValueOf(Person person)
                 {
                     return person.getGuid();
                 }
             });
         
        Specified by:
        collectLong in interface MutableMap<K,​V>
        Specified by:
        collectLong in interface RichIterable<K>
        Specified by:
        collectLong in interface UnsortedMapIterable<K,​V>
      • collectLong

        public <R extends MutableLongCollection> R collectLong​(LongFunction<? super V> longFunction,
                                                               R target)
        Description copied from interface: RichIterable
        Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target collection.

        Example using a Java 8 lambda expression:

         LongArrayList longs =
             people.collectLong(person -> person.getGuid(), new LongArrayList());
         

        Example using an anonymous inner class:

         LongArrayList longs =
             people.collectLong(new LongFunction<Person>()
             {
                 public long longValueOf(Person person)
                 {
                     return person.getGuid();
                 }
             }, new LongArrayList());
         
        Specified by:
        collectLong in interface RichIterable<K>
        Parameters:
        longFunction - a LongFunction to use as the collect transformation function
        target - the MutableLongCollection to append to for all elements in this RichIterable
        Returns:
        target, which contains appended elements as a result of the collect transformation
      • collectShort

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

        Example using a Java 8 lambda expression:

         ShortIterable shorts =
             people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
         

        Example using an anonymous inner class:

         ShortIterable shorts =
             people.collectShort(new ShortFunction<Person>()
             {
                 public short shortValueOf(Person person)
                 {
                     return person.getNumberOfJunkMailItemsReceivedPerMonth();
                 }
             });
         
        Specified by:
        collectShort in interface MutableMap<K,​V>
        Specified by:
        collectShort in interface RichIterable<K>
        Specified by:
        collectShort in interface UnsortedMapIterable<K,​V>
      • collectShort

        public <R extends MutableShortCollection> R collectShort​(ShortFunction<? super V> shortFunction,
                                                                 R target)
        Description copied from interface: RichIterable
        Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target collection.

        Example using a Java 8 lambda expression:

         ShortArrayList shorts =
             people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth, new ShortArrayList());
         

        Example using an anonymous inner class:

         ShortArrayList shorts =
             people.collectShort(new ShortFunction<Person>()
             {
                 public short shortValueOf(Person person)
                 {
                     return person.getNumberOfJunkMailItemsReceivedPerMonth;
                 }
             }, new ShortArrayList());
         
        Specified by:
        collectShort in interface RichIterable<K>
        Parameters:
        shortFunction - a ShortFunction to use as the collect transformation function
        target - the MutableShortCollection to append to for all elements in this RichIterable
        Returns:
        target, which contains appended elements as a result of the collect transformation
      • collectIf

        public <R> MutableBag<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 optimized equivalent of calling iterable.select(predicate).collect(function).

        Example using a Java 8 lambda and method reference:

         RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);
         

        Example using Predicates factory:

         RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
         
        Specified by:
        collectIf in interface MutableMap<K,​V>
        Specified by:
        collectIf in interface RichIterable<K>
        Specified by:
        collectIf in interface UnsortedMapIterable<K,​V>
      • flatCollect

        public <R> MutableBag<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 = Person::getAddresses;
         RichIterable<Person> people = ...;
         
        Using collect returns a collection of collections of addresses.
         RichIterable<List<Address>> addresses = people.collect(addressFunction);
         
        Using flatCollect returns a single flattened list of addresses.
         RichIterable<Address> addresses = people.flatCollect(addressFunction);
         
        Specified by:
        flatCollect in interface MutableMap<K,​V>
        Specified by:
        flatCollect in interface RichIterable<K>
        Specified by:
        flatCollect in interface UnsortedMapIterable<K,​V>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function
      • select

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

        Example using a Java 8 lambda expression:

         RichIterable<Person> selected =
             people.select(person -> person.getAddress().getCity().equals("London"));
         

        Example using an anonymous inner class:

         RichIterable<Person> selected =
             people.select(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.getAddress().getCity().equals("London");
                 }
             });
         
        Specified by:
        select in interface MutableMap<K,​V>
        Specified by:
        select in interface MutableMapIterable<K,​V>
        Specified by:
        select in interface RichIterable<K>
        Specified by:
        select in interface UnsortedMapIterable<K,​V>
      • select

        public <R extends java.util.Collection<V>> R select​(Predicate<? super V> predicate,
                                                            R target)
        Description copied from interface: RichIterable
        Same as the select method with one parameter but uses the specified target collection for the results.

        Example using a Java 8 lambda expression:

         MutableList<Person> selected =
             people.select(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
         

        Example using an anonymous inner class:

         MutableList<Person> selected =
             people.select(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.person.getLastName().equals("Smith");
                 }
             }, Lists.mutable.empty());
         

        Specified by:
        select in interface RichIterable<K>
        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> MutableBag<V> selectWith​(Predicate2<? super V,​? super P> predicate,
                                            P parameter)
        Description copied from interface: RichIterable
        Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

        E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

        Example using a Java 8 lambda expression:

         RichIterable<Person> selected =
             people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18));
         

        Example using an anonymous inner class:

         RichIterable<Person> selected =
             people.selectWith(new Predicate2<Person, Integer>()
             {
                 public boolean accept(Person person, Integer age)
                 {
                     return person.getAge()>= age;
                 }
             }, Integer.valueOf(18));
         
        Specified by:
        selectWith in interface MutableMap<K,​V>
        Specified by:
        selectWith in interface MutableMapIterable<K,​V>
        Specified by:
        selectWith in interface RichIterable<K>
        Specified by:
        selectWith in interface UnsortedMapIterable<K,​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
        See Also:
        RichIterable.select(Predicate)
      • selectWith

        public <P,​R extends java.util.Collection<V>> R selectWith​(Predicate2<? super V,​? super P> predicate,
                                                                        P parameter,
                                                                        R targetCollection)
        Description copied from interface: RichIterable
        Similar to RichIterable.select(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 an age greater than or equal to 18 years

        Example using a Java 8 lambda expression:

         MutableList<Person> selected =
             people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18), Lists.mutable.empty());
         

        Example using an anonymous inner class:

         MutableList<Person> selected =
             people.selectWith(new Predicate2<Person, Integer>()
             {
                 public boolean accept(Person person, Integer age)
                 {
                     return person.getAge()>= age;
                 }
             }, Integer.valueOf(18), Lists.mutable.empty());
         
        Specified by:
        selectWith in interface RichIterable<K>
        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 MutableBag<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)).

        Example using a Java 8 lambda expression:

         RichIterable<Person> rejected =
             people.reject(person -> person.person.getLastName().equals("Smith"));
         

        Example using an anonymous inner class:

         RichIterable<Person> rejected =
             people.reject(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.person.getLastName().equals("Smith");
                 }
             });
         
        Specified by:
        reject in interface MutableMap<K,​V>
        Specified by:
        reject in interface MutableMapIterable<K,​V>
        Specified by:
        reject in interface RichIterable<K>
        Specified by:
        reject in interface UnsortedMapIterable<K,​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
      • reject

        public <R extends java.util.Collection<V>> R reject​(Predicate<? super V> predicate,
                                                            R target)
        Description copied from interface: RichIterable
        Same as the reject method with one parameter but uses the specified target collection for the results.

        Example using a Java 8 lambda expression:

         MutableList<Person> rejected =
             people.reject(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
         

        Example using an anonymous inner class:

         MutableList<Person> rejected =
             people.reject(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.person.getLastName().equals("Smith");
                 }
             }, Lists.mutable.empty());
         
        Specified by:
        reject in interface RichIterable<K>
        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> MutableBag<V> rejectWith​(Predicate2<? super V,​? super P> predicate,
                                            P parameter)
        Description copied from interface: RichIterable
        Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

        E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

        Example using a Java 8 lambda expression:

         RichIterable<Person> rejected =
             people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
         

        Example using an anonymous inner class:

         MutableList<Person> rejected =
             people.rejectWith(new Predicate2<Person, Integer>()
             {
                 public boolean accept(Person person, Integer age)
                 {
                     return person.getAge() < age;
                 }
             }, Integer.valueOf(18));
         
        Specified by:
        rejectWith in interface MutableMap<K,​V>
        Specified by:
        rejectWith in interface MutableMapIterable<K,​V>
        Specified by:
        rejectWith in interface RichIterable<K>
        Specified by:
        rejectWith in interface UnsortedMapIterable<K,​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
        See Also:
        RichIterable.select(Predicate)
      • rejectWith

        public <P,​R extends java.util.Collection<V>> R rejectWith​(Predicate2<? super V,​? super P> predicate,
                                                                        P parameter,
                                                                        R targetCollection)
        Description copied from interface: 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 an age greater than or equal to 18 years

        Example using a Java 8 lambda expression:

         MutableList<Person> rejected =
             people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18), Lists.mutable.empty());
         

        Example using an anonymous inner class:

         MutableList<Person> rejected =
             people.rejectWith(new Predicate2<Person, Integer>()
             {
                 public boolean accept(Person person, Integer age)
                 {
                     return person.getAge() < age;
                 }
             }, Integer.valueOf(18), Lists.mutable.empty());
         
        Specified by:
        rejectWith in interface RichIterable<K>
        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)
      • partition

        public PartitionMutableBag<V> partition​(Predicate<? super V> predicate)
        Description copied from interface: RichIterable
        Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

        Example using a Java 8 lambda expression:

         PartitionIterable<Person> newYorkersAndNonNewYorkers =
             people.partition(person -> person.getAddress().getState().getName().equals("New York"));
         

        Example using an anonymous inner class:

         PartitionIterable<Person> newYorkersAndNonNewYorkers =
             people.partition(new Predicate<Person>()
             {
                 public boolean accept(Person person)
                 {
                     return person.getAddress().getState().getName().equals("New York");
                 }
             });
         
        Specified by:
        partition in interface MutableMap<K,​V>
        Specified by:
        partition in interface MutableMapIterable<K,​V>
        Specified by:
        partition in interface RichIterable<K>
        Specified by:
        partition in interface UnsortedMapIterable<K,​V>
      • partitionWith

        public <P> PartitionMutableBag<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.

        Example using a Java 8 lambda expression:

         PartitionIterable<Person> newYorkersAndNonNewYorkers =
             people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
         

        Example using an anonymous inner class:

         PartitionIterable<Person> newYorkersAndNonNewYorkers =
             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 MutableMap<K,​V>
        Specified by:
        partitionWith in interface RichIterable<K>
        Specified by:
        partitionWith in interface UnsortedMapIterable<K,​V>
      • zip

        @Deprecated
        public <S> MutableBag<Pair<V,​S>> zip​(java.lang.Iterable<S> that)
        Deprecated.
        in 6.0. Use OrderedIterable.zip(Iterable) instead.
        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 MutableMap<K,​V>
        Specified by:
        zip in interface MutableMapIterable<K,​V>
        Specified by:
        zip in interface RichIterable<K>
        Specified by:
        zip in interface UnsortedMapIterable<K,​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.