Class MultiReaderHashBag<T>

java.lang.Object

org.eclipse.collections.impl.collection.mutable.AbstractMultiReaderMutableCollection<T>

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

All Implemented Interfaces:

Externalizable, Serializable, Iterable<T>, Collection<T>, Bag<T>, MultiReaderBag<T>, MutableBag<T>, MutableBagIterable<T>, UnsortedBag<T>, MutableCollection<T>, InternalIterable<T>, RichIterable<T>

public final class MultiReaderHashBag<T>
extends AbstractMultiReaderMutableCollection<T>
implements Externalizable, MultiReaderBag<T>

MultiReaderHashBag provides a thread-safe wrapper around a HashBag, using a ReentrantReadWriteLock. In order to provide true thread-safety, MultiReaderHashBag does not implement iterator() as this method requires an external lock to be taken to provide thread-safe iteration. All of these methods are available however, if you use the withReadLockAndDelegate() or withWriteLockAndDelegate() methods. Both of these methods take a parameter of type Procedure<MutableBag>, and a wrapped version of the underlying HashBag is returned. This wrapper guarantees that no external pointer can ever reference the underlying HashBag outside a locked procedure. In the case of the read lock method, an Unmodifiable version of the collection is offered, which will throw UnsupportedOperationExceptions on any write methods like add or remove.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	MultiReaderHashBag.UntouchableIterator<T>
(package private) static final class	MultiReaderHashBag.UntouchableMutableBag<T>

Nested classes/interfaces inherited from class AbstractMultiReaderMutableCollection

AbstractMultiReaderMutableCollection.LockWrapper, AbstractMultiReaderMutableCollection.ReadWriteLockWrapper, AbstractMultiReaderMutableCollection.UntouchableMutableCollection<T>

Field Summary

Fields

Modifier and Type	Field	Description
private HashBag<T>	delegate
private static final long	serialVersionUID

Fields inherited from class AbstractMultiReaderMutableCollection

lock, lockWrapper

Constructor Summary

Constructors

Modifier	Constructor	Description
	MultiReaderHashBag()	Deprecated. Empty default constructor used for serialization.
private	MultiReaderHashBag(HashBag<T> newDelegate)
private	MultiReaderHashBag(HashBag<T> newDelegate, ReadWriteLock newLock)

Method Summary

