Package org.eclipse.collections.impl.bag.mutable

Class AbstractHashBag<T>

    • Constructor Detail

      • AbstractHashBag

        public AbstractHashBag()

    • Method Detail

      • 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));
        Returns:
        updated number of occurrences.

      • equals

        public boolean equals​(java.lang.Object other)
        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()

      • computeHashCode

        protected abstract int computeHashCode​(T item)

      • sizeDistinct

        public int sizeDistinct()
        Description copied from interface: Bag
        The size of the Bag when counting only distinct elements.

      • occurrencesOf

        public int occurrencesOf​(java.lang.Object item)
        Description copied from interface: Bag
        The occurrences of a distinct item in the bag.

      • forEachWithOccurrences

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

      • 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.

      • 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.

      • 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.

      • 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

      • toMapOfItemToCount

        public MutableMap<T,​java.lang.Integer> toMapOfItemToCount()
        Description copied from interface: Bag
        Converts the Bag to a Map of the Item type to its count as an Integer.

      • add

        public boolean add​(T item)

      • remove

        public boolean remove​(java.lang.Object item)

      • clear

        public void clear()

      • each

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

        Example using a Java 8 lambda expression: 

         people.each(person -> LOGGER.info(person.getName()));
        This method is a variant of InternalIterable.forEach(Procedure) that has a signature conflict with Iterable.forEach(java.util.function.Consumer).
        See Also:
        InternalIterable.forEach(Procedure), Iterable.forEach(java.util.function.Consumer)

      • forEachWithIndex

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

        Example using a Java 8 lambda: 

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

        Example using an anonymous inner class: 

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

      • forEachWith

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

        Example using a Java 8 lambda: 

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

        Example using an anonymous inner class: 

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

      • iterator

        public java.util.Iterator<T> iterator()

      • removeOccurrences

        public boolean removeOccurrences​(java.lang.Object item,
                                 int occurrences)

      • setOccurrences

        public boolean setOccurrences​(T item,
                              int occurrences)

      • removeIf

        public boolean removeIf​(Predicate<? super T> predicate)
        Description copied from interface: MutableCollection
        Removes all elements in the collection that evaluate to true for the specified predicate. 
        e.g.
 return lastNames.removeIf(Predicates.isNull());

      • removeIfWith

        public <P> boolean removeIfWith​(Predicate2<? super T,​? super P> predicate,
                                P parameter)
        Description copied from interface: MutableCollection
        Removes all elements in the collection that evaluate to true for the specified predicate2 and parameter. 
         return lastNames.removeIfWith(Predicates2.isNull(), null);

      • removeAllIterable

        public boolean removeAllIterable​(java.lang.Iterable<?> iterable)
        See Also:
        Collection.removeAll(Collection)

      • size

        public int size()
        Description copied from interface: RichIterable
        Returns the number of items in this iterable.

      • contains

        public boolean contains​(java.lang.Object o)
        Description copied from interface: RichIterable
        Returns true if the iterable has an element which responds true to element.equals(object).
        Specified by:
        contains in interface java.util.Collection<T>
        Specified by:
        contains in interface RichIterable<T>
        Overrides:
        contains in class AbstractRichIterable<T>

      • groupBy

        public <V> HashBagMultimap<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);

      • 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.
        Returns:
        an unmodifiable view on the distinct elements of the Bag.