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

Class TreeBag<T>

java.lang.Object

org.eclipse.collections.impl.AbstractRichIterable<T>

org.eclipse.collections.impl.bag.AbstractBag<T>

org.eclipse.collections.impl.bag.mutable.AbstractMutableBagIterable<T>

org.eclipse.collections.impl.bag.sorted.mutable.AbstractMutableSortedBag<T>

org.eclipse.collections.impl.bag.sorted.mutable.TreeBag<T>

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Comparable<org.eclipse.collections.api.bag.sorted.SortedBag<T>>, Iterable<T>, Collection<T>, org.eclipse.collections.api.bag.Bag<T>, org.eclipse.collections.api.bag.MutableBagIterable<T>, org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>, org.eclipse.collections.api.bag.sorted.SortedBag<T>, org.eclipse.collections.api.collection.MutableCollection<T>, org.eclipse.collections.api.InternalIterable<T>, org.eclipse.collections.api.ordered.OrderedIterable<T>, org.eclipse.collections.api.ordered.ReversibleIterable<T>, org.eclipse.collections.api.ordered.SortedIterable<T>, org.eclipse.collections.api.RichIterable<T>

public class TreeBag<T>
extends AbstractMutableSortedBag<T>
implements Externalizable

A TreeBag is a MutableSortedBag which uses a SortedMap as its underlying data store. Each key in the SortedMap represents some item, and the value in the map represents the current number of occurrences of that item.

Since:

4.2

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TreeBag()
TreeBag(Comparator<? super T> comparator)
TreeBag(Comparator<? super T> comparator, Iterable<? extends T> iterable)
TreeBag(org.eclipse.collections.api.bag.sorted.SortedBag<T> sortedBag)

Method Summary

