Class UnmodifiableBag<T>
- All Implemented Interfaces:
Serializable
,Iterable<T>
,Collection<T>
,Bag<T>
,MutableBag<T>
,MutableBagIterable<T>
,UnsortedBag<T>
,MutableCollection<T>
,InternalIterable<T>
,RichIterable<T>
public class UnmodifiableBag<T> extends AbstractUnmodifiableMutableCollection<T> implements MutableBag<T>, Serializable
- Since:
- 1.0
- See Also:
MutableBag.asUnmodifiable()
, Serialized Form
-
Method Summary
Modifier and Type Method Description int
addOccurrences(T item, int occurrences)
Add number ofoccurrences
for anitem
.MutableBag<T>
asSynchronized()
Returns a synchronized wrapper backed by this collection.MutableBag<T>
asUnmodifiable()
Returns an unmodifiable view of this collection.MutableList<ObjectIntPair<T>>
bottomOccurrences(int count)
Returns thecount
least frequently occurring items.<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 primitiveboolean
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 primitivebyte
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 primitivechar
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 primitivedouble
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 primitivefloat
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 primitiveint
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 primitivelong
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 primitiveshort
iterable with the results of applying the specified function on each element of the source collection.<P, A> MutableBag<A>
collectWith(Function2<? super T,? super P,? extends A> function, P parameter)
Same asRichIterable.collect(Function)
with aFunction2
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>>
RcollectWithOccurrences(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.boolean
equals(Object obj)
Two bagsb1
andb2
are equal ifm1.toMapOfItemToCount().equals(m2.toMapOfItemToCount())
.<V> MutableBag<V>
flatCollect(Function<? super T,? extends Iterable<V>> function)
flatCollect
is a special case ofRichIterable.collect(Function)
.void
forEachWithOccurrences(ObjectIntProcedure<? super T> objectIntProcedure)
For each distinct item, with the number of occurrences, execute the specified procedure.<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 toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.int
hashCode()
Returns the hash code for this Bag, defined as this.Bag.toMapOfItemToCount()
.hashCode().MutableBag<T>
newEmpty()
Creates a new empty mutable version of the same collection type.int
occurrencesOf(Object item)
The occurrences of a distinct item in the bag.static <E, B extends MutableBag<E>>
UnmodifiableBag<E>of(B bag)
This method will take a MutableBag and wrap it directly in a UnmodifiableBag.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.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 Classclazz
.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.MutableBag<T>
tap(Procedure<? super T> procedure)
Executes the Procedure for each element in the iterable and returnsthis
.ImmutableBag<T>
toImmutable()
Converts thisMutableCollection
to anImmutableCollection
.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 thecount
most frequently occurring items.String
toStringOfItemToCount()
Returns a string representation of this bag.MutableBag<T>
with(T element)
This method allows mutable and fixed size collections the ability to add elements to their existing elements.MutableBag<T>
withAll(Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements.MutableBag<T>
without(T element)
This method allows mutable and fixed size collections the ability to remove elements from their existing elements.MutableBag<T>
withoutAll(Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements.<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 org.eclipse.collections.impl.collection.mutable.AbstractUnmodifiableMutableCollection
add, addAll, addAllIterable, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, 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, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, into, isEmpty, iterator, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, select, selectAndRejectWith, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex
Methods inherited from interface org.eclipse.collections.api.bag.Bag
aggregateBy, reduceInPlace, reduceInPlace, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong
Methods inherited from interface java.util.Collection
add, addAll, clear, contains, containsAll, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray
Methods inherited from interface org.eclipse.collections.api.InternalIterable
forEach, forEachWith, forEachWithIndex
Methods inherited from interface org.eclipse.collections.api.bag.MutableBag
countBy, countByEach, countByWith, flatCollectWith, selectDuplicates
Methods inherited from interface org.eclipse.collections.api.collection.MutableCollection
addAllIterable, aggregateBy, aggregateInPlaceBy, flatCollectWith, groupByUniqueKey, injectIntoWith, removeAllIterable, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, sumByInt, sumByLong
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, contains, containsAll, containsAllArguments, containsAllIterable, containsBy, 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, into, isEmpty, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex
-
Method Details
-
of
This method will take a MutableBag and wrap it directly in a UnmodifiableBag. -
asUnmodifiable
Description copied from interface:MutableCollection
Returns an unmodifiable view of this collection. This is the equivalent of usingCollections.unmodifiableCollection(this)
with a return type that supports the full iteration protocols available onMutableCollection
. Methods which would mutate the underlying collection will throw UnsupportedOperationExceptions.- Specified by:
asUnmodifiable
in interfaceMutableBag<T>
- Specified by:
asUnmodifiable
in interfaceMutableCollection<T>
- Overrides:
asUnmodifiable
in classAbstractUnmodifiableMutableCollection<T>
- Returns:
- an unmodifiable view of this collection.
- See Also:
Collections.unmodifiableCollection(Collection)
-
asSynchronized
Description copied from interface:MutableCollection
Returns a synchronized wrapper backed by this collection. This is the equivalent of usingCollections.synchronizedCollection(this)
only with a return type that supports the full iteration protocols available onMutableCollection
. 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 interfaceMutableBag<T>
- Specified by:
asSynchronized
in interfaceMutableCollection<T>
- Overrides:
asSynchronized
in classAbstractUnmodifiableMutableCollection<T>
- Returns:
- a synchronized view of this collection.
- See Also:
Collections.synchronizedCollection(Collection)
-
toImmutable
Description copied from interface:MutableCollection
Converts thisMutableCollection
to anImmutableCollection
.- Specified by:
toImmutable
in interfaceBag<T>
- Specified by:
toImmutable
in interfaceMutableBag<T>
- Specified by:
toImmutable
in interfaceMutableCollection<T>
- Overrides:
toImmutable
in classAbstractUnmodifiableMutableCollection<T>
-
equals
Description copied from interface:Bag
Two bagsb1
andb2
are equal ifm1.toMapOfItemToCount().equals(m2.toMapOfItemToCount())
.- Specified by:
equals
in interfaceBag<T>
- Specified by:
equals
in interfaceCollection<T>
- Overrides:
equals
in classObject
- 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 interfaceBag<T>
- Specified by:
hashCode
in interfaceCollection<T>
- Overrides:
hashCode
in classObject
- See Also:
Map.hashCode()
-
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 toAbstractMap.toString()
, notRichIterable.toString()
, whereas thetoString()
implementation for a Bag is consistent withRichIterable.toString()
.- Specified by:
toStringOfItemToCount
in interfaceBag<T>
- Returns:
- a string representation of this bag
-
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 interfaceMutableBag<T>
- Specified by:
newEmpty
in interfaceMutableCollection<T>
- Overrides:
newEmpty
in classAbstractUnmodifiableMutableCollection<T>
-
selectByOccurrences
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 interfaceBag<T>
- Specified by:
selectByOccurrences
in interfaceMutableBag<T>
- Specified by:
selectByOccurrences
in interfaceMutableBagIterable<T>
- Specified by:
selectByOccurrences
in interfaceUnsortedBag<T>
-
tap
Description copied from interface:RichIterable
Executes the Procedure for each element in the iterable and returnsthis
.Example using a Java 8 lambda expression:
RichIterable<Person> tapped = people.tap(person -> LOGGER.info(person.getName()));
Example using an anonymous inner class:
RichIterable<Person> tapped = people.tap(new Procedure<Person>() { public void value(Person person) { LOGGER.info(person.getName()); } });
- Specified by:
tap
in interfaceBag<T>
- Specified by:
tap
in interfaceMutableBag<T>
- Specified by:
tap
in interfaceMutableBagIterable<T>
- Specified by:
tap
in interfaceMutableCollection<T>
- Specified by:
tap
in interfaceRichIterable<T>
- Specified by:
tap
in interfaceUnsortedBag<T>
- Overrides:
tap
in classAbstractUnmodifiableMutableCollection<T>
- See Also:
RichIterable.each(Procedure)
,RichIterable.forEach(Procedure)
-
select
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 interfaceBag<T>
- Specified by:
select
in interfaceMutableBag<T>
- Specified by:
select
in interfaceMutableBagIterable<T>
- Specified by:
select
in interfaceMutableCollection<T>
- Specified by:
select
in interfaceRichIterable<T>
- Specified by:
select
in interfaceUnsortedBag<T>
- Overrides:
select
in classAbstractUnmodifiableMutableCollection<T>
-
selectWith
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 interfaceBag<T>
- Specified by:
selectWith
in interfaceMutableBag<T>
- Specified by:
selectWith
in interfaceMutableBagIterable<T>
- Specified by:
selectWith
in interfaceMutableCollection<T>
- Specified by:
selectWith
in interfaceRichIterable<T>
- Specified by:
selectWith
in interfaceUnsortedBag<T>
- Overrides:
selectWith
in classAbstractUnmodifiableMutableCollection<T>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
reject
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 thePredicates
factory:MutableCollection<Person> notSmiths = people.reject(Predicates.attributeEqual("lastName", "Smith"));
- Specified by:
reject
in interfaceBag<T>
- Specified by:
reject
in interfaceMutableBag<T>
- Specified by:
reject
in interfaceMutableBagIterable<T>
- Specified by:
reject
in interfaceMutableCollection<T>
- Specified by:
reject
in interfaceRichIterable<T>
- Specified by:
reject
in interfaceUnsortedBag<T>
- Overrides:
reject
in classAbstractUnmodifiableMutableCollection<T>
- Parameters:
predicate
- aPredicate
to use as the reject criteria- Returns:
- a RichIterable that contains elements that cause
Predicate.accept(Object)
method to evaluate to false
-
rejectWith
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 interfaceBag<T>
- Specified by:
rejectWith
in interfaceMutableBag<T>
- Specified by:
rejectWith
in interfaceMutableBagIterable<T>
- Specified by:
rejectWith
in interfaceMutableCollection<T>
- Specified by:
rejectWith
in interfaceRichIterable<T>
- Specified by:
rejectWith
in interfaceUnsortedBag<T>
- Overrides:
rejectWith
in classAbstractUnmodifiableMutableCollection<T>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
partition
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"));
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(new Predicate<Person>() { public boolean accept(Person person) { return 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 interfaceBag<T>
- Specified by:
partition
in interfaceMutableBag<T>
- Specified by:
partition
in interfaceMutableBagIterable<T>
- Specified by:
partition
in interfaceMutableCollection<T>
- Specified by:
partition
in interfaceRichIterable<T>
- Specified by:
partition
in interfaceUnsortedBag<T>
- Overrides:
partition
in classAbstractUnmodifiableMutableCollection<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");
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith(new Predicate2<Person, String>() { public boolean accept(Person person, String state) { return 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 interfaceBag<T>
- Specified by:
partitionWith
in interfaceMutableBag<T>
- Specified by:
partitionWith
in interfaceMutableBagIterable<T>
- Specified by:
partitionWith
in interfaceMutableCollection<T>
- Specified by:
partitionWith
in interfaceRichIterable<T>
- Overrides:
partitionWith
in classAbstractUnmodifiableMutableCollection<T>
-
selectInstancesOf
Description copied from interface:MutableCollection
Returns all elements of the source collection that are instances of the Classclazz
.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 interfaceBag<T>
- Specified by:
selectInstancesOf
in interfaceMutableBag<T>
- Specified by:
selectInstancesOf
in interfaceMutableBagIterable<T>
- Specified by:
selectInstancesOf
in interfaceMutableCollection<T>
- Specified by:
selectInstancesOf
in interfaceRichIterable<T>
- Specified by:
selectInstancesOf
in interfaceUnsortedBag<T>
- Overrides:
selectInstancesOf
in classAbstractUnmodifiableMutableCollection<T>
-
collect
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 interfaceMutableBag<T>
- Specified by:
collect
in interfaceMutableCollection<T>
- Specified by:
collect
in interfaceRichIterable<T>
- Specified by:
collect
in interfaceUnsortedBag<T>
- Overrides:
collect
in classAbstractUnmodifiableMutableCollection<T>
-
collectBoolean
Description copied from interface:MutableCollection
Returns a new primitiveboolean
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());
Example using an anonymous inner class:
BooleanIterable licenses = people.collectBoolean(new BooleanFunction<Person>() { public boolean booleanValueOf(Person person) { return person.hasDrivingLicense(); } });
Co-variant example for MutableCollection:MutableBooleanCollection licenses = people.collectBoolean(person -> person.hasDrivingLicense());
- Specified by:
collectBoolean
in interfaceMutableBag<T>
- Specified by:
collectBoolean
in interfaceMutableCollection<T>
- Specified by:
collectBoolean
in interfaceRichIterable<T>
- Specified by:
collectBoolean
in interfaceUnsortedBag<T>
- Overrides:
collectBoolean
in classAbstractUnmodifiableMutableCollection<T>
-
collectByte
Description copied from interface:MutableCollection
Returns a new primitivebyte
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());
Example using an anonymous inner class:
ByteIterable bytes = people.collectByte(new ByteFunction<Person>() { public byte byteValueOf(Person person) { return person.getCode(); } });
Co-variant example for MutableCollection:MutableByteCollection bytes = people.collectByte(person -> person.getCode());
- Specified by:
collectByte
in interfaceMutableBag<T>
- Specified by:
collectByte
in interfaceMutableCollection<T>
- Specified by:
collectByte
in interfaceRichIterable<T>
- Specified by:
collectByte
in interfaceUnsortedBag<T>
- Overrides:
collectByte
in classAbstractUnmodifiableMutableCollection<T>
-
collectChar
Description copied from interface:MutableCollection
Returns a new primitivechar
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());
Example using an anonymous inner class:
CharIterable chars = people.collectChar(new CharFunction<Person>() { public char charValueOf(Person person) { return person.getMiddleInitial(); } });
Co-variant example for MutableCollection:MutableCharCollection chars = people.collectChar(person -> person.getMiddleInitial());
- Specified by:
collectChar
in interfaceMutableBag<T>
- Specified by:
collectChar
in interfaceMutableCollection<T>
- Specified by:
collectChar
in interfaceRichIterable<T>
- Specified by:
collectChar
in interfaceUnsortedBag<T>
- Overrides:
collectChar
in classAbstractUnmodifiableMutableCollection<T>
-
collectDouble
Description copied from interface:MutableCollection
Returns a new primitivedouble
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());
Example using an anonymous inner class:
DoubleIterable doubles = people.collectDouble(new DoubleFunction<Person>() { public double doubleValueOf(Person person) { return person.getMilesFromNorthPole(); } });
Co-variant example for MutableCollection:MutableDoubleCollection doubles = people.collectDouble(person -> person.getMilesFromNorthPole());
- Specified by:
collectDouble
in interfaceMutableBag<T>
- Specified by:
collectDouble
in interfaceMutableCollection<T>
- Specified by:
collectDouble
in interfaceRichIterable<T>
- Specified by:
collectDouble
in interfaceUnsortedBag<T>
- Overrides:
collectDouble
in classAbstractUnmodifiableMutableCollection<T>
-
collectFloat
Description copied from interface:MutableCollection
Returns a new primitivefloat
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());
Example using an anonymous inner class:
FloatIterable floats = people.collectFloat(new FloatFunction<Person>() { public float floatValueOf(Person person) { return person.getHeightInInches(); } });
Co-variant example for MutableCollection:MutableFloatCollection floats = people.collectFloat(person -> person.getHeightInInches());
- Specified by:
collectFloat
in interfaceMutableBag<T>
- Specified by:
collectFloat
in interfaceMutableCollection<T>
- Specified by:
collectFloat
in interfaceRichIterable<T>
- Specified by:
collectFloat
in interfaceUnsortedBag<T>
- Overrides:
collectFloat
in classAbstractUnmodifiableMutableCollection<T>
-
collectInt
Description copied from interface:MutableCollection
Returns a new primitiveint
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());
Example using an anonymous inner class:
IntIterable ints = people.collectInt(new IntFunction<Person>() { public int intValueOf(Person person) { return person.getAge(); } });
Co-variant example for MutableCollection:MutableIntCollection ints = people.collectInt(person -> person.getAge());
- Specified by:
collectInt
in interfaceMutableBag<T>
- Specified by:
collectInt
in interfaceMutableCollection<T>
- Specified by:
collectInt
in interfaceRichIterable<T>
- Specified by:
collectInt
in interfaceUnsortedBag<T>
- Overrides:
collectInt
in classAbstractUnmodifiableMutableCollection<T>
-
collectLong
Description copied from interface:MutableCollection
Returns a new primitivelong
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());
Example using an anonymous inner class:
LongIterable longs = people.collectLong(new LongFunction<Person>() { public long longValueOf(Person person) { return person.getGuid(); } });
Co-variant example for MutableCollection:MutableLongCollection longs = people.collectLong(person -> person.getGuid());
- Specified by:
collectLong
in interfaceMutableBag<T>
- Specified by:
collectLong
in interfaceMutableCollection<T>
- Specified by:
collectLong
in interfaceRichIterable<T>
- Specified by:
collectLong
in interfaceUnsortedBag<T>
- Overrides:
collectLong
in classAbstractUnmodifiableMutableCollection<T>
-
collectShort
Description copied from interface:MutableCollection
Returns a new primitiveshort
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());
Example using an anonymous inner class:
ShortIterable shorts = people.collectShort(new ShortFunction<Person>() { public short shortValueOf(Person person) { return person.getNumberOfJunkMailItemsReceivedPerMonth(); } });
Co-variant example for MutableCollection:MutableShortCollection shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
- Specified by:
collectShort
in interfaceMutableBag<T>
- Specified by:
collectShort
in interfaceMutableCollection<T>
- Specified by:
collectShort
in interfaceRichIterable<T>
- Specified by:
collectShort
in interfaceUnsortedBag<T>
- Overrides:
collectShort
in classAbstractUnmodifiableMutableCollection<T>
-
flatCollect
Description copied from interface:MutableCollection
flatCollect
is a special case ofRichIterable.collect(Function)
. Withcollect
, when theFunction
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 eachPerson
has a list ofAddress
objects. Take the followingFunction
:Function<Person, List<Address>> addressFunction = Person::getAddresses; RichIterable<Person> people = ...;
Usingcollect
returns a collection of collections of addresses.RichIterable<List<Address>> addresses = people.collect(addressFunction);
UsingflatCollect
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 interfaceMutableBag<T>
- Specified by:
flatCollect
in interfaceMutableCollection<T>
- Specified by:
flatCollect
in interfaceRichIterable<T>
- Specified by:
flatCollect
in interfaceUnsortedBag<T>
- Overrides:
flatCollect
in classAbstractUnmodifiableMutableCollection<T>
- Parameters:
function
- TheFunction
to apply- Returns:
- a new flattened collection produced by applying the given
function
-
topOccurrences
Description copied from interface:Bag
Returns thecount
most 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:
topOccurrences
in interfaceBag<T>
- Specified by:
topOccurrences
in interfaceMutableBagIterable<T>
-
bottomOccurrences
Description copied from interface:Bag
Returns thecount
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 interfaceBag<T>
- Specified by:
bottomOccurrences
in interfaceMutableBagIterable<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 interfaceBag<T>
- Specified by:
collectWithOccurrences
in interfaceMutableBag<T>
- Specified by:
collectWithOccurrences
in interfaceMutableBagIterable<T>
- Specified by:
collectWithOccurrences
in interfaceUnsortedBag<T>
-
collectWith
public <P, A> MutableBag<A> collectWith(Function2<? super T,? super P,? extends A> function, P parameter)Description copied from interface:MutableCollection
Same asRichIterable.collect(Function)
with aFunction2
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));
Example using an anonymous inner class:
Function2<Integer, Integer, Integer> addParameterFunction = new Function2<Integer, Integer, Integer>() { public Integer value(Integer each, Integer parameter) { return each + parameter; } }; RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, 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 interfaceMutableBag<T>
- Specified by:
collectWith
in interfaceMutableCollection<T>
- Specified by:
collectWith
in interfaceRichIterable<T>
- Specified by:
collectWith
in interfaceUnsortedBag<T>
- Overrides:
collectWith
in classAbstractUnmodifiableMutableCollection<T>
- Parameters:
function
- AFunction2
to use as the collect transformation functionparameter
- A parameter to pass in for evaluation of the second argumentP
infunction
- Returns:
- A new
RichIterable
that contains the transformed elements returned byFunction2.value(Object, Object)
- See Also:
RichIterable.collect(Function)
-
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 interfaceMutableBag<T>
- Specified by:
collectIf
in interfaceMutableCollection<T>
- Specified by:
collectIf
in interfaceRichIterable<T>
- Specified by:
collectIf
in interfaceUnsortedBag<T>
- Overrides:
collectIf
in classAbstractUnmodifiableMutableCollection<T>
-
groupBy
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);
Example using an anonymous inner class:
Multimap<String, Person> peopleByLastName = people.groupBy(new Function<Person, String>() { public String valueOf(Person person) { return person.getLastName(); } });
Co-variant example for MutableCollection:MutableMultimap<String, Person> peopleByLastName = people.groupBy(Person::getLastName);
- Specified by:
groupBy
in interfaceBag<T>
- Specified by:
groupBy
in interfaceMutableBag<T>
- Specified by:
groupBy
in interfaceMutableBagIterable<T>
- Specified by:
groupBy
in interfaceMutableCollection<T>
- Specified by:
groupBy
in interfaceRichIterable<T>
- Specified by:
groupBy
in interfaceUnsortedBag<T>
- Overrides:
groupBy
in classAbstractUnmodifiableMutableCollection<T>
-
groupByEach
public <V> MutableBagMultimap<V,T> groupByEach(Function<? super T,? extends Iterable<V>> function)Description copied from interface:RichIterable
Similar toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.- Specified by:
groupByEach
in interfaceBag<T>
- Specified by:
groupByEach
in interfaceMutableBag<T>
- Specified by:
groupByEach
in interfaceMutableBagIterable<T>
- Specified by:
groupByEach
in interfaceMutableCollection<T>
- Specified by:
groupByEach
in interfaceRichIterable<T>
- Specified by:
groupByEach
in interfaceUnsortedBag<T>
- Overrides:
groupByEach
in classAbstractUnmodifiableMutableCollection<T>
-
addOccurrences
Description copied from interface:MutableBagIterable
Add number ofoccurrences
for anitem
. If theitem
does not exist, then theitem
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 interfaceMutableBagIterable<T>
- Returns:
- updated number of occurrences.
-
removeOccurrences
- Specified by:
removeOccurrences
in interfaceMutableBagIterable<T>
-
setOccurrences
- Specified by:
setOccurrences
in interfaceMutableBagIterable<T>
-
sizeDistinct
public int sizeDistinct()Description copied from interface:Bag
The size of the Bag when counting only distinct elements.- Specified by:
sizeDistinct
in interfaceBag<T>
-
occurrencesOf
Description copied from interface:Bag
The occurrences of a distinct item in the bag.- Specified by:
occurrencesOf
in interfaceBag<T>
-
forEachWithOccurrences
Description copied from interface:Bag
For each distinct item, with the number of occurrences, execute the specified procedure.- Specified by:
forEachWithOccurrences
in interfaceBag<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 interfaceBag<T>
- Since:
- 9.1.
-
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 interfaceBag<T>
- Specified by:
toMapOfItemToCount
in interfaceMutableBag<T>
- Specified by:
toMapOfItemToCount
in interfaceMutableBagIterable<T>
-
zip
Deprecated.in 6.0. UseOrderedIterable.zip(Iterable)
instead.Description copied from interface:RichIterable
Returns aRichIterable
formed from thisRichIterable
and anotherRichIterable
by combining corresponding elements in pairs. If one of the twoRichIterable
s is longer than the other, its remaining elements are ignored.- Specified by:
zip
in interfaceMutableBag<T>
- Specified by:
zip
in interfaceMutableCollection<T>
- Specified by:
zip
in interfaceRichIterable<T>
- Specified by:
zip
in interfaceUnsortedBag<T>
- Overrides:
zip
in classAbstractUnmodifiableMutableCollection<T>
- Type Parameters:
S
- the type of the second half of the returned pairs- Parameters:
that
- TheRichIterable
providing the second half of each result pair- Returns:
- A new
RichIterable
containing pairs consisting of corresponding elements of thisRichIterable
and that. The length of the returnedRichIterable
is the minimum of the lengths of thisRichIterable
and that.
-
zipWithIndex
Deprecated.in 6.0. UseOrderedIterable.zipWithIndex()
instead.Description copied from interface:RichIterable
Zips thisRichIterable
with its indices.- Specified by:
zipWithIndex
in interfaceBag<T>
- Specified by:
zipWithIndex
in interfaceMutableBag<T>
- Specified by:
zipWithIndex
in interfaceMutableBagIterable<T>
- Specified by:
zipWithIndex
in interfaceMutableCollection<T>
- Specified by:
zipWithIndex
in interfaceRichIterable<T>
- Specified by:
zipWithIndex
in interfaceUnsortedBag<T>
- Overrides:
zipWithIndex
in classAbstractUnmodifiableMutableCollection<T>
- Returns:
- A new
RichIterable
containing pairs consisting of all elements of thisRichIterable
paired with their index. Indices start at 0. - See Also:
RichIterable.zip(Iterable)
-
with
Description copied from interface:MutableCollection
This method allows mutable and fixed size collections the ability to add elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new element to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:MutableCollection<String> list = list.with("1"); list = list.with("2"); return list;
In the case ofFixedSizeCollection
a new instance of MutableCollection will be returned by with, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling add on itself.- Specified by:
with
in interfaceMutableBag<T>
- Specified by:
with
in interfaceMutableBagIterable<T>
- Specified by:
with
in interfaceMutableCollection<T>
- Overrides:
with
in classAbstractUnmodifiableMutableCollection<T>
- See Also:
Collection.add(Object)
-
without
Description copied from interface:MutableCollection
This method allows mutable and fixed size collections the ability to remove elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling remove. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:MutableCollection<String> list = list.without("1"); list = list.without("2"); return list;
In the case ofFixedSizeCollection
a new instance of MutableCollection will be returned by without, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling remove on itself.- Specified by:
without
in interfaceMutableBag<T>
- Specified by:
without
in interfaceMutableBagIterable<T>
- Specified by:
without
in interfaceMutableCollection<T>
- Overrides:
without
in classAbstractUnmodifiableMutableCollection<T>
- See Also:
Collection.remove(Object)
-
withAll
Description copied from interface:MutableCollection
This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new elements to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:MutableCollection<String> list = list.withAll(FastList.newListWith("1", "2"));
In the case ofFixedSizeCollection
a new instance of MutableCollection will be returned by withAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling addAll on itself.- Specified by:
withAll
in interfaceMutableBag<T>
- Specified by:
withAll
in interfaceMutableBagIterable<T>
- Specified by:
withAll
in interfaceMutableCollection<T>
- Overrides:
withAll
in classAbstractUnmodifiableMutableCollection<T>
- See Also:
Collection.addAll(Collection)
-
withoutAll
Description copied from interface:MutableCollection
This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling removeAll. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:MutableCollection<String> list = list.withoutAll(FastList.newListWith("1", "2"));
In the case ofFixedSizeCollection
a new instance of MutableCollection will be returned by withoutAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling removeAll on itself.- Specified by:
withoutAll
in interfaceMutableBag<T>
- Specified by:
withoutAll
in interfaceMutableBagIterable<T>
- Specified by:
withoutAll
in interfaceMutableCollection<T>
- Overrides:
withoutAll
in classAbstractUnmodifiableMutableCollection<T>
- See Also:
Collection.removeAll(Collection)
-
selectUnique
Description copied from interface:Bag
Returns a set containing all elements of the bag that have exactly one occurrence.- Specified by:
selectUnique
in interfaceBag<T>
- Specified by:
selectUnique
in interfaceMutableBag<T>
- Specified by:
selectUnique
in interfaceMutableBagIterable<T>
- Specified by:
selectUnique
in interfaceUnsortedBag<T>
-