Modifier and Type	Method	Description
int	addOccurrences(T item, int occurrences)	Add number of occurrences for an item.
boolean	allSatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)	Returns true if the predicate evaluates to true for all elements of the Bag.
boolean	anySatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)	Returns true if the predicate evaluates to true for any element of the Bag.
(package private) MultiReaderHashBag.UntouchableMutableBag<T>	asReadUntouchable()
MutableBag<T>	asSynchronized()	Returns a synchronized wrapper backed by this collection.
MutableBag<T>	asUnmodifiable()	Returns an unmodifiable view of this collection.
(package private) MultiReaderHashBag.UntouchableMutableBag<T>	asWriteUntouchable()
MutableList<ObjectIntPair<T>>	bottomOccurrences(int count)	Returns the count least frequently occurring items.
RichIterable<RichIterable<T>>	chunk(int size)	Partitions elements in fixed size chunks.
<V> MutableBag<V>	collect(Function<? super T, ? extends V> function)	Returns a new MutableCollection with the results of applying the specified function to each element of the source collection.
MutableBooleanBag	collectBoolean(BooleanFunction<? super T> booleanFunction)	Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection.
MutableByteBag	collectByte(ByteFunction<? super T> byteFunction)	Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection.
MutableCharBag	collectChar(CharFunction<? super T> charFunction)	Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection.
MutableDoubleBag	collectDouble(DoubleFunction<? super T> doubleFunction)	Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection.
MutableFloatBag	collectFloat(FloatFunction<? super T> floatFunction)	Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection.
<V> MutableBag<V>	collectIf(Predicate<? super T> predicate, Function<? super T, ? extends V> function)	Returns a new MutableCollection with the results of applying the specified function to each element of the source collection, but only for elements that evaluate to true for the specified predicate.
MutableIntBag	collectInt(IntFunction<? super T> intFunction)	Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection.
MutableLongBag	collectLong(LongFunction<? super T> longFunction)	Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection.
MutableShortBag	collectShort(ShortFunction<? super T> shortFunction)	Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection.
<P,V> MutableBag<V>	collectWith(Function2<? super T, ? super P, ? extends V> function, P parameter)	Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
<V> MutableBag<V>	collectWithOccurrences(ObjectIntToObjectFunction<? super T, ? extends V> function)	Iterates over the unique elements and their occurrences and collects the results of applying the specified function.
<V, R extends Collection<V>> R	collectWithOccurrences(ObjectIntToObjectFunction<? super T, ? extends V> function, R target)	Iterates over the unique elements and their occurrences and collects the results of applying the specified function into the target collection.
T	detectWithOccurrences(ObjectIntPredicate<? super T> predicate)	Returns an element of the Bag that satisfies the predicate or null if such an element does not exist
RichIterable<T>	distinctView()	Returns an unmodifiable view on the distinct elements with the same complexity as the Bag implementation.
boolean	equals(Object o)	Two bags b1 and b2 are equal if m1.toMapOfItemToCount().equals(m2.toMapOfItemToCount()).
<V> MutableBag<V>	flatCollect(Function<? super T, ? extends Iterable<V>> function)	flatCollect is a special case of RichIterable.collect(Function).
void	forEachWithOccurrences(ObjectIntProcedure<? super T> procedure)	For each distinct item, with the number of occurrences, execute the specified procedure.
protected MutableBag<T>	getDelegate()
<V> MutableBagMultimap<V,T>	groupBy(Function<? super T, ? extends V> function)	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.
<V> MutableBagMultimap<V,T>	groupByEach(Function<? super T, ? extends Iterable<V>> function)	Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<V> MutableMap<V,T>	groupByUniqueKey(Function<? super T, ? extends V> function)	For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key.
int	hashCode()	Returns the hash code for this Bag, defined as this.Bag.toMapOfItemToCount().hashCode().
static <T> MultiReaderHashBag<T>	newBag()
static <T> MultiReaderHashBag<T>	newBag(int capacity)
static <T> MultiReaderHashBag<T>	newBag(Iterable<T> iterable)
static <T> MultiReaderHashBag<T>	newBagWith(T... elements)
MultiReaderBag<T>	newEmpty()	Creates a new empty mutable version of the same collection type.
boolean	noneSatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)	Returns true if the Bag is empty or if the predicate evaluates to false for all elements of the Bag.
int	occurrencesOf(Object item)	The occurrences of a distinct item in the bag.
PartitionMutableBag<T>	partition(Predicate<? super T> predicate)	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
<P> PartitionMutableBag<T>	partitionWith(Predicate2<? super T, ? super P> predicate, P parameter)	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
void	readExternal(ObjectInput in)
MutableBag<T>	reject(Predicate<? super T> predicate)	Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
<P> MutableBag<T>	rejectWith(Predicate2<? super T, ? super P> predicate, P parameter)	Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.
boolean	removeOccurrences(Object item, int occurrences)
MutableBag<T>	select(Predicate<? super T> predicate)	Returns a MutableCollection with all elements that evaluate to true for the specified predicate.
MutableBag<T>	selectByOccurrences(IntPredicate predicate)	Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
<S> MutableBag<S>	selectInstancesOf(Class<S> clazz)	Returns all elements of the source collection that are instances of the Class clazz.
MutableSet<T>	selectUnique()	Returns a set containing all elements of the bag that have exactly one occurrence.
<P> MutableBag<T>	selectWith(Predicate2<? super T, ? super P> predicate, P parameter)	Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.
boolean	setOccurrences(T item, int occurrences)
int	sizeDistinct()	The size of the Bag when counting only distinct elements.
<V> MutableObjectLongMap<V>	sumByInt(Function<? super T, ? extends V> groupBy, IntFunction<? super T> function)	Groups and sums the values using the two specified functions.
<V> MutableObjectLongMap<V>	sumByLong(Function<? super T, ? extends V> groupBy, LongFunction<? super T> function)	Groups and sums the values using the two specified functions.
MultiReaderBag<T>	tap(Procedure<? super T> procedure)	Executes the Procedure for each element in the iterable and returns this.
ImmutableBag<T>	toImmutable()	Converts this MutableCollection to an ImmutableCollection.
MutableMap<T,Integer>	toMapOfItemToCount()	Converts the Bag to a Map of the Item type to its count as an Integer.
MutableList<ObjectIntPair<T>>	topOccurrences(int count)	Returns the count most frequently occurring items.
String	toStringOfItemToCount()	Returns a string representation of this bag.
void	trimToSize()	Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.
void	withReadLockAndDelegate(Procedure<? super MutableBag<T>> procedure)
void	withWriteLockAndDelegate(Procedure<? super MutableBag<T>> procedure)
void	writeExternal(ObjectOutput out)
<S> MutableBag<Pair<T,S>>	zip(Iterable<S> that)	Deprecated. in 6.0.
MutableSet<Pair<T,Integer>>	zipWithIndex()	Deprecated. in 6.0.