Modifier and Type	Method and Description
boolean	add(T item)
void	addOccurrences(T item, int occurrences)
void	clear()
TreeBag<T>	clone()
Comparator<? super T>	comparator()
int	compareTo(org.eclipse.collections.api.bag.sorted.SortedBag<T> otherBag)
boolean	contains(Object o)
<S> boolean	corresponds(org.eclipse.collections.api.ordered.OrderedIterable<S> other, org.eclipse.collections.api.block.predicate.Predicate2<? super T,? super S> predicate)
int	detectIndex(org.eclipse.collections.api.block.predicate.Predicate<? super T> predicate)
org.eclipse.collections.api.set.sorted.MutableSortedSet<T>	distinct()
org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>	drop(int count)
void	each(org.eclipse.collections.api.block.procedure.Procedure<? super T> procedure)
boolean	equals(Object other)
void	forEach(int fromIndex, int toIndex, org.eclipse.collections.api.block.procedure.Procedure<? super T> procedure)
<P> void	forEachWith(org.eclipse.collections.api.block.procedure.Procedure2<? super T,? super P> procedure, P parameter)
void	forEachWithIndex(int fromIndex, int toIndex, org.eclipse.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)
void	forEachWithIndex(org.eclipse.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)
void	forEachWithOccurrences(org.eclipse.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> procedure)
<V> TreeBagMultimap<V,T>	groupBy(org.eclipse.collections.api.block.function.Function<? super T,? extends V> function)
<V> TreeBagMultimap<V,T>	groupByEach(org.eclipse.collections.api.block.function.Function<? super T,? extends Iterable<V>> function)
int	hashCode()
int	indexOf(Object object)
boolean	isEmpty()
Iterator<T>	iterator()
static <E> TreeBag<E>	newBag()
static <E> TreeBag<E>	newBag(Comparator<? super E> comparator)
static <E> TreeBag<E>	newBag(Comparator<? super E> comparator, Iterable<? extends E> iterable)
static <E> TreeBag<E>	newBag(Iterable<? extends E> source)
static <E> TreeBag<E>	newBagWith(Comparator<? super E> comparator, E... elements)
static <E> TreeBag<E>	newBagWith(E... elements)
org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>	newEmpty()
int	occurrencesOf(Object item)
void	readExternal(ObjectInput in)
boolean	remove(Object item)
boolean	removeAllIterable(Iterable<?> iterable)
boolean	removeIf(org.eclipse.collections.api.block.predicate.Predicate<? super T> predicate)
<P> boolean	removeIfWith(org.eclipse.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
boolean	removeOccurrences(Object item, int occurrences)
org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>	selectByOccurrences(org.eclipse.collections.api.block.predicate.primitive.IntPredicate predicate)
boolean	setOccurrences(T item, int occurrences)
int	size()
int	sizeDistinct()
org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>	take(int count)
org.eclipse.collections.api.stack.MutableStack<T>	toStack()
TreeBag<T>	with(T... elements)
TreeBag<T>	with(T element)
TreeBag<T>	with(T element1, T element2)
TreeBag<T>	with(T element1, T element2, T element3)
TreeBag<T>	withAll(Iterable<? extends T> iterable)
TreeBag<T>	without(T element)
TreeBag<T>	withoutAll(Iterable<? extends T> iterable)
void	writeExternal(ObjectOutput out)
org.eclipse.collections.api.set.sorted.MutableSortedSet<org.eclipse.collections.api.tuple.Pair<T,Integer>>	zipWithIndex()

Methods inherited from class org.eclipse.collections.impl.bag.sorted.mutable.AbstractMutableSortedBag

asParallel, asReversed, asSynchronized, asUnmodifiable, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, detectLastIndex, dropWhile, flatCollect, partition, partitionWhile, partitionWith, reject, rejectWith, reverseForEach, select, selectInstancesOf, selectWith, takeWhile, tap, toImmutable, toMapOfItemToCount, toReversed, zip

Methods inherited from class org.eclipse.collections.impl.bag.mutable.AbstractMutableBagIterable

addAll, addAllIterable, aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, bottomOccurrences, chunk, detect, detectIfNone, detectWith, detectWithIfNone, getFirst, getLast, groupByUniqueKey, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, removeAll, retainAll, retainAllIterable, selectAndRejectWith, topOccurrences

Methods inherited from class org.eclipse.collections.impl.bag.AbstractBag

collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, count, flatCollect, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toList, toSet, toSortedBag, toSortedBag, toSortedList, toSortedSet, toSortedSet, toStringOfItemToCount

Methods inherited from class org.eclipse.collections.impl.AbstractRichIterable

appendString, appendString, appendString, asLazy, containsAll, containsAllArguments, containsAllIterable, countWith, forEach, groupByUniqueKey, makeString, makeString, makeString, notEmpty, sumByDouble, sumByFloat, sumByInt, sumByLong, toArray, toArray, toMap, toSortedBagBy, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.api.bag.sorted.MutableSortedBag

aggregateBy, aggregateInPlaceBy

Methods inherited from interface org.eclipse.collections.api.bag.sorted.SortedBag

max, min

Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable

getFirst, getLast, zip, zipWithIndex

Methods inherited from interface org.eclipse.collections.api.RichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, groupBy, groupByEach, groupByUniqueKey, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, makeString, makeString, makeString, max, maxBy, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString

Methods inherited from interface org.eclipse.collections.api.InternalIterable

forEach

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.eclipse.collections.api.bag.MutableBagIterable

bottomOccurrences, topOccurrences

Methods inherited from interface org.eclipse.collections.api.bag.Bag

toStringOfItemToCount

Methods inherited from interface org.eclipse.collections.api.collection.MutableCollection

addAllIterable, groupByUniqueKey, injectIntoWith, retainAllIterable, selectAndRejectWith

Methods inherited from interface java.util.Collection

addAll, containsAll, parallelStream, removeAll, removeIf, retainAll, spliterator, stream, toArray, toArray

Constructor Detail

TreeBag

public TreeBag()

TreeBag

public TreeBag(Comparator<? super T> comparator)

TreeBag

public TreeBag(org.eclipse.collections.api.bag.sorted.SortedBag<T> sortedBag)

TreeBag

public TreeBag(Comparator<? super T> comparator,
               Iterable<? extends T> iterable)

Method Detail

newBag

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

newBag

public static <E> TreeBag<E> newBag(Comparator<? super E> comparator)

newBag

public static <E> TreeBag<E> newBag(Iterable<? extends E> source)

newBag

public static <E> TreeBag<E> newBag(Comparator<? super E> comparator,
                                    Iterable<? extends E> iterable)

newBagWith

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

newBagWith

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

clone

public TreeBag<T> clone()

Specified by:

clone in interface org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>

Specified by:

clone in class AbstractMutableSortedBag<T>

equals

public boolean equals(Object other)

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface org.eclipse.collections.api.bag.Bag<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface org.eclipse.collections.api.bag.Bag<T>

Overrides:

hashCode in class Object

sizeDistinct

public int sizeDistinct()

Specified by:

sizeDistinct in interface org.eclipse.collections.api.bag.Bag<T>

forEachWithOccurrences

public void forEachWithOccurrences(org.eclipse.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> procedure)

Specified by:

forEachWithOccurrences in interface org.eclipse.collections.api.bag.Bag<T>

selectByOccurrences

public org.eclipse.collections.api.bag.sorted.MutableSortedBag<T> selectByOccurrences(org.eclipse.collections.api.block.predicate.primitive.IntPredicate predicate)

Specified by:

selectByOccurrences in interface org.eclipse.collections.api.bag.Bag<T>

Specified by:

selectByOccurrences in interface org.eclipse.collections.api.bag.MutableBagIterable<T>

Specified by:

selectByOccurrences in interface org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>

Specified by:

selectByOccurrences in interface org.eclipse.collections.api.bag.sorted.SortedBag<T>

occurrencesOf

public int occurrencesOf(Object item)

Specified by:

occurrencesOf in interface org.eclipse.collections.api.bag.Bag<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface org.eclipse.collections.api.RichIterable<T>

Overrides:

isEmpty in class AbstractRichIterable<T>

remove

public boolean remove(Object item)

Specified by:

remove in interface Collection<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface org.eclipse.collections.api.RichIterable<T>

Overrides:

contains in class AbstractRichIterable<T>

compareTo

public int compareTo(org.eclipse.collections.api.bag.sorted.SortedBag<T> otherBag)

Specified by:

compareTo in interface Comparable<org.eclipse.collections.api.bag.sorted.SortedBag<T>>

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

each

public void each(org.eclipse.collections.api.block.procedure.Procedure<? super T> procedure)

Specified by:

each in interface org.eclipse.collections.api.RichIterable<T>

forEachWithIndex

public void forEachWithIndex(org.eclipse.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)

Specified by:

forEachWithIndex in interface org.eclipse.collections.api.InternalIterable<T>

Specified by:

forEachWithIndex in interface org.eclipse.collections.api.ordered.OrderedIterable<T>

Overrides:

forEachWithIndex in class AbstractRichIterable<T>

forEach

public void forEach(int fromIndex,
                    int toIndex,
                    org.eclipse.collections.api.block.procedure.Procedure<? super T> procedure)

Specified by:

forEach in interface org.eclipse.collections.api.ordered.OrderedIterable<T>

forEachWithIndex

public void forEachWithIndex(int fromIndex,
                             int toIndex,
                             org.eclipse.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)

Specified by:

forEachWithIndex in interface org.eclipse.collections.api.ordered.OrderedIterable<T>

forEachWith

public <P> void forEachWith(org.eclipse.collections.api.block.procedure.Procedure2<? super T,? super P> procedure,
                            P parameter)

Specified by:

forEachWith in interface org.eclipse.collections.api.InternalIterable<T>

Overrides:

forEachWith in class AbstractRichIterable<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

addOccurrences

public void addOccurrences(T item,
                           int occurrences)

Specified by:

addOccurrences in interface org.eclipse.collections.api.bag.MutableBagIterable<T>

removeOccurrences

public boolean removeOccurrences(Object item,
                                 int occurrences)

Specified by:

removeOccurrences in interface org.eclipse.collections.api.bag.MutableBagIterable<T>

setOccurrences

public boolean setOccurrences(T item,
                              int occurrences)

Specified by:

setOccurrences in interface org.eclipse.collections.api.bag.MutableBagIterable<T>

without

public TreeBag<T> without(T element)

Specified by:

without in interface org.eclipse.collections.api.bag.MutableBagIterable<T>

Specified by:

without in interface org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>

Specified by:

without in interface org.eclipse.collections.api.collection.MutableCollection<T>

withAll

public TreeBag<T> withAll(Iterable<? extends T> iterable)

Specified by:

withAll in interface org.eclipse.collections.api.bag.MutableBagIterable<T>

Specified by:

withAll in interface org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>

Specified by:

withAll in interface org.eclipse.collections.api.collection.MutableCollection<T>

withoutAll

public TreeBag<T> withoutAll(Iterable<? extends T> iterable)

Specified by:

withoutAll in interface org.eclipse.collections.api.bag.MutableBagIterable<T>

Specified by:

withoutAll in interface org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>

Specified by:

withoutAll in interface org.eclipse.collections.api.collection.MutableCollection<T>

with

public TreeBag<T> with(T element)

Specified by:

with in interface org.eclipse.collections.api.bag.MutableBagIterable<T>

Specified by:

with in interface org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>

Specified by:

with in interface org.eclipse.collections.api.collection.MutableCollection<T>

newEmpty

public org.eclipse.collections.api.bag.sorted.MutableSortedBag<T> newEmpty()

Specified by:

newEmpty in interface org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>

Specified by:

newEmpty in interface org.eclipse.collections.api.collection.MutableCollection<T>

removeIf

public boolean removeIf(org.eclipse.collections.api.block.predicate.Predicate<? super T> predicate)

Specified by:

removeIf in interface org.eclipse.collections.api.collection.MutableCollection<T>

removeIfWith

public <P> boolean removeIfWith(org.eclipse.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                P parameter)

Specified by:

removeIfWith in interface org.eclipse.collections.api.collection.MutableCollection<T>

removeAllIterable

public boolean removeAllIterable(Iterable<?> iterable)

Specified by:

removeAllIterable in interface org.eclipse.collections.api.collection.MutableCollection<T>

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface org.eclipse.collections.api.RichIterable<T>

indexOf

public int indexOf(Object object)

Specified by:

indexOf in interface org.eclipse.collections.api.ordered.OrderedIterable<T>

zipWithIndex

public org.eclipse.collections.api.set.sorted.MutableSortedSet<org.eclipse.collections.api.tuple.Pair<T,Integer>> zipWithIndex()

Specified by:

zipWithIndex in interface org.eclipse.collections.api.bag.Bag<T>

Specified by:

zipWithIndex in interface org.eclipse.collections.api.bag.MutableBagIterable<T>

Specified by:

zipWithIndex in interface org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>

Specified by:

zipWithIndex in interface org.eclipse.collections.api.bag.sorted.SortedBag<T>

Specified by:

zipWithIndex in interface org.eclipse.collections.api.collection.MutableCollection<T>

Specified by:

zipWithIndex in interface org.eclipse.collections.api.ordered.OrderedIterable<T>

Specified by:

zipWithIndex in interface org.eclipse.collections.api.ordered.ReversibleIterable<T>

Specified by:

zipWithIndex in interface org.eclipse.collections.api.ordered.SortedIterable<T>

Specified by:

zipWithIndex in interface org.eclipse.collections.api.RichIterable<T>

distinct

public org.eclipse.collections.api.set.sorted.MutableSortedSet<T> distinct()

Specified by:

distinct in interface org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>

Specified by:

distinct in interface org.eclipse.collections.api.bag.sorted.SortedBag<T>

Specified by:

distinct in interface org.eclipse.collections.api.ordered.OrderedIterable<T>

Specified by:

distinct in interface org.eclipse.collections.api.ordered.ReversibleIterable<T>

Specified by:

distinct in interface org.eclipse.collections.api.ordered.SortedIterable<T>

groupBy

public <V> TreeBagMultimap<V,T> groupBy(org.eclipse.collections.api.block.function.Function<? super T,? extends V> function)

Specified by:

groupBy in interface org.eclipse.collections.api.bag.Bag<T>

Specified by:

groupBy in interface org.eclipse.collections.api.bag.MutableBagIterable<T>

Specified by:

groupBy in interface org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>

Specified by:

groupBy in interface org.eclipse.collections.api.bag.sorted.SortedBag<T>

Specified by:

groupBy in interface org.eclipse.collections.api.collection.MutableCollection<T>

Specified by:

groupBy in interface org.eclipse.collections.api.ordered.OrderedIterable<T>

Specified by:

groupBy in interface org.eclipse.collections.api.ordered.ReversibleIterable<T>

Specified by:

groupBy in interface org.eclipse.collections.api.ordered.SortedIterable<T>

Specified by:

groupBy in interface org.eclipse.collections.api.RichIterable<T>

groupByEach

public <V> TreeBagMultimap<V,T> groupByEach(org.eclipse.collections.api.block.function.Function<? super T,? extends Iterable<V>> function)

Specified by:

groupByEach in interface org.eclipse.collections.api.bag.Bag<T>

Specified by:

groupByEach in interface org.eclipse.collections.api.bag.MutableBagIterable<T>

Specified by:

groupByEach in interface org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>

Specified by:

groupByEach in interface org.eclipse.collections.api.bag.sorted.SortedBag<T>

Specified by:

groupByEach in interface org.eclipse.collections.api.collection.MutableCollection<T>

Specified by:

groupByEach in interface org.eclipse.collections.api.ordered.OrderedIterable<T>

Specified by:

groupByEach in interface org.eclipse.collections.api.ordered.ReversibleIterable<T>

Specified by:

groupByEach in interface org.eclipse.collections.api.ordered.SortedIterable<T>

Specified by:

groupByEach in interface org.eclipse.collections.api.RichIterable<T>

detectIndex

public int detectIndex(org.eclipse.collections.api.block.predicate.Predicate<? super T> predicate)

Specified by:

detectIndex in interface org.eclipse.collections.api.ordered.OrderedIterable<T>

corresponds

public <S> boolean corresponds(org.eclipse.collections.api.ordered.OrderedIterable<S> other,
                               org.eclipse.collections.api.block.predicate.Predicate2<? super T,? super S> predicate)

Specified by:

corresponds in interface org.eclipse.collections.api.ordered.OrderedIterable<T>

toStack

public org.eclipse.collections.api.stack.MutableStack<T> toStack()

Specified by:

toStack in interface org.eclipse.collections.api.ordered.OrderedIterable<T>

Specified by:

toStack in interface org.eclipse.collections.api.ordered.SortedIterable<T>

take

public org.eclipse.collections.api.bag.sorted.MutableSortedBag<T> take(int count)

Specified by:

take in interface org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>

Specified by:

take in interface org.eclipse.collections.api.bag.sorted.SortedBag<T>

Specified by:

take in interface org.eclipse.collections.api.ordered.ReversibleIterable<T>

drop

public org.eclipse.collections.api.bag.sorted.MutableSortedBag<T> drop(int count)

Specified by:

drop in interface org.eclipse.collections.api.bag.sorted.MutableSortedBag<T>

Specified by:

drop in interface org.eclipse.collections.api.bag.sorted.SortedBag<T>

Specified by:

drop in interface org.eclipse.collections.api.ordered.ReversibleIterable<T>

comparator

public Comparator<? super T> comparator()

Specified by:

comparator in interface org.eclipse.collections.api.bag.sorted.SortedBag<T>

Specified by:

comparator in interface org.eclipse.collections.api.ordered.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 Collection<T>

with

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