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

Class TreeBag<T>

    • Constructor Detail

      • TreeBag

        public TreeBag()

      • TreeBag

        public TreeBag​(java.util.Comparator<? super T> comparator)

      • TreeBag

        public TreeBag​(SortedBag<T> sortedBag)

      • TreeBag

        public TreeBag​(java.util.Comparator<? super T> comparator,
               java.lang.Iterable<? extends T> iterable)

    • Method Detail

      • newBag

        public static <E> TreeBag<E> newBag()

      • newBag

        public static <E> TreeBag<E> newBag​(java.util.Comparator<? super E> comparator)

      • newBag

        public static <E> TreeBag<E> newBag​(java.lang.Iterable<? extends E> source)

      • newBag

        public static <E> TreeBag<E> newBag​(java.util.Comparator<? super E> comparator,
                                    java.lang.Iterable<? extends E> iterable)

      • newBagWith

        public static <E> TreeBag<E> newBagWith​(E... elements)

      • newBagWith

        public static <E> TreeBag<E> newBagWith​(java.util.Comparator<? super E> comparator,
                                        E... elements)

      • 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()

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

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

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

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

      • remove

        public boolean remove​(java.lang.Object item)
        Specified by:
        remove in interface java.util.Collection<T>

      • clear

        public void clear()
        Specified by:
        clear in interface java.util.Collection<T>

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

      • compareTo

        public int compareTo​(SortedBag<T> otherBag)
        Specified by:
        compareTo in interface java.lang.Comparable<T>

      • 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

      • 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).
        Specified by:
        each in interface RichIterable<T>
        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>
        Specified by:
        forEachWithIndex in interface OrderedIterable<T>
        Overrides:
        forEachWithIndex in class AbstractRichIterable<T>

      • forEach

        public void forEach​(int fromIndex,
                    int toIndex,
                    Procedure<? super T> procedure)
        Description copied from interface: OrderedIterable
        Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive. 
        e.g.
 OrderedIterable<Person> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEach(0, 1, person -> LOGGER.info(person.getName()));

        This code would output ted and mary's names.

        Specified by:
        forEach in interface OrderedIterable<T>

      • forEachWithIndex

        public void forEachWithIndex​(int fromIndex,
                             int toIndex,
                             ObjectIntProcedure<? super T> objectIntProcedure)
        Description copied from interface: OrderedIterable
        Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive. 
        e.g.
 OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEachWithIndex(0, 1, (person, index) -> LOGGER.info(person.getName()));

        This code would output ted and mary's names.

        Specified by:
        forEachWithIndex in interface OrderedIterable<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()
        Specified by:
        iterator in interface java.util.Collection<T>
        Specified by:
        iterator in interface java.lang.Iterable<T>

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

      • without

        public TreeBag<T> without​(T element)
        Description copied from interface: MutableCollection
        This method allows mutable and fixed size collections the ability to remove elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling remove. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
         MutableCollection<String> list = list.without("1");
 list = list.without("2");
 return list;
        In the case of FixedSizeCollection a new instance of MutableCollection will be returned by without, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling remove on itself.
        Specified by:
        without in interface MutableBagIterable<T>
        Specified by:
        without in interface MutableCollection<T>
        Specified by:
        without in interface MutableSortedBag<T>
        See Also:
        Collection.remove(Object)

      • withAll

        public TreeBag<T> withAll​(java.lang.Iterable<? extends T> iterable)
        Description copied from interface: MutableCollection
        This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new elements to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
         MutableCollection<String> list = list.withAll(FastList.newListWith("1", "2"));
        In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling addAll on itself.
        Specified by:
        withAll in interface MutableBagIterable<T>
        Specified by:
        withAll in interface MutableCollection<T>
        Specified by:
        withAll in interface MutableSortedBag<T>
        See Also:
        Collection.addAll(Collection)

      • withoutAll

        public TreeBag<T> withoutAll​(java.lang.Iterable<? extends T> iterable)
        Description copied from interface: MutableCollection
        This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling removeAll. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
         MutableCollection<String> list = list.withoutAll(FastList.newListWith("1", "2"));
        In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withoutAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling removeAll on itself.
        Specified by:
        withoutAll in interface MutableBagIterable<T>
        Specified by:
        withoutAll in interface MutableCollection<T>
        Specified by:
        withoutAll in interface MutableSortedBag<T>
        See Also:
        Collection.removeAll(Collection)

      • with

        public TreeBag<T> with​(T element)
        Description copied from interface: MutableCollection
        This method allows mutable and fixed size collections the ability to add elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new element to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
         MutableCollection<String> list = list.with("1");
 list = list.with("2");
 return list;
        In the case of FixedSizeCollection a new instance of MutableCollection will be returned by with, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling add on itself.
        Specified by:
        with in interface MutableBagIterable<T>
        Specified by:
        with in interface MutableCollection<T>
        Specified by:
        with in interface MutableSortedBag<T>
        See Also:
        Collection.add(Object)

      • newEmpty

        public MutableSortedBag<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 MutableCollection<T>
        Specified by:
        newEmpty in interface MutableSortedBag<T>

      • 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());
        Specified by:
        removeIf in interface MutableCollection<T>

      • 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);
        Specified by:
        removeIfWith in interface MutableCollection<T>

      • removeAllIterable

        public boolean removeAllIterable​(java.lang.Iterable<?> iterable)
        Specified by:
        removeAllIterable in interface MutableCollection<T>
        See Also:
        Collection.removeAll(Collection)

      • size

        public int size()
        Description copied from interface: RichIterable
        Returns the number of items in this iterable.
        Specified by:
        size in interface java.util.Collection<T>
        Specified by:
        size in interface RichIterable<T>

      • indexOf

        public int indexOf​(java.lang.Object object)
        Description copied from interface: OrderedIterable
        Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.
        Specified by:
        indexOf in interface OrderedIterable<T>
        See Also:
        List.indexOf(Object)

      • detectIndex

        public int detectIndex​(Predicate<? super T> predicate)
        Description copied from interface: OrderedIterable
        Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.
        Specified by:
        detectIndex in interface OrderedIterable<T>

      • corresponds

        public <S> boolean corresponds​(OrderedIterable<S> other,
                               Predicate2<? super T,​? super S> predicate)
        Description copied from interface: OrderedIterable
        Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other. The predicate is evaluated for each element at the same position of each OrderedIterable in a forward iteration order. This is a short circuit pattern.
        Specified by:
        corresponds in interface OrderedIterable<T>

      • comparator

        public java.util.Comparator<? super T> comparator()
        Description copied from interface: SortedBag
        Returns the comparator used to order the elements in this bag, or null if this bag uses the natural ordering of its elements.
        Specified by:
        comparator in interface SortedBag<T>
        Specified by:
        comparator in interface SortedIterable<T>

      • with

        public TreeBag<T> with​(T... elements)

      • with

        public TreeBag<T> with​(T element1,
                       T element2)

      • add

        public boolean add​(T item)
        Specified by:
        add in interface java.util.Collection<T>

      • with

        public TreeBag<T> with​(T element1,
                       T element2,
                       T element3)

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