Methods inherited from class AbstractMultiReaderMutableCollection

add, addAll, addAllIterable, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, clear, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, forEachWith, forEachWithIndex, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, into, isEmpty, iterator, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, parallelStream, reduceBy, reduceBy, reject, rejectWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, select, selectAndRejectWith, selectWith, size, spliterator, stream, sumByDouble, sumByFloat, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableList, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Bag

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

Methods inherited from interface Collection

add, addAll, clear, contains, containsAll, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray

Methods inherited from interface InternalIterable

forEach, forEachWith, forEachWithIndex

Methods inherited from interface MultiReaderBag

with, withAll, withOccurrences, without, withoutAll, withoutOccurrences

Methods inherited from interface MutableBag

countBy, countByEach, countByWith, flatCollectWith, selectDuplicates, toImmutableBag

Methods inherited from interface MutableCollection

addAllIterable, aggregateBy, aggregateInPlaceBy, flatCollectWith, injectIntoWith, removeAllIterable, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, toArray, toArray

Methods inherited from interface RichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getFirst, getLast, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, 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, zip, zipWithIndex

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

delegate

private HashBag<T> delegate

Constructor Details

MultiReaderHashBag

@Deprecated
public MultiReaderHashBag()

Deprecated.

Empty default constructor used for serialization.

MultiReaderHashBag

private MultiReaderHashBag(HashBag<T> newDelegate)

MultiReaderHashBag

private MultiReaderHashBag(HashBag<T> newDelegate,
 ReadWriteLock newLock)

Method Details

newBag

public static <T> MultiReaderHashBag<T> newBag()

newBag

public static <T> MultiReaderHashBag<T> newBag(int capacity)

newBag

public static <T> MultiReaderHashBag<T> newBag(Iterable<T> iterable)

newBagWith

public static <T> MultiReaderHashBag<T> newBagWith(T... elements)

trimToSize

public void trimToSize()

Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.

Since:

12.0

getDelegate

protected MutableBag<T> getDelegate()

Specified by:

getDelegate in class AbstractMultiReaderMutableCollection<T>

asReadUntouchable

MultiReaderHashBag.UntouchableMutableBag<T> asReadUntouchable()

asWriteUntouchable

MultiReaderHashBag.UntouchableMutableBag<T> asWriteUntouchable()

withReadLockAndDelegate

public void withReadLockAndDelegate(Procedure<? super MutableBag<T>> procedure)

Specified by:

withReadLockAndDelegate in interface MultiReaderBag<T>

withWriteLockAndDelegate

public void withWriteLockAndDelegate(Procedure<? super MutableBag<T>> procedure)

Specified by:

withWriteLockAndDelegate in interface MultiReaderBag<T>

asSynchronized

public MutableBag<T> asSynchronized()

Description copied from interface: MutableCollection

Returns a synchronized wrapper backed by this collection. This is the equivalent of using Collections.synchronizedCollection(this) only with a return type that supports the full iteration protocols available on MutableCollection. The preferred way of iterating over a synchronized collection is to use the internal iteration methods which are properly synchronized internally.

 MutableCollection synchedCollection = collection.asSynchronized();
    ...
 synchedCollection.forEach(each -> ... );
 synchedCollection.select(each -> ... );
 synchedCollection.collect(each -> ... );

If you want to iterate using an imperative style, you must protect external iterators using a synchronized block. This includes explicit iterators as well as JDK 5 style for loops.

