Class AbstractBag<T>

    • Constructor Detail

      • AbstractBag

        public AbstractBag()
    • Method Detail

      • toArray

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

        public <E> E[] toArray​(E[] array)
        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 java.util.Collection<T>
        Specified by:
        toArray in interface RichIterable<T>
        See Also:
        Collection.toArray(Object[])
      • select

        public <R extends java.util.Collection<T>> R select​(Predicate<? super T> 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());
         

        Specified by:
        select in interface RichIterable<T>
        Overrides:
        select in class AbstractRichIterable<T>
        Parameters:
        predicate - a Predicate to use as the select criteria
        target - the Collection to append to for all elements in this RichIterable that meet select criteria predicate
        Returns:
        target, which contains appended elements as a result of the select criteria
        See Also:
        RichIterable.select(Predicate)
      • selectWith

        public <P,​R extends java.util.Collection<T>> R selectWith​(Predicate2<? super T,​? super P> predicate,
                                                                        P parameter,
                                                                        R target)
        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());
         
        Specified by:
        selectWith in interface RichIterable<T>
        Overrides:
        selectWith in class AbstractRichIterable<T>
        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
        target - the Collection to append to for all elements in this RichIterable that meet select criteria predicate
        Returns:
        targetCollection, which contains appended elements as a result of the select criteria
        See Also:
        RichIterable.select(Predicate), RichIterable.select(Predicate, Collection)
      • reject

        public <R extends java.util.Collection<T>> R reject​(Predicate<? super T> 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());
         
        Specified by:
        reject in interface RichIterable<T>
        Overrides:
        reject in class AbstractRichIterable<T>
        Parameters:
        predicate - a Predicate to use as the reject criteria
        target - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false
        Returns:
        target, which contains appended elements as a result of the reject criteria
      • rejectWith

        public <P,​R extends java.util.Collection<T>> R rejectWith​(Predicate2<? super T,​? super P> predicate,
                                                                        P parameter,
                                                                        R target)
        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());
         
        Specified by:
        rejectWith in interface RichIterable<T>
        Overrides:
        rejectWith in class AbstractRichIterable<T>
        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
        target - 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)
      • count

        public int count​(Predicate<? super T> 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"));
         
        Specified by:
        count in interface RichIterable<T>
        Overrides:
        count in class AbstractRichIterable<T>
      • collect

        public <V,​R extends java.util.Collection<V>> R collect​(Function<? super T,​? extends V> function,
                                                                     R 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());
         
        Specified by:
        collect in interface RichIterable<T>
        Overrides:
        collect in class AbstractRichIterable<T>
        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)
      • collectWith

        public <P,​V,​R extends java.util.Collection<V>> R collectWith​(Function2<? super T,​? super P,​? extends V> function,
                                                                                 P parameter,
                                                                                 R target)
        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());
         
        Specified by:
        collectWith in interface RichIterable<T>
        Overrides:
        collectWith in class AbstractRichIterable<T>
        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
        target - 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
      • collectIf

        public <V,​R extends java.util.Collection<V>> R collectIf​(Predicate<? super T> predicate,
                                                                       Function<? super T,​? extends V> function,
                                                                       R 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<T>
        Overrides:
        collectIf in class AbstractRichIterable<T>
        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)
      • flatCollect

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

        public <R extends MutableBooleanCollection> R collectBoolean​(BooleanFunction<? super T> 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());
         
        Specified by:
        collectBoolean in interface RichIterable<T>
        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 <R extends MutableByteCollection> R collectByte​(ByteFunction<? super T> 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());
         
        Specified by:
        collectByte in interface RichIterable<T>
        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 <R extends MutableCharCollection> R collectChar​(CharFunction<? super T> 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());
         
        Specified by:
        collectChar in interface RichIterable<T>
        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 <R extends MutableDoubleCollection> R collectDouble​(DoubleFunction<? super T> 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());
         
        Specified by:
        collectDouble in interface RichIterable<T>
        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 <R extends MutableFloatCollection> R collectFloat​(FloatFunction<? super T> 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());
         
        Specified by:
        collectFloat in interface RichIterable<T>
        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 <R extends MutableIntCollection> R collectInt​(IntFunction<? super T> 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());
         
        Specified by:
        collectInt in interface RichIterable<T>
        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 <R extends MutableLongCollection> R collectLong​(LongFunction<? super T> 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());
         
        Specified by:
        collectLong in interface RichIterable<T>
        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 <R extends MutableShortCollection> R collectShort​(ShortFunction<? super T> 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());
         
        Specified by:
        collectShort in interface RichIterable<T>
        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
      • sumOfFloat

        public double sumOfFloat​(FloatFunction<? super T> 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<T>
        Overrides:
        sumOfFloat in class AbstractRichIterable<T>
      • sumOfDouble

        public double sumOfDouble​(DoubleFunction<? super T> 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<T>
        Overrides:
        sumOfDouble in class AbstractRichIterable<T>
      • injectInto

        public <IV> IV injectInto​(IV injectedValue,
                                  Function2<? super IV,​? super T,​? 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<T>
        Overrides:
        injectInto in class AbstractRichIterable<T>
      • injectInto

        public int injectInto​(int injectedValue,
                              IntObjectToIntFunction<? super T> 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<T>
        Overrides:
        injectInto in class AbstractRichIterable<T>
      • injectInto

        public long injectInto​(long injectedValue,
                               LongObjectToLongFunction<? super T> 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<T>
        Overrides:
        injectInto in class AbstractRichIterable<T>
      • injectInto

        public double injectInto​(double injectedValue,
                                 DoubleObjectToDoubleFunction<? super T> 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<T>
        Overrides:
        injectInto in class AbstractRichIterable<T>
      • injectInto

        public float injectInto​(float injectedValue,
                                FloatObjectToFloatFunction<? super T> 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<T>
        Overrides:
        injectInto in class AbstractRichIterable<T>
      • injectIntoWith

        public <IV,​P> IV injectIntoWith​(IV injectedValue,
                                              Function3<? super IV,​? super T,​? super P,​? extends IV> function,
                                              P parameter)
      • toStringOfItemToCount

        public java.lang.String toStringOfItemToCount()
        Description copied from interface: Bag
        Returns a string representation of this bag. The string representation consists of a list of element-count mappings.
         Assert.assertEquals("{1=1, 2=2, 3=3}", Bags.mutable.with(1, 2, 2, 3, 3, 3).toStringOfItemToCount());
         
        This string representation is similar to AbstractMap.toString(), not RichIterable.toString(), whereas the toString() implementation for a Bag is consistent with RichIterable.toString().
        Specified by:
        toStringOfItemToCount in interface Bag<T>
        Returns:
        a string representation of this bag
      • toSortedList

        public MutableList<T> toSortedList​(java.util.Comparator<? super T> 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<T>