public class UnmodifiableBag<T> extends AbstractUnmodifiableMutableCollection<T> implements MutableBag<T>, Serializable
MutableBag.asUnmodifiable(),
Serialized Form| Modifier and Type | Method and Description |
|---|---|
void |
addOccurrences(T item,
int occurrences) |
MutableBag<T> |
asSynchronized()
Returns a synchronized (thread-safe) collection backed by this collection.
|
MutableBag<T> |
asUnmodifiable()
Returns an unmodifiable view of this collection.
|
<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,A> MutableBag<A> |
collectWith(Function2<? super T,? super P,? extends A> function,
P parameter)
Same as collect with a
Function2 and specified parameter which is passed to the block
|
boolean |
equals(Object obj)
Two bagsb1 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> 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 to
RichIterable.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>> |
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 Class
clazz. |
<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.
|
ImmutableBag<T> |
toImmutable()
Converts this MutableCollection to an ImmutableCollection.
|
MapIterable<T,Integer> |
toMapOfItemToCount()
Converts the Bag to a Map of the Item type to its count as an Integer.
|
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)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
MutableSet<Pair<T,Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
add, addAll, addAllIterable, aggregateBy, 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, detectWith, detectWithIfNone, flatCollect, forEach, forEachWith, forEachWithIndex, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, 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, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndexaggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndexforEach, forEachWith, forEachWithIndexforEach, iterator, spliteratoraddAllIterable, aggregateBy, aggregateInPlaceBy, groupByUniqueKey, injectIntoWith, removeAllIterable, removeIf, removeIfWith, retainAllIterable, selectAndRejectWithadd, addAll, clear, contains, containsAll, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArraypublic static <E,B extends MutableBag<E>> UnmodifiableBag<E> of(B bag)
public MutableBag<T> asUnmodifiable()
MutableCollectionThe returned collection will be serializable if this collection is serializable.
asUnmodifiable in interface MutableBag<T>asUnmodifiable in interface MutableCollection<T>asUnmodifiable in class AbstractUnmodifiableMutableCollection<T>public MutableBag<T> asSynchronized()
MutableCollection
MutableCollection collection = myCollection.asSynchronized();
...
synchronized(collection)
{
Iterator i = c.iterator(); // Must be in the synchronized block
while (i.hasNext())
foo(i.next());
}
Failure to follow this advice may result in non-deterministic behavior.
The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is
properly synchronized internally.
MutableCollection collection = myCollection.asSynchronized();
...
collection.forEach(new Procedure()
{
public void value(Object each)
{
...
}
});
The returned collection does not pass the hashCode and equals operations through to the
backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve
the contracts of these operations in the case that the backing collection is a set or a list.
The returned collection will be serializable if this collection is serializable.asSynchronized in interface MutableBag<T>asSynchronized in interface MutableCollection<T>asSynchronized in class AbstractUnmodifiableMutableCollection<T>public ImmutableBag<T> toImmutable()
MutableCollectiontoImmutable in interface UnsortedBag<T>toImmutable in interface MutableCollection<T>toImmutable in class AbstractUnmodifiableMutableCollection<T>public boolean equals(Object obj)
Bagequals in interface Bag<T>equals in interface Collection<T>equals in class ObjectMap.equals(Object)public int hashCode()
BagBag.toMapOfItemToCount().hashCode().hashCode in interface Bag<T>hashCode in interface Collection<T>hashCode in class ObjectMap.hashCode()public String toStringOfItemToCount()
BagBag.forEachWithOccurrences(ObjectIntProcedure)
and Iterable.iterator(). The element-count mappings are enclosed in braces ("{}"). Adjacent mappings are
separated by the characters ", " (comma and space). Each element-count mapping is rendered as the element
followed by an equals sign ("=") followed by the number of ooccurrences. Elements and are converted to
strings as by String.valueOf(Object).
The string representation is similar to AbstractMap.toString(), not RichIterable.toString().toStringOfItemToCount in interface Bag<T>public MutableBag<T> newEmpty()
MutableCollectionnewEmpty in interface MutableBag<T>newEmpty in interface MutableCollection<T>newEmpty in class AbstractUnmodifiableMutableCollection<T>public MutableBag<T> selectByOccurrences(IntPredicate predicate)
BagselectByOccurrences in interface Bag<T>selectByOccurrences in interface MutableBag<T>selectByOccurrences in interface UnsortedBag<T>public MutableBag<T> select(Predicate<? super T> predicate)
MutableCollectione.g.
return people.select(new Predicate<Person>()
{
public boolean value(Person person)
{
return person.getAddress().getCity().equals("Metuchen");
}
});
select in interface Bag<T>select in interface MutableBag<T>select in interface UnsortedBag<T>select in interface MutableCollection<T>select in interface RichIterable<T>select in class AbstractUnmodifiableMutableCollection<T>public <P> MutableBag<T> selectWith(Predicate2<? super T,? super P> predicate, P parameter)
MutableCollectione.g. return integers.selectWith(PredicatesLite.equal(), Integer.valueOf(5));
selectWith in interface Bag<T>selectWith in interface MutableBag<T>selectWith in interface UnsortedBag<T>selectWith in interface MutableCollection<T>selectWith in interface RichIterable<T>selectWith in class AbstractUnmodifiableMutableCollection<T>predicate - a Predicate2 to use as the select criteriaparameter - a parameter to pass in for evaluation of the second argument P in predicateRichIterable.select(Predicate)public MutableBag<T> reject(Predicate<? super T> predicate)
MutableCollectione.g.
return people.reject(new Predicate<Person>()
{
public boolean value(Person person)
{
return person.person.getLastName().equals("Smith");
}
});
e.g.
return people.reject(Predicates.attributeEqual("lastName", "Smith"));
reject in interface Bag<T>reject in interface MutableBag<T>reject in interface UnsortedBag<T>reject in interface MutableCollection<T>reject in interface RichIterable<T>reject in class AbstractUnmodifiableMutableCollection<T>predicate - a Predicate to use as the reject criteriaPredicate.accept(Object) method to evaluate to falsepublic <P> MutableBag<T> rejectWith(Predicate2<? super T,? super P> predicate, P parameter)
MutableCollectione.g. return integers.rejectWith(PredicatesLite.equal(), Integer.valueOf(5));
rejectWith in interface Bag<T>rejectWith in interface MutableBag<T>rejectWith in interface UnsortedBag<T>rejectWith in interface MutableCollection<T>rejectWith in interface RichIterable<T>rejectWith in class AbstractUnmodifiableMutableCollection<T>predicate - a Predicate2 to use as the select criteriaparameter - a parameter to pass in for evaluation of the second argument P in predicateRichIterable.select(Predicate)public PartitionMutableBag<T> partition(Predicate<? super T> predicate)
RichIterablee.g.
return people.partition(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.getAddress().getState().getName().equals("New York");
}
});
partition in interface Bag<T>partition in interface MutableBag<T>partition in interface UnsortedBag<T>partition in interface MutableCollection<T>partition in interface RichIterable<T>partition in class AbstractUnmodifiableMutableCollection<T>public <P> PartitionMutableBag<T> partitionWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterablee.g.
return people.partitionWith(new Predicate2<Person, String>()
{
public boolean accept(Person person, String state)
{
return person.getAddress().getState().getName().equals(state);
}
}, "New York");
partitionWith in interface Bag<T>partitionWith in interface MutableBag<T>partitionWith in interface MutableCollection<T>partitionWith in interface RichIterable<T>partitionWith in class AbstractUnmodifiableMutableCollection<T>public <S> MutableBag<S> selectInstancesOf(Class<S> clazz)
RichIterableclazz.selectInstancesOf in interface Bag<T>selectInstancesOf in interface MutableBag<T>selectInstancesOf in interface UnsortedBag<T>selectInstancesOf in interface MutableCollection<T>selectInstancesOf in interface RichIterable<T>selectInstancesOf in class AbstractUnmodifiableMutableCollection<T>public <V> MutableBag<V> collect(Function<? super T,? extends V> function)
MutableCollectione.g.
return people.collect(new Function<Person, String>()
{
public String value(Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
collect in interface MutableBag<T>collect in interface UnsortedBag<T>collect in interface MutableCollection<T>collect in interface RichIterable<T>collect in class AbstractUnmodifiableMutableCollection<T>public MutableBooleanBag collectBoolean(BooleanFunction<? super T> booleanFunction)
RichIterableboolean 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.
e.g.
return people.collectBoolean(new BooleanFunction<Person>()
{
public boolean booleanValueOf(Person person)
{
return person.hasDrivingLicense();
}
});
collectBoolean in interface MutableBag<T>collectBoolean in interface UnsortedBag<T>collectBoolean in interface MutableCollection<T>collectBoolean in interface RichIterable<T>collectBoolean in class AbstractUnmodifiableMutableCollection<T>public MutableByteBag collectByte(ByteFunction<? super T> byteFunction)
RichIterablebyte 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.
e.g.
return people.collectByte(new ByteFunction<Person>()
{
public byte byteValueOf(Person person)
{
return person.getCode();
}
});
collectByte in interface MutableBag<T>collectByte in interface UnsortedBag<T>collectByte in interface MutableCollection<T>collectByte in interface RichIterable<T>collectByte in class AbstractUnmodifiableMutableCollection<T>public MutableCharBag collectChar(CharFunction<? super T> charFunction)
RichIterablechar 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.
e.g.
return people.collectChar(new CharFunction<Person>()
{
public char charValueOf(Person person)
{
return person.getMiddleInitial();
}
});
collectChar in interface MutableBag<T>collectChar in interface UnsortedBag<T>collectChar in interface MutableCollection<T>collectChar in interface RichIterable<T>collectChar in class AbstractUnmodifiableMutableCollection<T>public MutableDoubleBag collectDouble(DoubleFunction<? super T> doubleFunction)
RichIterabledouble 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.
e.g.
return people.collectDouble(new DoubleFunction<Person>()
{
public double doubleValueOf(Person person)
{
return person.getMilesFromNorthPole();
}
});
collectDouble in interface MutableBag<T>collectDouble in interface UnsortedBag<T>collectDouble in interface MutableCollection<T>collectDouble in interface RichIterable<T>collectDouble in class AbstractUnmodifiableMutableCollection<T>public MutableFloatBag collectFloat(FloatFunction<? super T> floatFunction)
RichIterablefloat 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.
e.g.
return people.collectFloat(new FloatFunction<Person>()
{
public float floatValueOf(Person person)
{
return person.getHeightInInches();
}
});
collectFloat in interface MutableBag<T>collectFloat in interface UnsortedBag<T>collectFloat in interface MutableCollection<T>collectFloat in interface RichIterable<T>collectFloat in class AbstractUnmodifiableMutableCollection<T>public MutableIntBag collectInt(IntFunction<? super T> intFunction)
RichIterableint 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.
e.g.
return people.collectInt(new IntFunction<Person>()
{
public int intValueOf(Person person)
{
return person.getAge();
}
});
collectInt in interface MutableBag<T>collectInt in interface UnsortedBag<T>collectInt in interface MutableCollection<T>collectInt in interface RichIterable<T>collectInt in class AbstractUnmodifiableMutableCollection<T>public MutableLongBag collectLong(LongFunction<? super T> longFunction)
RichIterablelong 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.
e.g.
return people.collectLong(new LongFunction<Person>()
{
public long longValueOf(Person person)
{
return person.getGuid();
}
});
collectLong in interface MutableBag<T>collectLong in interface UnsortedBag<T>collectLong in interface MutableCollection<T>collectLong in interface RichIterable<T>collectLong in class AbstractUnmodifiableMutableCollection<T>public MutableShortBag collectShort(ShortFunction<? super T> shortFunction)
RichIterableshort 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.
e.g.
return people.collectShort(new ShortFunction<Person>()
{
public short shortValueOf(Person person)
{
return person.getNumberOfJunkMailItemsReceivedPerMonth();
}
});
collectShort in interface MutableBag<T>collectShort in interface UnsortedBag<T>collectShort in interface MutableCollection<T>collectShort in interface RichIterable<T>collectShort in class AbstractUnmodifiableMutableCollection<T>public <V> MutableBag<V> flatCollect(Function<? super T,? extends Iterable<V>> function)
RichIterableflatCollect 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 = new Function<Person, List<Address>>()
{
public List<Address> valueOf(Person person)
{
return person.getAddresses();
}
};
MutableList<Person> people = ...;
Using collect returns a collection of collections of addresses.
MutableList<List<Address>> addresses = people.collect(addressFunction);Using
flatCollect returns a single flattened list of addresses.
MutableList<Address> addresses = people.flatCollect(addressFunction);
flatCollect in interface MutableBag<T>flatCollect in interface UnsortedBag<T>flatCollect in interface MutableCollection<T>flatCollect in interface RichIterable<T>flatCollect in class AbstractUnmodifiableMutableCollection<T>function - The Function to applyfunctionpublic <P,A> MutableBag<A> collectWith(Function2<? super T,? super P,? extends A> function, P parameter)
RichIterableFunction2 and specified parameter which is passed to the block