Specified by:

asSynchronized in interface MutableBag<T>

Specified by:

asSynchronized in interface MutableCollection<T>

Returns:

a synchronized view of this collection.

See Also:

• Collections.synchronizedCollection(Collection)

asUnmodifiable

public MutableBag<T> asUnmodifiable()

Description copied from interface: MutableCollection

Returns an unmodifiable view of this collection. This is the equivalent of using Collections.unmodifiableCollection(this) with a return type that supports the full iteration protocols available on MutableCollection. Methods which would mutate the underlying collection will throw UnsupportedOperationExceptions.

Specified by:

asUnmodifiable in interface MutableBag<T>

Specified by:

asUnmodifiable in interface MutableCollection<T>

Returns:

an unmodifiable view of this collection.

See Also:

• Collections.unmodifiableCollection(Collection)

toImmutable

public ImmutableBag<T> toImmutable()

Description copied from interface: MutableCollection

Converts this MutableCollection to an ImmutableCollection.

Specified by:

toImmutable in interface Bag<T>

Specified by:

toImmutable in interface MutableBag<T>

Specified by:

toImmutable in interface MutableCollection<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.

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>

occurrencesOf

public int occurrencesOf(Object item)

Description copied from interface: Bag

The occurrences of a distinct item in the bag.

Specified by:

occurrencesOf in interface Bag<T>

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>

collect

public <V> MutableBag<V> collect(Function<? super T, ? extends V> function)

Description copied from interface: MutableCollection

Returns a new MutableCollection with the results of applying the specified function to each element of the source collection.

MutableCollection<String> names =
    people.collect(person -> person.getFirstName() + " " + person.getLastName());

Specified by:

collect in interface MutableBag<T>

Specified by:

collect in interface MutableCollection<T>

Specified by:

collect in interface RichIterable<T>

Specified by:

collect in interface UnsortedBag<T>

collectBoolean

public MutableBooleanBag collectBoolean(BooleanFunction<? super T> booleanFunction)

Description copied from interface: MutableCollection

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

Co-variant example for MutableCollection:

MutableBooleanCollection licenses =
    people.collectBoolean(person -> person.hasDrivingLicense());

Specified by:

collectBoolean in interface MutableBag<T>

Specified by:

collectBoolean in interface MutableCollection<T>

Specified by:

collectBoolean in interface RichIterable<T>

Specified by:

collectBoolean in interface UnsortedBag<T>

collectByte

public MutableByteBag collectByte(ByteFunction<? super T> byteFunction)

Description copied from interface: MutableCollection

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

Co-variant example for MutableCollection:

MutableByteCollection bytes =
    people.collectByte(person -> person.getCode());

Specified by:

collectByte in interface MutableBag<T>

Specified by:

collectByte in interface MutableCollection<T>

Specified by:

collectByte in interface RichIterable<T>

Specified by:

collectByte in interface UnsortedBag<T>

collectChar

public MutableCharBag collectChar(CharFunction<? super T> charFunction)

Description copied from interface: MutableCollection

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

Co-variant example for MutableCollection:

MutableCharCollection chars =
    people.collectChar(person -> person.getMiddleInitial());

Specified by:

collectChar in interface MutableBag<T>

Specified by:

collectChar in interface MutableCollection<T>

Specified by:

collectChar in interface RichIterable<T>

Specified by:

collectChar in interface UnsortedBag<T>

collectDouble

public MutableDoubleBag collectDouble(DoubleFunction<? super T> doubleFunction)

Description copied from interface: MutableCollection

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

Co-variant example for MutableCollection:

MutableDoubleCollection doubles =
    people.collectDouble(person -> person.getMilesFromNorthPole());

Specified by:

collectDouble in interface MutableBag<T>

Specified by:

collectDouble in interface MutableCollection<T>

Specified by:

collectDouble in interface RichIterable<T>

Specified by:

collectDouble in interface UnsortedBag<T>

collectFloat

public MutableFloatBag collectFloat(FloatFunction<? super T> floatFunction)

Description copied from interface: MutableCollection

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

Co-variant example for MutableCollection:

MutableFloatCollection floats =
    people.collectFloat(person -> person.getHeightInInches());

