Package 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<SortedBag<T>>, Iterable<T>, Collection<T>, Bag<T>, MutableBagIterable<T>, MutableSortedBag<T>, SortedBag<T>, MutableCollection<T>, InternalIterable<T>, OrderedIterable<T>, ReversibleIterable<T>, SortedIterable<T>, 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	Description
TreeBag()
TreeBag(Comparator<? super T> comparator)
TreeBag(Comparator<? super T> comparator, Iterable<? extends T> iterable)
TreeBag(SortedBag<T> sortedBag)

Method Summary

Modifier and Type	Method	Description
boolean	add(T item)
int	addOccurrences(T item, int occurrences)
boolean	allSatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)
boolean	anySatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)
void	clear()
TreeBag<T>	clone()
Comparator<? super T>	comparator()
int	compareTo(SortedBag<T> otherBag)
boolean	contains(Object o)
<S> boolean	corresponds(OrderedIterable<S> other, Predicate2<? super T,? super S> predicate)
int	detectIndex(Predicate<? super T> predicate)
T	detectWithOccurrences(ObjectIntPredicate<? super T> predicate)
MutableSortedSet<T>	distinct()
RichIterable<T>	distinctView()
MutableSortedBag<T>	drop(int count)
void	each(Procedure<? super T> procedure)
boolean	equals(Object other)
void	forEach(int fromIndex, int toIndex, Procedure<? super T> procedure)
<P> void	forEachWith(Procedure2<? super T,? super P> procedure, P parameter)
void	forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super T> objectIntProcedure)
void	forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)
void	forEachWithOccurrences(ObjectIntProcedure<? super T> procedure)
<V> TreeBagMultimap<V,T>	groupBy(Function<? super T,? extends V> function)
<V> TreeBagMultimap<V,T>	groupByEach(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(Iterable<? extends E> source)
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>	newBagWith(E... elements)
static <E> TreeBag<E>	newBagWith(Comparator<? super E> comparator, E... elements)
MutableSortedBag<T>	newEmpty()
boolean	noneSatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)
int	occurrencesOf(Object item)
void	readExternal(ObjectInput in)
boolean	remove(Object item)
boolean	removeAllIterable(Iterable<?> iterable)
boolean	removeIf(Predicate<? super T> predicate)
<P> boolean	removeIfWith(Predicate2<? super T,? super P> predicate, P parameter)
boolean	removeOccurrences(Object item, int occurrences)
MutableSortedBag<T>	selectByOccurrences(IntPredicate predicate)
boolean	setOccurrences(T item, int occurrences)
int	size()
int	sizeDistinct()
MutableSortedBag<T>	take(int count)
MutableStack<T>	toStack()
TreeBag<T>	with(T element)
TreeBag<T>	with(T... elements)
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)
MutableSortedSet<Pair<T,Integer>>	zipWithIndex()

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

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

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

addAll, addAllIterable, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, bottomOccurrences, chunk, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, getFirst, getLast, groupByUniqueKey, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, removeAll, retainAll, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, topOccurrences

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

collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, count, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toSet, toSortedBag, toSortedBag, toSortedList, toSortedSet, toSortedSet, toStringOfItemToCount

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

appendString, appendString, asLazy, containsAll, containsAllArguments, containsAllIterable, countWith, forEach, groupByUniqueKey, into, toBiMap, toMap, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, 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.Bag

aggregateBy, collectWithOccurrences, reduceBy, reduceInPlace, reduceInPlace, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, toStringOfItemToCount

Methods inherited from interface java.util.Collection

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

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

forEach

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

bottomOccurrences, selectDuplicates, selectUnique, topOccurrences

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

addAllIterable, aggregateBy, aggregateInPlaceBy, flatCollectWith, groupByUniqueKey, injectIntoWith, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, toArray, toArray

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

flatCollectWith, selectDuplicates, selectUnique, toImmutableSortedBag, withOccurrences, withoutOccurrences

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

getFirst, getFirstOptional, getLast, getLastOptional, rejectWithIndex, selectWithIndex, zip, zipWithIndex

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

