Package org.eclipse.collections.api.bag

Interface ImmutableBag<T>

All Superinterfaces:
Bag<T>, ImmutableBagIterable<T>, ImmutableCollection<T>, InternalIterable<T>, Iterable<T>, RichIterable<T>, UnsortedBag<T>
All Known Implementing Classes:
AbstractImmutableBag, ImmutableArrayBag, ImmutableHashBag
public interface ImmutableBag<T>
extends UnsortedBag<T>, ImmutableBagIterable<T>
Since:
1.0

  • Method Details

    • newWith

      ImmutableBag<T> newWith​(T element)
      Description copied from interface: ImmutableCollection
      This method is similar to the with method in MutableCollection with the difference that a new copy of this collection with the element appended will be returned.
      Specified by:
      newWith in interface ImmutableCollection<T>

    • newWithout

      ImmutableBag<T> newWithout​(T element)
      Description copied from interface: ImmutableCollection
      This method is similar to the without method in MutableCollection with the difference that a new copy of this collection with the element removed will be returned.
      Specified by:
      newWithout in interface ImmutableCollection<T>

    • newWithAll

      ImmutableBag<T> newWithAll​(Iterable<? extends T> elements)
      Description copied from interface: ImmutableCollection
      This method is similar to the withAll method in MutableCollection with the difference that a new copy of this collection with the elements appended will be returned.
      Specified by:
      newWithAll in interface ImmutableCollection<T>

    • newWithoutAll

      ImmutableBag<T> newWithoutAll​(Iterable<? extends T> elements)
      Description copied from interface: ImmutableCollection
      This method is similar to the withoutAll method in MutableCollection with the difference that a new copy of this collection with the elements removed will be returned.
      Specified by:
      newWithoutAll in interface ImmutableCollection<T>

    • selectByOccurrences

      ImmutableBag<T> selectByOccurrences​(IntPredicate predicate)
      Description copied from interface: Bag
      Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
      Specified by:
      selectByOccurrences in interface Bag<T>
      Specified by:
      selectByOccurrences in interface ImmutableBagIterable<T>
      Specified by:
      selectByOccurrences in interface UnsortedBag<T>

    • selectDuplicates

      default ImmutableBag<T> selectDuplicates()
      Description copied from interface: Bag
      Returns all elements of the bag that have more than one occurrence.
      Specified by:
      selectDuplicates in interface Bag<T>
      Specified by:
      selectDuplicates in interface ImmutableBagIterable<T>
      Specified by:
      selectDuplicates in interface UnsortedBag<T>
      Since:
      9.2

    • selectUnique

      default ImmutableSet<T> selectUnique()
      Description copied from interface: Bag
      Returns a set containing all elements of the bag that have exactly one occurrence.
      Specified by:
      selectUnique in interface Bag<T>
      Specified by:
      selectUnique in interface ImmutableBagIterable<T>
      Specified by:
      selectUnique in interface UnsortedBag<T>
      Since:
      9.2

    • tap

      ImmutableBag<T> tap​(Procedure<? super T> procedure)
      Description copied from interface: RichIterable
      Executes the Procedure for each element in the iterable and returns this.

      Example using a Java 8 lambda expression: 

       RichIterable<Person> tapped =
     people.tap(person -> LOGGER.info(person.getName()));

      Example using an anonymous inner class: 

       RichIterable<Person> tapped =
     people.tap(new Procedure<Person>()
     {
         public void value(Person person)
         {
             LOGGER.info(person.getName());
         }
     });
      Specified by:
      tap in interface Bag<T>
      Specified by:
      tap in interface ImmutableBagIterable<T>
      Specified by:
      tap in interface ImmutableCollection<T>
      Specified by:
      tap in interface RichIterable<T>
      Specified by:
      tap in interface UnsortedBag<T>
      See Also:
      RichIterable.each(Procedure), RichIterable.forEach(Procedure)

    • select

      ImmutableBag<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 ImmutableBagIterable<T>
      Specified by:
      select in interface ImmutableCollection<T>
      Specified by:
      select in interface RichIterable<T>
      Specified by:
      select in interface UnsortedBag<T>

    • selectWith

      <P> ImmutableBag<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 ImmutableBagIterable<T>
      Specified by:
      selectWith in interface ImmutableCollection<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)

    • reject

      ImmutableBag<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 ImmutableBagIterable<T>
      Specified by:
      reject in interface ImmutableCollection<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

      <P> ImmutableBag<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 ImmutableBagIterable<T>
      Specified by:
      rejectWith in interface ImmutableCollection<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)

    • partition

      PartitionImmutableBag<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 ImmutableBagIterable<T>
      Specified by:
      partition in interface ImmutableCollection<T>
      Specified by:
      partition in interface RichIterable<T>
      Specified by:
      partition in interface UnsortedBag<T>

    • partitionWith

      <P> PartitionImmutableBag<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 ImmutableBagIterable<T>
      Specified by:
      partitionWith in interface ImmutableCollection<T>
      Specified by:
      partitionWith in interface RichIterable<T>

    • selectInstancesOf

      <S> ImmutableBag<S> selectInstancesOf​(Class<S> clazz)
      Description copied from interface: RichIterable
      Returns all elements of the source collection that are instances of the Class clazz. 
       RichIterable<Integer> integers =
     List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
      Specified by:
      selectInstancesOf in interface Bag<T>
      Specified by:
      selectInstancesOf in interface ImmutableBagIterable<T>
      Specified by:
      selectInstancesOf in interface ImmutableCollection<T>
      Specified by:
      selectInstancesOf in interface RichIterable<T>
      Specified by:
      selectInstancesOf in interface UnsortedBag<T>

    • collect

      <V> ImmutableBag<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 ImmutableCollection<T>
      Specified by:
      collect in interface RichIterable<T>
      Specified by:
      collect in interface UnsortedBag<T>

    • collectBoolean

      ImmutableBooleanBag 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 ImmutableCollection<T>
      Specified by:
      collectBoolean in interface RichIterable<T>
      Specified by:
      collectBoolean in interface UnsortedBag<T>

    • collectByte

      ImmutableByteBag 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 ImmutableCollection<T>
      Specified by:
      collectByte in interface RichIterable<T>
      Specified by:
      collectByte in interface UnsortedBag<T>

    • collectChar

      ImmutableCharBag 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 ImmutableCollection<T>
      Specified by:
      collectChar in interface RichIterable<T>
      Specified by:
      collectChar in interface UnsortedBag<T>

    • collectDouble

      ImmutableDoubleBag 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 ImmutableCollection<T>
      Specified by:
      collectDouble in interface RichIterable<T>
      Specified by:
      collectDouble in interface UnsortedBag<T>

    • collectFloat

      ImmutableFloatBag 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 ImmutableCollection<T>
      Specified by:
      collectFloat in interface RichIterable<T>
      Specified by:
      collectFloat in interface UnsortedBag<T>

    • collectInt

      ImmutableIntBag 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 ImmutableCollection<T>
      Specified by:
      collectInt in interface RichIterable<T>
      Specified by:
      collectInt in interface UnsortedBag<T>

    • collectLong

      ImmutableLongBag 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 ImmutableCollection<T>
      Specified by:
      collectLong in interface RichIterable<T>
      Specified by:
      collectLong in interface UnsortedBag<T>

    • collectShort

      ImmutableShortBag 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 ImmutableCollection<T>
      Specified by:
      collectShort in interface RichIterable<T>
      Specified by:
      collectShort in interface UnsortedBag<T>

    • collectWith

      <P,​ V> ImmutableBag<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 ImmutableCollection<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)

    • collectIf

      <V> ImmutableBag<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 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 ImmutableCollection<T>
      Specified by:
      collectIf in interface RichIterable<T>
      Specified by:
      collectIf in interface UnsortedBag<T>

    • collectWithOccurrences

      <V> ImmutableBag<V> collectWithOccurrences​(ObjectIntToObjectFunction<? super T,​? extends V> function)
      Description copied from interface: Bag
      Iterates over the unique elements and their occurrences and collects the results of applying the specified function.
      Specified by:
      collectWithOccurrences in interface Bag<T>
      Specified by:
      collectWithOccurrences in interface ImmutableBagIterable<T>
      Specified by:
      collectWithOccurrences in interface UnsortedBag<T>

    • flatCollect

      <V> ImmutableBag<V> flatCollect​(Function<? super T,​? extends 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 ImmutableCollection<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

    • flatCollectWith

      default <P,​ V> ImmutableBag<V> flatCollectWith​(Function2<? super T,​? super P,​? extends Iterable<V>> function, P parameter)
      Specified by:
      flatCollectWith in interface ImmutableCollection<T>
      Specified by:
      flatCollectWith in interface RichIterable<T>
      Specified by:
      flatCollectWith in interface UnsortedBag<T>
      Since:
      9.2

    • countBy

      default <V> ImmutableBag<V> countBy​(Function<? super T,​? extends V> function)
      Description copied from interface: RichIterable
      This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
      Specified by:
      countBy in interface ImmutableCollection<T>
      Specified by:
      countBy in interface RichIterable<T>
      Since:
      9.0

    • countByWith

      default <V,​ P> ImmutableBag<V> countByWith​(Function2<? super T,​? super P,​? extends V> function, P parameter)
      Description copied from interface: RichIterable
      This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.
      Specified by:
      countByWith in interface ImmutableCollection<T>
      Specified by:
      countByWith in interface RichIterable<T>
      Since:
      9.0

    • countByEach

      default <V> ImmutableBag<V> countByEach​(Function<? super T,​? extends Iterable<V>> function)
      Description copied from interface: RichIterable
      This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
      Specified by:
      countByEach in interface ImmutableCollection<T>
      Specified by:
      countByEach in interface RichIterable<T>
      Since:
      10.0.0

    • groupBy

      <V> ImmutableBagMultimap<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 ImmutableBagIterable<T>
      Specified by:
      groupBy in interface ImmutableCollection<T>
      Specified by:
      groupBy in interface RichIterable<T>
      Specified by:
      groupBy in interface UnsortedBag<T>

    • groupByEach

      <V> ImmutableBagMultimap<V,​T> groupByEach​(Function<? super T,​? extends Iterable<V>> function)
      Description copied from interface: RichIterable
      Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
      Specified by:
      groupByEach in interface Bag<T>
      Specified by:
      groupByEach in interface ImmutableBagIterable<T>
      Specified by:
      groupByEach in interface ImmutableCollection<T>
      Specified by:
      groupByEach in interface RichIterable<T>
      Specified by:
      groupByEach in interface UnsortedBag<T>

    • zip

      @Deprecated <S> ImmutableBag<Pair<T,​S>> zip​(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 ImmutableCollection<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.

    • zipWithIndex

      @Deprecated ImmutableSet<Pair<T,​Integer>> zipWithIndex()
      Deprecated.
      in 6.0. Use OrderedIterable.zipWithIndex() instead.
      Description copied from interface: RichIterable
      Zips this RichIterable with its indices.
      Specified by:
      zipWithIndex in interface Bag<T>
      Specified by:
      zipWithIndex in interface ImmutableBagIterable<T>
      Specified by:
      zipWithIndex in interface ImmutableCollection<T>
      Specified by:
      zipWithIndex in interface RichIterable<T>
      Specified by:
      zipWithIndex in interface UnsortedBag<T>
      Returns:
      A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.
      See Also:
      RichIterable.zip(Iterable)

    • topOccurrences

      ImmutableList<ObjectIntPair<T>> topOccurrences​(int count)
      Description copied from interface: Bag
      Returns the count most 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:
      topOccurrences in interface Bag<T>
      Since:
      6.0

    • bottomOccurrences

      ImmutableList<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>
      Since:
      6.0