Specified by:

collectFloat in interface MutableBag<T>

Specified by:

collectFloat in interface MutableCollection<T>

Specified by:

collectFloat in interface RichIterable<T>

Specified by:

collectFloat in interface UnsortedBag<T>

collectInt

public MutableIntBag collectInt(IntFunction<? super T> intFunction)

Description copied from interface: MutableCollection

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

Co-variant example for MutableCollection:

MutableIntCollection ints =
    people.collectInt(person -> person.getAge());

Specified by:

collectInt in interface MutableBag<T>

Specified by:

collectInt in interface MutableCollection<T>

Specified by:

collectInt in interface RichIterable<T>

Specified by:

collectInt in interface UnsortedBag<T>

collectLong

public MutableLongBag collectLong(LongFunction<? super T> longFunction)

Description copied from interface: MutableCollection

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

Co-variant example for MutableCollection:

MutableLongCollection longs =
    people.collectLong(person -> person.getGuid());

Specified by:

collectLong in interface MutableBag<T>

Specified by:

collectLong in interface MutableCollection<T>

Specified by:

collectLong in interface RichIterable<T>

Specified by:

collectLong in interface UnsortedBag<T>

collectShort

public MutableShortBag collectShort(ShortFunction<? super T> shortFunction)

Description copied from interface: MutableCollection

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

Co-variant example for MutableCollection:

MutableShortCollection shorts =
    people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());

Specified by:

collectShort in interface MutableBag<T>

Specified by:

collectShort in interface MutableCollection<T>

Specified by:

collectShort in interface RichIterable<T>

Specified by:

collectShort in interface UnsortedBag<T>

flatCollect

public <V> MutableBag<V> flatCollect(Function<? super T, ? extends Iterable<V>> function)

Description copied from interface: MutableCollection

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);

Co-variant example for MutableCollection:

Function<Person, List<Address>> addressFunction = Person::getAddresses;
MutableCollection<Person> people = ...;
MutableCollection<List<Address>> addresses = people.collect(addressFunction);
MutableCollection<Address> addresses = people.flatCollect(addressFunction);

Specified by:

flatCollect in interface MutableBag<T>

Specified by:

flatCollect in interface MutableCollection<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

topOccurrences

public MutableList<ObjectIntPair<T>> topOccurrences(int count)

Description copied from interface: Bag

Returns the count most frequently occurring items. In the event of a tie, all 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>

Specified by:

topOccurrences in interface MutableBagIterable<T>

bottomOccurrences

public MutableList<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>

Specified by:

bottomOccurrences in interface MutableBagIterable<T>

collectIf

public <V> MutableBag<V> collectIf(Predicate<? super T> predicate,
 Function<? super T, ? extends V> function)

Description copied from interface: MutableCollection

Returns a new MutableCollection with the results of applying the specified function to each element of the source collection, but only for elements that evaluate to true for the specified predicate.

MutableCollection<String> collected =
    Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())

Specified by:

collectIf in interface MutableBag<T>

Specified by:

collectIf in interface MutableCollection<T>

Specified by:

collectIf in interface RichIterable<T>

Specified by:

collectIf in interface UnsortedBag<T>

collectWithOccurrences

public <V> MutableBag<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 MutableBag<T>

Specified by:

collectWithOccurrences in interface MutableBagIterable<T>

Specified by:

collectWithOccurrences in interface UnsortedBag<T>

collectWithOccurrences

public <V, R extends Collection<V>> R collectWithOccurrences(ObjectIntToObjectFunction<? super T, ? extends V> function,
 R target)

Description copied from interface: Bag

Iterates over the unique elements and their occurrences and collects the results of applying the specified function into the target collection.

Specified by:

collectWithOccurrences in interface Bag<T>

collectWith

public <P,V> MutableBag<V> collectWith(Function2<? super T, ? super P, ? extends V> function,
 P parameter)

Description copied from interface: MutableCollection

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));

Co-variant example for MutableCollection:

MutableCollection<Integer> integers =
    Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));

Specified by:

collectWith in interface MutableBag<T>

Specified by:

collectWith in interface MutableCollection<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)

newEmpty

public MultiReaderBag<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 MultiReaderBag<T>