asReversed, reverseForEach, reverseForEachWithIndex

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, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, makeString, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString

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

max, min

Constructor Details

TreeBag

public TreeBag()

TreeBag

public TreeBag(Comparator<? super T> comparator)

TreeBag

public TreeBag(SortedBag<T> sortedBag)

TreeBag

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

Method Details

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 MutableSortedBag<T>

Specified by:

clone in class AbstractMutableSortedBag<T>

equals

public boolean equals(Object other)

Specified by:

equals in interface Bag<T>

Specified by:

equals in interface Collection<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Bag<T>

Specified by:

hashCode in interface Collection<T>

Overrides:

hashCode in class Object

sizeDistinct

public int sizeDistinct()

Specified by:

sizeDistinct in interface Bag<T>

forEachWithOccurrences

public void forEachWithOccurrences(ObjectIntProcedure<? super T> procedure)

Specified by:

forEachWithOccurrences in interface Bag<T>

selectByOccurrences

public MutableSortedBag<T> selectByOccurrences(IntPredicate predicate)

Specified by:

selectByOccurrences in interface Bag<T>

Specified by:

selectByOccurrences in interface MutableBagIterable<T>

Specified by:

selectByOccurrences in interface MutableSortedBag<T>

Specified by:

selectByOccurrences in interface SortedBag<T>

occurrencesOf

public int occurrencesOf(Object item)

Specified by:

occurrencesOf in interface Bag<T>

anySatisfyWithOccurrences

public boolean anySatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)

Specified by:

anySatisfyWithOccurrences in interface Bag<T>

allSatisfyWithOccurrences

public boolean allSatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)

Specified by:

allSatisfyWithOccurrences in interface Bag<T>

noneSatisfyWithOccurrences

public boolean noneSatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)

Specified by:

noneSatisfyWithOccurrences in interface Bag<T>

detectWithOccurrences

public T detectWithOccurrences(ObjectIntPredicate<? super T> predicate)

Specified by:

detectWithOccurrences in interface Bag<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface 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 RichIterable<T>

Overrides:

contains in class AbstractRichIterable<T>

compareTo

public int compareTo(SortedBag<T> otherBag)

Specified by:

compareTo in interface Comparable<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(Procedure<? super T> procedure)

Specified by:

each in interface RichIterable<T>

forEachWithIndex

public void forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)

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)

Specified by:

forEach in interface OrderedIterable<T>

forEachWithIndex

public void forEachWithIndex(int fromIndex,
 int toIndex,
 ObjectIntProcedure<? super T> objectIntProcedure)

Specified by:

forEachWithIndex in interface OrderedIterable<T>

forEachWith

public <P> void forEachWith(Procedure2<? super T,? super P> procedure,
 P parameter)

Specified by:

forEachWith in interface InternalIterable<T>

Overrides:

forEachWith in class AbstractRichIterable<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

addOccurrences

public int addOccurrences(T item,
 int occurrences)

Specified by:

addOccurrences in interface MutableBagIterable<T>

removeOccurrences

public boolean removeOccurrences(Object item,
 int occurrences)

Specified by:

removeOccurrences in interface MutableBagIterable<T>

setOccurrences

public boolean setOccurrences(T item,
 int occurrences)

Specified by:

setOccurrences in interface MutableBagIterable<T>

without

public TreeBag<T> without(T element)

Specified by:

without in interface MutableBagIterable<T>

Specified by:

without in interface MutableCollection<T>

Specified by:

without in interface MutableSortedBag<T>

withAll

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

Specified by:

withAll in interface MutableBagIterable<T>

Specified by:

withAll in interface MutableCollection<T>

Specified by:

withAll in interface MutableSortedBag<T>

withoutAll

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

Specified by:

withoutAll in interface MutableBagIterable<T>

Specified by:

withoutAll in interface MutableCollection<T>

Specified by:

withoutAll in interface MutableSortedBag<T>

with

public TreeBag<T> with(T element)

Specified by:

with in interface MutableBagIterable<T>

Specified by:

with in interface MutableCollection<T>

Specified by:

with in interface MutableSortedBag<T>

newEmpty

public MutableSortedBag<T> newEmpty()

