Class MultiReaderHashBag<T>

  • All Implemented Interfaces:
    java.io.Externalizable, java.io.Serializable, java.lang.Iterable<T>, java.util.Collection<T>, Bag<T>, MultiReaderBag<T>, MutableBag<T>, MutableBagIterable<T>, UnsortedBag<T>, MutableCollection<T>, InternalIterable<T>, RichIterable<T>

    public final class MultiReaderHashBag<T>
    extends AbstractMultiReaderMutableCollection<T>
    implements java.io.Externalizable, MultiReaderBag<T>
    MultiReaderHashBag provides a thread-safe wrapper around a HashBag, using a ReentrantReadWriteLock. In order to provide true thread-safety, MultiReaderHashBag does not implement iterator() as this method requires an external lock to be taken to provide thread-safe iteration. All of these methods are available however, if you use the withReadLockAndDelegate() or withWriteLockAndDelegate() methods. Both of these methods take a parameter of type Procedure<MutableBag>, and a wrapped version of the underlying HashBag is returned. This wrapper guarantees that no external pointer can ever reference the underlying HashBag outside a locked procedure. In the case of the read lock method, an Unmodifiable version of the collection is offered, which will throw UnsupportedOperationExceptions on any write methods like add or remove.
    See Also:
    Serialized Form
    • Constructor Detail

      • MultiReaderHashBag

        @Deprecated
        public MultiReaderHashBag()
        Deprecated.
        Empty default constructor used for serialization.
      • MultiReaderHashBag

        private MultiReaderHashBag​(MutableBag<T> newDelegate)
      • MultiReaderHashBag

        private MultiReaderHashBag​(MutableBag<T> newDelegate,
                                   java.util.concurrent.locks.ReadWriteLock newLock)
    • Method Detail

      • newBag

        public static <T> MultiReaderHashBag<T> newBag​(java.lang.Iterable<T> iterable)
      • asSynchronized

        public MutableBag<T> asSynchronized()
        Description copied from interface: MutableCollection
        Returns a synchronized wrapper backed by this collection. This is the equivalent of using Collections.synchronizedCollection(this) only with a return type that supports the full iteration protocols available on MutableCollection. The preferred way of iterating over a synchronized collection is to use the internal iteration methods which are properly synchronized internally.
          MutableCollection synchedCollection = collection.asSynchronized();
             ...
          synchedCollection.forEach(each -> ... );
          synchedCollection.select(each -> ... );
          synchedCollection.collect(each -> ... );
         
        If you want to iterate using an imperative style, you must protect external iterators using a synchronized block. This includes explicit iterators as well as JDK 5 style for loops.

        Specified by:
        asSynchronized in interface MutableBag<T>
        Specified by:
        asSynchronized in interface MutableCollection<T>
        Returns:
        a synchronized view of this collection.
        See Also:
        Collections.synchronizedCollection(Collection)
      • asUnmodifiable

        public MutableBag<T> asUnmodifiable()
        Description copied from interface: MutableCollection
        Returns an unmodifiable view of this collection. This is the equivalent of using Collections.unmodifiableCollection(this) with a return type that supports the full iteration protocols available on MutableCollection. Methods which would mutate the underlying collection will throw UnsupportedOperationExceptions.
        Specified by:
        asUnmodifiable in interface MutableBag<T>
        Specified by:
        asUnmodifiable in interface MutableCollection<T>
        Returns:
        an unmodifiable view of this collection.
        See Also:
        Collections.unmodifiableCollection(Collection)
      • addOccurrences

        public int addOccurrences​(T item,
                                  int occurrences)
        Description copied from interface: MutableBagIterable
        Add number of occurrences for an item. If the item does not exist, then the item is added to the bag.

        For Example:

         MutableBagIterable<String> names = Bags.mutable.of("A", "B", "B");
         Assert.assertEquals(4, names.addOccurrences("A", 3));
         
        Specified by:
        addOccurrences in interface MutableBagIterable<T>
        Returns:
        updated number of occurrences.
      • occurrencesOf

        public int occurrencesOf​(java.lang.Object item)
        Description copied from interface: Bag
        The occurrences of a distinct item in the bag.
        Specified by:
        occurrencesOf in interface Bag<T>
      • sizeDistinct

        public int sizeDistinct()
        Description copied from interface: Bag
        The size of the Bag when counting only distinct elements.
        Specified by:
        sizeDistinct in interface Bag<T>
      • collect

        public <V> MutableBag<V> collect​(Function<? super T,​? extends V> 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 MutableBag<T>
        Specified by:
        collect in interface MutableCollection<T>
        Specified by:
        collect in interface RichIterable<T>
        Specified by:
        collect in interface UnsortedBag<T>
      • collectBoolean

        public MutableBooleanBag collectBoolean​(BooleanFunction<? super T> 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 MutableBag<T>
        Specified by:
        collectBoolean in interface MutableCollection<T>
        Specified by:
        collectBoolean in interface RichIterable<T>
        Specified by:
        collectBoolean in interface UnsortedBag<T>
      • collectByte

        public MutableByteBag collectByte​(ByteFunction<? super T> 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 MutableBag<T>
        Specified by:
        collectByte in interface MutableCollection<T>
        Specified by:
        collectByte in interface RichIterable<T>
        Specified by:
        collectByte in interface UnsortedBag<T>
      • collectChar

        public MutableCharBag collectChar​(CharFunction<? super T> 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 MutableBag<T>
        Specified by:
        collectChar in interface MutableCollection<T>
        Specified by:
        collectChar in interface RichIterable<T>
        Specified by:
        collectChar in interface UnsortedBag<T>
      • collectDouble

        public MutableDoubleBag collectDouble​(DoubleFunction<? super T> 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 MutableBag<T>
        Specified by:
        collectDouble in interface MutableCollection<T>
        Specified by:
        collectDouble in interface RichIterable<T>
        Specified by:
        collectDouble in interface UnsortedBag<T>
      • collectFloat

        public MutableFloatBag collectFloat​(FloatFunction<? super T> 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 MutableBag<T>
        Specified by:
        collectFloat in interface MutableCollection<T>
        Specified by:
        collectFloat in interface RichIterable<T>
        Specified by:
        collectFloat in interface UnsortedBag<T>
      • collectInt

        public MutableIntBag collectInt​(IntFunction<? super T> 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 MutableBag<T>
        Specified by:
        collectInt in interface MutableCollection<T>
        Specified by:
        collectInt in interface RichIterable<T>
        Specified by:
        collectInt in interface UnsortedBag<T>
      • collectLong

        public MutableLongBag collectLong​(LongFunction<? super T> 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 MutableBag<T>
        Specified by:
        collectLong in interface MutableCollection<T>
        Specified by:
        collectLong in interface RichIterable<T>
        Specified by:
        collectLong in interface UnsortedBag<T>
      • collectShort

        public MutableShortBag collectShort​(ShortFunction<? super T> 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 MutableBag<T>
        Specified by:
        collectShort in interface MutableCollection<T>
        Specified by:
        collectShort in interface RichIterable<T>
        Specified by:
        collectShort in interface UnsortedBag<T>
      • flatCollect

        public <V> MutableBag<V> flatCollect​(Function<? super T,​? extends java.lang.Iterable<V>> 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 MutableBag<T>
        Specified by:
        flatCollect in interface MutableCollection<T>
        Specified by:
        flatCollect in interface RichIterable<T>
        Specified by:
        flatCollect in interface UnsortedBag<T>
        Parameters:
        function - The Function to apply
        Returns:
        a new flattened collection produced by applying the given function
      • topOccurrences

        public MutableList<ObjectIntPair<T>> topOccurrences​(int count)
        Description copied from interface: Bag
        Returns the count most frequently occurring items. In the event of a tie, all the items with the number of occurrences that match the occurrences of the last item will be returned.
        Specified by:
        topOccurrences in interface Bag<T>
        Specified by:
        topOccurrences in interface MutableBagIterable<T>
      • bottomOccurrences

        public MutableList<ObjectIntPair<T>> bottomOccurrences​(int count)
        Description copied from interface: Bag
        Returns the count least frequently occurring items. In the event of a tie, all of the items with the number of occurrences that match the occurrences of the last item will be returned.
        Specified by:
        bottomOccurrences in interface Bag<T>
        Specified by:
        bottomOccurrences in interface MutableBagIterable<T>
      • collectIf

        public <V> MutableBag<V> collectIf​(Predicate<? super T> predicate,
                                           Function<? super T,​? extends V> 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 MutableBag<T>
        Specified by:
        collectIf in interface MutableCollection<T>
        Specified by:
        collectIf in interface RichIterable<T>
        Specified by:
        collectIf in interface UnsortedBag<T>
      • collectWithOccurrences

        public <V,​R extends java.util.Collection<V>> R collectWithOccurrences​(ObjectIntToObjectFunction<? super T,​? extends V> function,
                                                                                    R target)
        Description copied from interface: Bag
        Iterates over the unique elements and their occurrences and collects the results of applying the specified function into the target collection.
        Specified by:
        collectWithOccurrences in interface Bag<T>
      • collectWith

        public <P,​V> MutableBag<V> collectWith​(Function2<? super T,​? super P,​? extends V> 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 MutableBag<T>
        Specified by:
        collectWith in interface MutableCollection<T>
        Specified by:
        collectWith in interface RichIterable<T>
        Specified by:
        collectWith in interface UnsortedBag<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
        Returns:
        A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)
        See Also:
        RichIterable.collect(Function)
      • newEmpty

        public MutableBag<T> newEmpty()
        Description copied from interface: MutableCollection
        Creates a new empty mutable version of the same collection type. For example, if this instance is a FastList, this method will return a new empty FastList. If the class of this instance is immutable or fixed size (i.e. SingletonList) then a mutable alternative to the class will be provided.
        Specified by:
        newEmpty in interface MutableBag<T>
        Specified by:
        newEmpty in interface MutableCollection<T>
      • reject

        public MutableBag<T> reject​(Predicate<? super T> 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 Bag<T>
        Specified by:
        reject in interface MutableBag<T>
        Specified by:
        reject in interface MutableBagIterable<T>
        Specified by:
        reject in interface MutableCollection<T>
        Specified by:
        reject in interface RichIterable<T>
        Specified by:
        reject in interface UnsortedBag<T>
        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
      • rejectWith

        public <P> MutableBag<T> rejectWith​(Predicate2<? super T,​? 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 Bag<T>
        Specified by:
        rejectWith in interface MutableBag<T>
        Specified by:
        rejectWith in interface MutableBagIterable<T>
        Specified by:
        rejectWith in interface MutableCollection<T>
        Specified by:
        rejectWith in interface RichIterable<T>
        Specified by:
        rejectWith in interface UnsortedBag<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
        See Also:
        RichIterable.select(Predicate)
      • select

        public MutableBag<T> select​(Predicate<? super T> 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 Bag<T>
        Specified by:
        select in interface MutableBag<T>
        Specified by:
        select in interface MutableBagIterable<T>
        Specified by:
        select in interface MutableCollection<T>
        Specified by:
        select in interface RichIterable<T>
        Specified by:
        select in interface UnsortedBag<T>
      • selectWith

        public <P> MutableBag<T> selectWith​(Predicate2<? super T,​? 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 Bag<T>
        Specified by:
        selectWith in interface MutableBag<T>
        Specified by:
        selectWith in interface MutableBagIterable<T>
        Specified by:
        selectWith in interface MutableCollection<T>
        Specified by:
        selectWith in interface RichIterable<T>
        Specified by:
        selectWith in interface UnsortedBag<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
        See Also:
        RichIterable.select(Predicate)
      • partition

        public PartitionMutableBag<T> partition​(Predicate<? super T> 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 Bag<T>
        Specified by:
        partition in interface MutableBag<T>
        Specified by:
        partition in interface MutableBagIterable<T>
        Specified by:
        partition in interface MutableCollection<T>
        Specified by:
        partition in interface RichIterable<T>
        Specified by:
        partition in interface UnsortedBag<T>
      • partitionWith

        public <P> PartitionMutableBag<T> partitionWith​(Predicate2<? super T,​? 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 Bag<T>
        Specified by:
        partitionWith in interface MutableBag<T>
        Specified by:
        partitionWith in interface MutableBagIterable<T>
        Specified by:
        partitionWith in interface MutableCollection<T>
        Specified by:
        partitionWith in interface RichIterable<T>
      • 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
      • groupBy

        public <V> MutableBagMultimap<V,​T> groupBy​(Function<? super T,​? extends V> 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 Bag<T>
        Specified by:
        groupBy in interface MutableBag<T>
        Specified by:
        groupBy in interface MutableBagIterable<T>
        Specified by:
        groupBy in interface MutableCollection<T>
        Specified by:
        groupBy in interface RichIterable<T>
        Specified by:
        groupBy in interface UnsortedBag<T>
      • zip

        @Deprecated
        public <S> MutableBag<Pair<T,​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 MutableBag<T>
        Specified by:
        zip in interface MutableCollection<T>
        Specified by:
        zip in interface RichIterable<T>
        Specified by:
        zip in interface UnsortedBag<T>
        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.
      • chunk

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

        public boolean anySatisfyWithOccurrences​(ObjectIntPredicate<? super T> predicate)
        Description copied from interface: Bag
        Returns true if the predicate evaluates to true for any element of the Bag. Returns false if the Bag is empty or if no element returns true for the predicate.
        Specified by:
        anySatisfyWithOccurrences in interface Bag<T>
      • allSatisfyWithOccurrences

        public boolean allSatisfyWithOccurrences​(ObjectIntPredicate<? super T> predicate)
        Description copied from interface: Bag
        Returns true if the predicate evaluates to true for all elements of the Bag. Returns false if the Bag is empty or if not all elements return true for the predicate.
        Specified by:
        allSatisfyWithOccurrences in interface Bag<T>
      • noneSatisfyWithOccurrences

        public boolean noneSatisfyWithOccurrences​(ObjectIntPredicate<? super T> predicate)
        Description copied from interface: Bag
        Returns true if the Bag is empty or if the predicate evaluates to false for all elements of the Bag. Returns false if the predicate evaluates to true for at least one element of the Bag.
        Specified by:
        noneSatisfyWithOccurrences in interface Bag<T>
      • detectWithOccurrences

        public T detectWithOccurrences​(ObjectIntPredicate<? super T> predicate)
        Description copied from interface: Bag
        Returns an element of the Bag that satisfies the predicate or null if such an element does not exist
        Specified by:
        detectWithOccurrences in interface Bag<T>
      • forEachWithOccurrences

        public void forEachWithOccurrences​(ObjectIntProcedure<? super T> procedure)
        Description copied from interface: Bag
        For each distinct item, with the number of occurrences, execute the specified procedure.
        Specified by:
        forEachWithOccurrences in interface Bag<T>
      • equals

        public boolean equals​(java.lang.Object o)
        Description copied from interface: Bag
        Two bags b1 and b2 are equal if m1.toMapOfItemToCount().equals(m2.toMapOfItemToCount()).
        Specified by:
        equals in interface Bag<T>
        Specified by:
        equals in interface java.util.Collection<T>
        Overrides:
        equals in class java.lang.Object
        See Also:
        Map.equals(Object)
      • hashCode

        public int hashCode()
        Description copied from interface: Bag
        Returns the hash code for this Bag, defined as this.Bag.toMapOfItemToCount().hashCode().
        Specified by:
        hashCode in interface Bag<T>
        Specified by:
        hashCode in interface java.util.Collection<T>
        Overrides:
        hashCode in class java.lang.Object
        See Also:
        Map.hashCode()
      • writeExternal

        public void writeExternal​(java.io.ObjectOutput out)
                           throws java.io.IOException
        Specified by:
        writeExternal in interface java.io.Externalizable
        Throws:
        java.io.IOException
      • readExternal

        public void readExternal​(java.io.ObjectInput in)
                          throws java.io.IOException,
                                 java.lang.ClassNotFoundException
        Specified by:
        readExternal in interface java.io.Externalizable
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException
      • distinctView

        public RichIterable<T> distinctView()
        Description copied from interface: Bag
        Returns an unmodifiable view on the distinct elements with the same complexity as the Bag implementation.
        Specified by:
        distinctView in interface Bag<T>
        Returns:
        an unmodifiable view on the distinct elements of the Bag.