Specified by:

newEmpty in interface MutableBag<T>

Specified by:

newEmpty in interface MutableCollection<T>

reject

public MutableBag<T> reject(Predicate<? super T> predicate)

Description copied from interface: MutableCollection

Returns a MutableCollection with all elements that evaluate to false for the specified predicate.

MutableCollection<Person> notSmiths =
    people.reject(person -> person.person.getLastName().equals("Smith"));

Using the Predicates factory:

MutableCollection<Person> notSmiths = people.reject(Predicates.attributeEqual("lastName", "Smith"));

Specified by:

reject in interface Bag<T>

Specified by:

reject in interface MutableBag<T>

Specified by:

reject in interface MutableBagIterable<T>

Specified by:

reject in interface MutableCollection<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

public <P> MutableBag<T> rejectWith(Predicate2<? super T, ? super P> predicate,
 P parameter)

Description copied from interface: MutableCollection

Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.

e.g.
MutableCollection<Integer> selected =
    integers.rejectWith(Predicates2.equal(), Integer.valueOf(5));

Specified by:

rejectWith in interface Bag<T>

Specified by:

rejectWith in interface MutableBag<T>

Specified by:

rejectWith in interface MutableBagIterable<T>

Specified by:

rejectWith in interface MutableCollection<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)

tap

public MultiReaderBag<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()));

Specified by:

tap in interface Bag<T>

Specified by:

tap in interface MultiReaderBag<T>

Specified by:

tap in interface MutableBag<T>

Specified by:

tap in interface MutableBagIterable<T>

Specified by:

tap in interface MutableCollection<T>

Specified by:

tap in interface RichIterable<T>

Specified by:

tap in interface UnsortedBag<T>

See Also:

• RichIterable.each(Procedure)
• RichIterable.forEach(Procedure)

select

public MutableBag<T> select(Predicate<? super T> predicate)

Description copied from interface: MutableCollection

Returns a MutableCollection with all elements that evaluate to true for the specified predicate.

MutableCollection<Integer> livesInLondon =
    people.select(person -> person.getAddress().getCity().equals("London"));

Specified by:

select in interface Bag<T>

Specified by:

select in interface MutableBag<T>

Specified by:

select in interface MutableBagIterable<T>

Specified by:

select in interface MutableCollection<T>

Specified by:

select in interface RichIterable<T>

Specified by:

select in interface UnsortedBag<T>

selectWith

public <P> MutableBag<T> selectWith(Predicate2<? super T, ? super P> predicate,
 P parameter)

Description copied from interface: MutableCollection

Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.

MutableCollection<Integer> fives =
    integers.selectWith(Predicates2.equal(), Integer.valueOf(5));

Specified by:

selectWith in interface Bag<T>

Specified by:

selectWith in interface MutableBag<T>

Specified by:

selectWith in interface MutableBagIterable<T>

Specified by:

selectWith in interface MutableCollection<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)

selectByOccurrences

public MutableBag<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 MutableBag<T>

Specified by:

selectByOccurrences in interface MutableBagIterable<T>

Specified by:

selectByOccurrences in interface UnsortedBag<T>

selectInstancesOf

public <S> MutableBag<S> selectInstancesOf(Class<S> clazz)

Description copied from interface: MutableCollection

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);

Co-variant example for MutableCollection:

MutableCollection<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 MutableBag<T>

Specified by:

selectInstancesOf in interface MutableBagIterable<T>

Specified by:

selectInstancesOf in interface MutableCollection<T>

Specified by:

selectInstancesOf in interface RichIterable<T>

Specified by:

selectInstancesOf in interface UnsortedBag<T>

partition

public PartitionMutableBag<T> partition(Predicate<? super T> predicate)

Description copied from interface: MutableCollection

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"));

Co-variant example for MutableCollection:

PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
    people.partition(person -> person.getAddress().getState().getName().equals("New York"));

Specified by:

partition in interface Bag<T>

Specified by:

partition in interface MutableBag<T>

Specified by:

partition in interface MutableBagIterable<T>

Specified by:

partition in interface MutableCollection<T>

Specified by:

partition in interface RichIterable<T>

Specified by:

partition in interface UnsortedBag<T>

partitionWith