Specified by:

newEmpty in interface MutableCollection<T>

Specified by:

newEmpty in interface MutableSortedBag<T>

removeIf

public boolean removeIf(Predicate<? super T> predicate)

Specified by:

removeIf in interface MutableCollection<T>

removeIfWith

public <P> boolean removeIfWith(Predicate2<? super T,? super P> predicate,
 P parameter)

Specified by:

removeIfWith in interface MutableCollection<T>

removeAllIterable

public boolean removeAllIterable(Iterable<?> iterable)

Specified by:

removeAllIterable in interface MutableCollection<T>

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface RichIterable<T>

indexOf

public int indexOf(Object object)

Specified by:

indexOf in interface OrderedIterable<T>

zipWithIndex

public MutableSortedSet<Pair<T,Integer>> zipWithIndex()

Specified by:

zipWithIndex in interface Bag<T>

Specified by:

zipWithIndex in interface MutableBagIterable<T>

Specified by:

zipWithIndex in interface MutableCollection<T>

Specified by:

zipWithIndex in interface MutableSortedBag<T>

Specified by:

zipWithIndex in interface OrderedIterable<T>

Specified by:

zipWithIndex in interface ReversibleIterable<T>

Specified by:

zipWithIndex in interface RichIterable<T>

Specified by:

zipWithIndex in interface SortedBag<T>

Specified by:

zipWithIndex in interface SortedIterable<T>

distinct

public MutableSortedSet<T> distinct()

Specified by:

distinct in interface MutableSortedBag<T>

Specified by:

distinct in interface OrderedIterable<T>

Specified by:

distinct in interface ReversibleIterable<T>

Specified by:

distinct in interface SortedBag<T>

Specified by:

distinct in interface SortedIterable<T>

groupBy

public <V> TreeBagMultimap<V,T> groupBy(Function<? super T,? extends V> function)

Specified by:

groupBy in interface Bag<T>

Specified by:

groupBy in interface MutableBagIterable<T>

Specified by:

groupBy in interface MutableCollection<T>

Specified by:

groupBy in interface MutableSortedBag<T>

Specified by:

groupBy in interface OrderedIterable<T>

Specified by:

groupBy in interface ReversibleIterable<T>

Specified by:

groupBy in interface RichIterable<T>

Specified by:

groupBy in interface SortedBag<T>

Specified by:

groupBy in interface SortedIterable<T>

groupByEach

public <V> TreeBagMultimap<V,T> groupByEach(Function<? super T,? extends Iterable<V>> function)

Specified by:

groupByEach in interface Bag<T>

Specified by:

groupByEach in interface MutableBagIterable<T>

Specified by:

groupByEach in interface MutableCollection<T>

Specified by:

groupByEach in interface MutableSortedBag<T>

Specified by:

groupByEach in interface OrderedIterable<T>

Specified by:

groupByEach in interface ReversibleIterable<T>

Specified by:

groupByEach in interface RichIterable<T>

Specified by:

groupByEach in interface SortedBag<T>

Specified by:

groupByEach in interface SortedIterable<T>

detectIndex

public int detectIndex(Predicate<? super T> predicate)

Specified by:

detectIndex in interface OrderedIterable<T>

corresponds

public <S> boolean corresponds(OrderedIterable<S> other,
 Predicate2<? super T,? super S> predicate)

Specified by:

corresponds in interface OrderedIterable<T>

toStack

public MutableStack<T> toStack()

Specified by:

toStack in interface OrderedIterable<T>

take

public MutableSortedBag<T> take(int count)

Specified by:

take in interface MutableSortedBag<T>

Specified by:

take in interface ReversibleIterable<T>

Specified by:

take in interface SortedBag<T>

drop

public MutableSortedBag<T> drop(int count)

Specified by:

drop in interface MutableSortedBag<T>

Specified by:

drop in interface ReversibleIterable<T>

Specified by:

drop in interface SortedBag<T>

comparator

public Comparator<? super T> comparator()

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 Collection<T>

with

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

distinctView

public RichIterable<T> distinctView()

Specified by:

distinctView in interface Bag<T>