public <P> PartitionMutableBag<T> partitionWith(Predicate2<? super T, ? super P> predicate,
 P parameter)

Description copied from interface: MutableCollection

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");

Co-variant example for MutableCollection:

PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
    people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");

Specified by:

partitionWith in interface Bag<T>

Specified by:

partitionWith in interface MutableBag<T>

Specified by:

partitionWith in interface MutableBagIterable<T>

Specified by:

partitionWith in interface MutableCollection<T>

Specified by:

partitionWith in interface RichIterable<T>

toMapOfItemToCount

public MutableMap<T,Integer> toMapOfItemToCount()

Description copied from interface: Bag

Converts the Bag to a Map of the Item type to its count as an Integer.

Specified by:

toMapOfItemToCount in interface Bag<T>

Specified by:

toMapOfItemToCount in interface MutableBag<T>

Specified by:

toMapOfItemToCount in interface MutableBagIterable<T>

toStringOfItemToCount

public String toStringOfItemToCount()

Description copied from interface: Bag

Returns a string representation of this bag. The string representation consists of a list of element-count mappings.

Assert.assertEquals("{1=1, 2=2, 3=3}", Bags.mutable.with(1, 2, 2, 3, 3, 3).toStringOfItemToCount());

This string representation is similar to AbstractMap.toString(), not RichIterable.toString(), whereas the toString() implementation for a Bag is consistent with RichIterable.toString().

Specified by:

toStringOfItemToCount in interface Bag<T>

Returns:

a string representation of this bag

groupBy

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

Description copied from interface: MutableCollection

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);

Co-variant example for MutableCollection:

MutableMultimap<String, Person> peopleByLastName =
    people.groupBy(Person::getLastName);

Specified by:

groupBy in interface Bag<T>

Specified by:

groupBy in interface MutableBag<T>

Specified by:

groupBy in interface MutableBagIterable<T>

Specified by:

groupBy in interface MutableCollection<T>

Specified by:

groupBy in interface RichIterable<T>

Specified by:

groupBy in interface UnsortedBag<T>

groupByEach

public <V> MutableBagMultimap<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 MutableBag<T>

Specified by:

groupByEach in interface MutableBagIterable<T>

Specified by:

groupByEach in interface MutableCollection<T>

Specified by:

groupByEach in interface RichIterable<T>

Specified by:

groupByEach in interface UnsortedBag<T>

groupByUniqueKey

public <V> MutableMap<V,T> groupByUniqueKey(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 map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.

Specified by:

groupByUniqueKey in interface MutableCollection<T>

Specified by:

groupByUniqueKey in interface RichIterable<T>

See Also:

• RichIterable.groupBy(Function)

zip

@Deprecated
public <S> MutableBag<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 MutableBag<T>

Specified by:

zip in interface MutableCollection<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
public MutableSet<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 MutableBag<T>

Specified by:

zipWithIndex in interface MutableBagIterable<T>

Specified by:

zipWithIndex in interface MutableCollection<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)

chunk

public RichIterable<RichIterable<T>> chunk(int size)

Description copied from interface: RichIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface RichIterable<T>

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing RichIterables of size size, except the last will be truncated if the elements don't divide evenly.

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>

sumByInt

public <V> MutableObjectLongMap<V> sumByInt(Function<? super T, ? extends V> groupBy,
 IntFunction<? super T> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByInt in interface MutableCollection<T>

Specified by:

sumByInt in interface RichIterable<T>

Overrides:

sumByInt in class AbstractMultiReaderMutableCollection<T>

sumByLong

public <V> MutableObjectLongMap<V> sumByLong(Function<? super T, ? extends V> groupBy,
 LongFunction<? super T> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByLong in interface MutableCollection<T>

Specified by:

sumByLong in interface RichIterable<T>

Overrides:

sumByLong in class AbstractMultiReaderMutableCollection<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>

equals

public boolean equals(Object o)

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

Overrides:

equals in class 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 Collection<T>

Overrides:

hashCode in class Object

See Also:

• Map.hashCode()

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

selectUnique

public MutableSet<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 MutableBag<T>

Specified by:

selectUnique in interface MutableBagIterable<T>

Specified by:

selectUnique in interface UnsortedBag<T>

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.