@ThreadSafe public class SynchronizedSortedBag<T> extends AbstractSynchronizedMutableCollection<T> implements com.gs.collections.api.bag.sorted.MutableSortedBag<T>, java.io.Serializable
MutableSortedBag. It is imperative that the user manually synchronize on the collection when iterating over it using the
standard JDK iterator or JDK 5 for loop, as per Collections.synchronizedCollection(Collection).MutableSortedBag.asSynchronized(),
Serialized Formdelegate, lock| Modifier and Type | Method and Description |
|---|---|
void |
addOccurrences(T item,
int occurrences) |
com.gs.collections.api.bag.ParallelBag<T> |
asParallel(java.util.concurrent.ExecutorService executorService,
int batchSize) |
com.gs.collections.api.LazyIterable<T> |
asReversed()
Returns a reversed view of this ReversibleIterable.
|
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
asSynchronized()
Returns a synchronized (thread-safe) collection backed by this collection.
|
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
asUnmodifiable()
Returns an unmodifiable view of the set.
|
com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.primitive.ObjectIntPair<T>> |
bottomOccurrences(int count)
Returns the
count least frequently occurring items. |
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
clone() |
<V> com.gs.collections.api.list.MutableList<V> |
collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source
collection.
|
com.gs.collections.api.list.primitive.MutableBooleanList |
collectBoolean(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.list.primitive.MutableByteList |
collectByte(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.list.primitive.MutableCharList |
collectChar(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.list.primitive.MutableDoubleList |
collectDouble(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.list.primitive.MutableFloatList |
collectFloat(com.gs.collections.api.block.function.primitive.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> com.gs.collections.api.list.MutableList<V> |
collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
com.gs.collections.api.block.function.Function<? super T,? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source
collection, but only for those elements which return true upon evaluation of the predicate.
|
com.gs.collections.api.list.primitive.MutableIntList |
collectInt(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.list.primitive.MutableLongList |
collectLong(com.gs.collections.api.block.function.primitive.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. |
com.gs.collections.api.list.primitive.MutableShortList |
collectShort(com.gs.collections.api.block.function.primitive.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> com.gs.collections.api.list.MutableList<V> |
collectWith(com.gs.collections.api.block.function.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. |
java.util.Comparator<? super T> |
comparator()
Returns the comparator used to order the elements in this bag, or null if this bag uses the natural ordering of
its elements.
|
int |
compareTo(com.gs.collections.api.bag.sorted.SortedBag<T> o) |
<S> boolean |
corresponds(com.gs.collections.api.ordered.OrderedIterable<S> other,
com.gs.collections.api.block.predicate.Predicate2<? super T,? super S> predicate)
Returns true if both OrderedIterables have the same length
and
predicate returns true for all corresponding elements e1 of
this OrderedIterable and e2 of other. |
int |
detectIndex(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns the index of the first element of the
OrderedIterable for which the predicate evaluates to true. |
int |
detectLastIndex(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns the index of the last element of the
ReversibleIterable for which the predicate evaluates to true. |
com.gs.collections.api.set.sorted.MutableSortedSet<T> |
distinct()
Returns a new
SortedIterable containing the distinct elements in this iterable. |
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
drop(int count)
Returns an iterable after skipping the first
count elements
or an empty iterable if the count is greater than the length of the iterable. |
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
dropWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns the final elements that do not satisfy the Predicate.
|
<V> com.gs.collections.api.list.MutableList<V> |
flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
flatCollect is a special case of RichIterable.collect(Function). |
void |
forEach(int startIndex,
int endIndex,
com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
Iterates over the section of the iterable covered by the specified inclusive indexes.
|
void |
forEachWithIndex(int fromIndex,
int toIndex,
com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)
Iterates over the section of the iterable covered by the specified inclusive indexes.
|
void |
forEachWithOccurrences(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> procedure)
For each distinct item, with the number of occurrences, execute the specified procedure.
|
protected com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
getDelegate() |
<V> com.gs.collections.api.multimap.sortedbag.MutableSortedBagMultimap<V,T> |
groupBy(com.gs.collections.api.block.function.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> com.gs.collections.api.multimap.sortedbag.MutableSortedBagMultimap<V,T> |
groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
Similar to
RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys
for each value. |
int |
indexOf(java.lang.Object object)
Returns the index of the first occurrence of the specified item
in this iterable, or -1 if this iterable does not contain the item.
|
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
newEmpty()
Creates a new empty mutable version of the same collection type.
|
int |
occurrencesOf(java.lang.Object item)
The occurrences of a distinct item in the bag.
|
static <E> SynchronizedSortedBag<E> |
of(com.gs.collections.api.bag.sorted.MutableSortedBag<E> bag) |
static <E> com.gs.collections.api.bag.sorted.MutableSortedBag<E> |
of(com.gs.collections.api.bag.sorted.MutableSortedBag<E> bag,
java.lang.Object lock) |
com.gs.collections.api.partition.bag.sorted.PartitionMutableSortedBag<T> |
partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
com.gs.collections.api.partition.bag.sorted.PartitionMutableSortedBag<T> |
partitionWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
|
<P> com.gs.collections.api.partition.bag.sorted.PartitionMutableSortedBag<T> |
partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
|
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns all elements of the source collection that return false when evaluating of the predicate.
|
<P> com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Similar to
RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2. |
boolean |
removeOccurrences(java.lang.Object item,
int occurrences) |
void |
reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
Evaluates the procedure for each element of the list iterating in reverse order.
|
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns all elements of the source collection that return true when evaluating the predicate.
|
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
selectByOccurrences(com.gs.collections.api.block.predicate.primitive.IntPredicate predicate)
Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
|
<S> com.gs.collections.api.bag.sorted.MutableSortedBag<S> |
selectInstancesOf(java.lang.Class<S> clazz)
Returns all elements of the source collection that are instances of the Class
clazz. |
<P> com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
P parameter)
Similar to
RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2. |
boolean |
setOccurrences(T item,
int occurrences) |
int |
sizeDistinct()
The size of the Bag when counting only distinct elements.
|
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
take(int count)
Returns the first
count elements of the iterable
or all the elements in the iterable if count is greater than the length of
the iterable. |
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
takeWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
Returns the initial elements that satisfy the Predicate.
|
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
tap(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
Executes the Procedure for each element in the iterable and returns
this. |
com.gs.collections.api.bag.sorted.ImmutableSortedBag<T> |
toImmutable()
Convert the SortedBag to an ImmutableSortedBag.
|
com.gs.collections.api.map.sorted.MutableSortedMap<T,java.lang.Integer> |
toMapOfItemToCount()
Converts the Bag to a Map of the Item type to its count as an Integer.
|
com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.primitive.ObjectIntPair<T>> |
topOccurrences(int count)
Returns the
count most frequently occurring items. |
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
toReversed()
Returns a new ReversibleIterable in reverse order.
|
com.gs.collections.api.stack.MutableStack<T> |
toStack()
Converts the SortedIterable to a mutable MutableStack implementation.
|
java.lang.String |
toStringOfItemToCount()
Returns a string representation of this bag.
|
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
with(T element)
This method allows mutable and fixed size collections the ability to add elements to their existing elements.
|
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
withAll(java.lang.Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to add multiple elements to their existing
elements.
|
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
without(T element)
This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
|
com.gs.collections.api.bag.sorted.MutableSortedBag<T> |
withoutAll(java.lang.Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to remove multiple elements from their existing
elements.
|
protected java.lang.Object |
writeReplace() |
<S> com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<T,S>> |
zip(java.lang.Iterable<S> that)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
com.gs.collections.api.set.sorted.MutableSortedSet<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
add, addAll, addAllIterable, aggregateBy, aggregateInPlaceBy, clear, injectIntoWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, selectAndRejectWithallSatisfy, 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, each, equals, flatCollect, forEach, forEachWith, forEachWithIndex, getFirst, getLast, getLock, groupBy, groupByEach, groupByUniqueKey, groupByUniqueKey, hashCode, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, iterator, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndexequals, finalize, getClass, notify, notifyAll, wait, wait, waitaggregateBy, aggregateInPlaceByforEachWithIndex, getFirst, getLast, zip, zipWithIndexallSatisfy, 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, each, flatCollect, groupBy, groupByEach, groupByUniqueKey, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, maxBy, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toStringpublic static <E> SynchronizedSortedBag<E> of(com.gs.collections.api.bag.sorted.MutableSortedBag<E> bag)
public static <E> com.gs.collections.api.bag.sorted.MutableSortedBag<E> of(com.gs.collections.api.bag.sorted.MutableSortedBag<E> bag,
java.lang.Object lock)
protected com.gs.collections.api.bag.sorted.MutableSortedBag<T> getDelegate()
getDelegate in class AbstractSynchronizedMutableCollection<T>public com.gs.collections.api.bag.sorted.MutableSortedBag<T> with(T element)
com.gs.collections.api.collection.MutableCollection
MutableCollectionIn the case oflist; list = list.with("1"); list = list.with("2"); return list;
FixedSizeCollection 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.public com.gs.collections.api.bag.sorted.MutableSortedBag<T> without(T element)
com.gs.collections.api.collection.MutableCollection
MutableCollectionIn the case oflist; list = list.without("1"); list = list.without("2"); return list;
FixedSizeCollection 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.public com.gs.collections.api.bag.sorted.MutableSortedBag<T> withAll(java.lang.Iterable<? extends T> elements)
com.gs.collections.api.collection.MutableCollection
MutableCollectionIn the case oflist; list = list.withAll(FastList.newListWith("1", "2")); return list;
FixedSizeCollection 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.withAll in interface com.gs.collections.api.bag.MutableBagIterable<T>withAll in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>withAll in interface com.gs.collections.api.collection.MutableCollection<T>Collection.addAll(Collection)public com.gs.collections.api.bag.sorted.MutableSortedBag<T> withoutAll(java.lang.Iterable<? extends T> elements)
com.gs.collections.api.collection.MutableCollection
MutableCollectionIn the case oflist; list = list.withoutAll(FastList.newListWith("1", "2")); return list;
FixedSizeCollection 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.withoutAll in interface com.gs.collections.api.bag.MutableBagIterable<T>withoutAll in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>withoutAll in interface com.gs.collections.api.collection.MutableCollection<T>Collection.removeAll(Collection)public com.gs.collections.api.bag.sorted.MutableSortedBag<T> newEmpty()
com.gs.collections.api.collection.MutableCollectionpublic com.gs.collections.api.bag.sorted.MutableSortedBag<T> clone()
clone in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>clone in class java.lang.Objectpublic java.util.Comparator<? super T> comparator()
com.gs.collections.api.bag.sorted.SortedBagpublic int compareTo(com.gs.collections.api.bag.sorted.SortedBag<T> o)
compareTo in interface java.lang.Comparable<com.gs.collections.api.bag.sorted.SortedBag<T>>protected java.lang.Object writeReplace()
public void addOccurrences(T item, int occurrences)
addOccurrences in interface com.gs.collections.api.bag.MutableBagIterable<T>public boolean removeOccurrences(java.lang.Object item,
int occurrences)
removeOccurrences in interface com.gs.collections.api.bag.MutableBagIterable<T>public boolean setOccurrences(T item, int occurrences)
setOccurrences in interface com.gs.collections.api.bag.MutableBagIterable<T>public com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.primitive.ObjectIntPair<T>> topOccurrences(int count)
com.gs.collections.api.bag.Bagcount 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.public com.gs.collections.api.bag.sorted.MutableSortedBag<T> selectByOccurrences(com.gs.collections.api.block.predicate.primitive.IntPredicate predicate)
com.gs.collections.api.bag.BagselectByOccurrences in interface com.gs.collections.api.bag.Bag<T>selectByOccurrences in interface com.gs.collections.api.bag.MutableBagIterable<T>selectByOccurrences in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>selectByOccurrences in interface com.gs.collections.api.bag.sorted.SortedBag<T>public com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.primitive.ObjectIntPair<T>> bottomOccurrences(int count)
com.gs.collections.api.bag.Bagcount 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.public com.gs.collections.api.map.sorted.MutableSortedMap<T,java.lang.Integer> toMapOfItemToCount()
com.gs.collections.api.bag.BagtoMapOfItemToCount in interface com.gs.collections.api.bag.Bag<T>toMapOfItemToCount in interface com.gs.collections.api.bag.MutableBagIterable<T>toMapOfItemToCount in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>toMapOfItemToCount in interface com.gs.collections.api.bag.sorted.SortedBag<T>public void forEachWithOccurrences(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> procedure)
com.gs.collections.api.bag.BagforEachWithOccurrences in interface com.gs.collections.api.bag.Bag<T>public int occurrencesOf(java.lang.Object item)
com.gs.collections.api.bag.BagoccurrencesOf in interface com.gs.collections.api.bag.Bag<T>public int sizeDistinct()
com.gs.collections.api.bag.BagsizeDistinct in interface com.gs.collections.api.bag.Bag<T>public java.lang.String toStringOfItemToCount()
com.gs.collections.api.bag.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 com.gs.collections.api.bag.Bag<T>public int indexOf(java.lang.Object object)
com.gs.collections.api.ordered.OrderedIterableindexOf in interface com.gs.collections.api.ordered.OrderedIterable<T>List.indexOf(Object)public com.gs.collections.api.stack.MutableStack<T> toStack()
com.gs.collections.api.ordered.SortedIterablepublic com.gs.collections.api.partition.bag.sorted.PartitionMutableSortedBag<T> partitionWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.ordered.SortedIterablepartitionWhile in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>partitionWhile in interface com.gs.collections.api.bag.sorted.SortedBag<T>partitionWhile in interface com.gs.collections.api.ordered.OrderedIterable<T>partitionWhile in interface com.gs.collections.api.ordered.ReversibleIterable<T>partitionWhile in interface com.gs.collections.api.ordered.SortedIterable<T>public com.gs.collections.api.set.sorted.MutableSortedSet<T> distinct()
com.gs.collections.api.ordered.SortedIterableSortedIterable containing the distinct elements in this iterable.
Conceptually similar to RichIterable.toSet().RichIterable.toList() but retains the original order. If an element appears
multiple times in this iterable, the first one will be copied into the result.
distinct in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>distinct in interface com.gs.collections.api.bag.sorted.SortedBag<T>distinct in interface com.gs.collections.api.ordered.OrderedIterable<T>distinct in interface com.gs.collections.api.ordered.ReversibleIterable<T>distinct in interface com.gs.collections.api.ordered.SortedIterable<T>SortedIterable of distinct elementspublic com.gs.collections.api.bag.sorted.MutableSortedBag<T> takeWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.ordered.SortedIterabletakeWhile in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>takeWhile in interface com.gs.collections.api.bag.sorted.SortedBag<T>takeWhile in interface com.gs.collections.api.ordered.OrderedIterable<T>takeWhile in interface com.gs.collections.api.ordered.ReversibleIterable<T>takeWhile in interface com.gs.collections.api.ordered.SortedIterable<T>public com.gs.collections.api.bag.sorted.MutableSortedBag<T> dropWhile(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.ordered.SortedIterabledropWhile in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>dropWhile in interface com.gs.collections.api.bag.sorted.SortedBag<T>dropWhile in interface com.gs.collections.api.ordered.OrderedIterable<T>dropWhile in interface com.gs.collections.api.ordered.ReversibleIterable<T>dropWhile in interface com.gs.collections.api.ordered.SortedIterable<T>public <S> boolean corresponds(com.gs.collections.api.ordered.OrderedIterable<S> other,
com.gs.collections.api.block.predicate.Predicate2<? super T,? super S> predicate)
com.gs.collections.api.ordered.OrderedIterablepredicate returns true for all corresponding elements e1 of
this OrderedIterable and e2 of other.
The predicate is evaluated for each element at the same position of each OrderedIterable in a forward iteration order.
This is a short circuit pattern.corresponds in interface com.gs.collections.api.ordered.OrderedIterable<T>public void forEach(int startIndex,
int endIndex,
com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
com.gs.collections.api.ordered.OrderedIterable
e.g. OrderedIterablepeople = FastList.newListWith(ted, mary, bob, sally) people.forEach(0, 1, new Procedure () { public void value(Person person) { LOGGER.info(person.getName()); } });
This code would output ted and mary's names.
forEach in interface com.gs.collections.api.ordered.OrderedIterable<T>public void forEachWithIndex(int fromIndex,
int toIndex,
com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)
com.gs.collections.api.ordered.OrderedIterable
e.g. OrderedIterablepeople = FastList.newListWith(ted, mary, bob, sally) people.forEachWithIndex(0, 1, new ObjectIntProcedure () { public void value(Person person, int index) { LOGGER.info(person.getName()); } });
This code would output ted and mary's names.
forEachWithIndex in interface com.gs.collections.api.ordered.OrderedIterable<T>public int detectIndex(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.ordered.OrderedIterableOrderedIterable for which the predicate evaluates to true.
Returns -1 if no element evaluates true for the predicate.detectIndex in interface com.gs.collections.api.ordered.OrderedIterable<T>public com.gs.collections.api.bag.sorted.MutableSortedBag<T> tap(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
com.gs.collections.api.RichIterablethis.
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()
{
public void value(Person person)
{
LOGGER.info(person.getName());
}
});
tap in interface com.gs.collections.api.bag.Bag<T>tap in interface com.gs.collections.api.bag.MutableBagIterable<T>tap in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>tap in interface com.gs.collections.api.bag.sorted.SortedBag<T>tap in interface com.gs.collections.api.collection.MutableCollection<T>tap in interface com.gs.collections.api.RichIterable<T>RichIterable.each(Procedure),
InternalIterable.forEach(Procedure)public com.gs.collections.api.bag.sorted.MutableSortedBag<T> select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.RichIterableExample using a Java 8 lambda expression:
RichIterable<Person> selected =
people.select(person -> person.getAddress().getCity().equals("London"));
Example using an anonymous inner class:
RichIterable<Person> selected =
people.select(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.getAddress().getCity().equals("London");
}
});select in interface com.gs.collections.api.bag.Bag<T>select in interface com.gs.collections.api.bag.MutableBagIterable<T>select in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>select in interface com.gs.collections.api.bag.sorted.SortedBag<T>select in interface com.gs.collections.api.collection.MutableCollection<T>select in interface com.gs.collections.api.ordered.OrderedIterable<T>select in interface com.gs.collections.api.ordered.ReversibleIterable<T>select in interface com.gs.collections.api.ordered.SortedIterable<T>select in interface com.gs.collections.api.RichIterable<T>public <P> com.gs.collections.api.bag.sorted.MutableSortedBag<T> selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.RichIterableRichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years
Example using a Java 8 lambda expression:
RichIterable<Person> selected =
people.selectWith((Person person, Integer age) -> person.getAge() >= age, Integer.valueOf(18));
Example using an anonymous inner class:
RichIterable<Person> selected =
people.selectWith(new Predicate2<Person, Integer>()
{
public boolean accept(Person person, Integer age)
{
return person.getAge() >= age;
}
}, Integer.valueOf(18));
selectWith in interface com.gs.collections.api.bag.Bag<T>selectWith in interface com.gs.collections.api.bag.MutableBagIterable<T>selectWith in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>selectWith in interface com.gs.collections.api.bag.sorted.SortedBag<T>selectWith in interface com.gs.collections.api.collection.MutableCollection<T>selectWith in interface com.gs.collections.api.ordered.OrderedIterable<T>selectWith in interface com.gs.collections.api.ordered.ReversibleIterable<T>selectWith in interface com.gs.collections.api.ordered.SortedIterable<T>selectWith in interface com.gs.collections.api.RichIterable<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 com.gs.collections.api.bag.sorted.MutableSortedBag<T> reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.RichIterableExample using a Java 8 lambda expression:
RichIterable<Person> rejected =
people.reject(person -> person.person.getLastName().equals("Smith"));
Example using an anonymous inner class:
RichIterable<Person> rejected =
people.reject(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.person.getLastName().equals("Smith");
}
});
reject in interface com.gs.collections.api.bag.Bag<T>reject in interface com.gs.collections.api.bag.MutableBagIterable<T>reject in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>reject in interface com.gs.collections.api.bag.sorted.SortedBag<T>reject in interface com.gs.collections.api.collection.MutableCollection<T>reject in interface com.gs.collections.api.ordered.OrderedIterable<T>reject in interface com.gs.collections.api.ordered.ReversibleIterable<T>reject in interface com.gs.collections.api.ordered.SortedIterable<T>reject in interface com.gs.collections.api.RichIterable<T>predicate - a Predicate to use as the reject criteriaPredicate.accept(Object) method to evaluate to falsepublic <P> com.gs.collections.api.bag.sorted.MutableSortedBag<T> rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.RichIterableRichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years
Example using a Java 8 lambda expression:
RichIterable<Person> rejected =
people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
Example using an anonymous inner class:
MutableList<Person> rejected =
people.rejectWith(new Predicate2<Person, Integer>()
{
public boolean accept(Person person, Integer age)
{
return person.getAge() < age;
}
}, Integer.valueOf(18));
rejectWith in interface com.gs.collections.api.bag.Bag<T>rejectWith in interface com.gs.collections.api.bag.MutableBagIterable<T>rejectWith in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>rejectWith in interface com.gs.collections.api.bag.sorted.SortedBag<T>rejectWith in interface com.gs.collections.api.collection.MutableCollection<T>rejectWith in interface com.gs.collections.api.ordered.OrderedIterable<T>rejectWith in interface com.gs.collections.api.ordered.ReversibleIterable<T>rejectWith in interface com.gs.collections.api.ordered.SortedIterable<T>rejectWith in interface com.gs.collections.api.RichIterable<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 com.gs.collections.api.partition.bag.sorted.PartitionMutableSortedBag<T> partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.RichIterableExample 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");
}
});
partition in interface com.gs.collections.api.bag.Bag<T>partition in interface com.gs.collections.api.bag.MutableBagIterable<T>partition in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>partition in interface com.gs.collections.api.bag.sorted.SortedBag<T>partition in interface com.gs.collections.api.collection.MutableCollection<T>partition in interface com.gs.collections.api.ordered.OrderedIterable<T>partition in interface com.gs.collections.api.ordered.ReversibleIterable<T>partition in interface com.gs.collections.api.ordered.SortedIterable<T>partition in interface com.gs.collections.api.RichIterable<T>public <P> com.gs.collections.api.partition.bag.sorted.PartitionMutableSortedBag<T> partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)
com.gs.collections.api.RichIterableExample 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");
partitionWith in interface com.gs.collections.api.bag.Bag<T>partitionWith in interface com.gs.collections.api.bag.MutableBagIterable<T>partitionWith in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>partitionWith in interface com.gs.collections.api.bag.sorted.SortedBag<T>partitionWith in interface com.gs.collections.api.collection.MutableCollection<T>partitionWith in interface com.gs.collections.api.ordered.OrderedIterable<T>partitionWith in interface com.gs.collections.api.ordered.ReversibleIterable<T>partitionWith in interface com.gs.collections.api.RichIterable<T>public com.gs.collections.api.list.primitive.MutableBooleanList collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction)
com.gs.collections.api.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.
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();
}
});
collectBoolean in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>collectBoolean in interface com.gs.collections.api.bag.sorted.SortedBag<T>collectBoolean in interface com.gs.collections.api.collection.MutableCollection<T>collectBoolean in interface com.gs.collections.api.ordered.OrderedIterable<T>collectBoolean in interface com.gs.collections.api.ordered.ReversibleIterable<T>collectBoolean in interface com.gs.collections.api.RichIterable<T>public com.gs.collections.api.list.primitive.MutableByteList collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction)
com.gs.collections.api.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.
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();
}
});
collectByte in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>collectByte in interface com.gs.collections.api.bag.sorted.SortedBag<T>collectByte in interface com.gs.collections.api.collection.MutableCollection<T>collectByte in interface com.gs.collections.api.ordered.OrderedIterable<T>collectByte in interface com.gs.collections.api.ordered.ReversibleIterable<T>collectByte in interface com.gs.collections.api.RichIterable<T>public com.gs.collections.api.list.primitive.MutableCharList collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction)
com.gs.collections.api.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.
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();
}
});
collectChar in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>collectChar in interface com.gs.collections.api.bag.sorted.SortedBag<T>collectChar in interface com.gs.collections.api.collection.MutableCollection<T>collectChar in interface com.gs.collections.api.ordered.OrderedIterable<T>collectChar in interface com.gs.collections.api.ordered.ReversibleIterable<T>collectChar in interface com.gs.collections.api.RichIterable<T>public com.gs.collections.api.list.primitive.MutableDoubleList collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)
com.gs.collections.api.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.
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();
}
});
collectDouble in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>collectDouble in interface com.gs.collections.api.bag.sorted.SortedBag<T>collectDouble in interface com.gs.collections.api.collection.MutableCollection<T>collectDouble in interface com.gs.collections.api.ordered.OrderedIterable<T>collectDouble in interface com.gs.collections.api.ordered.ReversibleIterable<T>collectDouble in interface com.gs.collections.api.RichIterable<T>public com.gs.collections.api.list.primitive.MutableFloatList collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)
com.gs.collections.api.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.
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();
}
});
collectFloat in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>collectFloat in interface com.gs.collections.api.bag.sorted.SortedBag<T>collectFloat in interface com.gs.collections.api.collection.MutableCollection<T>collectFloat in interface com.gs.collections.api.ordered.OrderedIterable<T>collectFloat in interface com.gs.collections.api.ordered.ReversibleIterable<T>collectFloat in interface com.gs.collections.api.RichIterable<T>public com.gs.collections.api.list.primitive.MutableIntList collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)
com.gs.collections.api.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.
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();
}
});
collectInt in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>collectInt in interface com.gs.collections.api.bag.sorted.SortedBag<T>collectInt in interface com.gs.collections.api.collection.MutableCollection<T>collectInt in interface com.gs.collections.api.ordered.OrderedIterable<T>collectInt in interface com.gs.collections.api.ordered.ReversibleIterable<T>collectInt in interface com.gs.collections.api.RichIterable<T>public com.gs.collections.api.list.primitive.MutableLongList collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)
com.gs.collections.api.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.
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();
}
});
collectLong in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>collectLong in interface com.gs.collections.api.bag.sorted.SortedBag<T>collectLong in interface com.gs.collections.api.collection.MutableCollection<T>collectLong in interface com.gs.collections.api.ordered.OrderedIterable<T>collectLong in interface com.gs.collections.api.ordered.ReversibleIterable<T>collectLong in interface com.gs.collections.api.RichIterable<T>public com.gs.collections.api.list.primitive.MutableShortList collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction)
com.gs.collections.api.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.
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();
}
});
collectShort in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>collectShort in interface com.gs.collections.api.bag.sorted.SortedBag<T>collectShort in interface com.gs.collections.api.collection.MutableCollection<T>collectShort in interface com.gs.collections.api.ordered.OrderedIterable<T>collectShort in interface com.gs.collections.api.ordered.ReversibleIterable<T>collectShort in interface com.gs.collections.api.RichIterable<T>public <S> com.gs.collections.api.bag.sorted.MutableSortedBag<S> selectInstancesOf(java.lang.Class<S> clazz)
com.gs.collections.api.RichIterableclazz.selectInstancesOf in interface com.gs.collections.api.bag.Bag<T>selectInstancesOf in interface com.gs.collections.api.bag.MutableBagIterable<T>selectInstancesOf in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>selectInstancesOf in interface com.gs.collections.api.bag.sorted.SortedBag<T>selectInstancesOf in interface com.gs.collections.api.collection.MutableCollection<T>selectInstancesOf in interface com.gs.collections.api.ordered.OrderedIterable<T>selectInstancesOf in interface com.gs.collections.api.ordered.ReversibleIterable<T>selectInstancesOf in interface com.gs.collections.api.ordered.SortedIterable<T>selectInstancesOf in interface com.gs.collections.api.RichIterable<T>public <V> com.gs.collections.api.list.MutableList<V> collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.RichIterableExample using a Java 8 lambda expression:
RichIterable<String> names =
people.collect(person -> person.getFirstName() + " " + person.getLastName());
Example using an anonymous inner class:
RichIterable<String> names =
people.collect(new Function<Person, String>()
{
public String valueOf(Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
collect in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>collect in interface com.gs.collections.api.bag.sorted.SortedBag<T>collect in interface com.gs.collections.api.collection.MutableCollection<T>collect in interface com.gs.collections.api.ordered.OrderedIterable<T>collect in interface com.gs.collections.api.ordered.ReversibleIterable<T>collect in interface com.gs.collections.api.RichIterable<T>public com.gs.collections.api.set.sorted.MutableSortedSet<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> zipWithIndex()
com.gs.collections.api.RichIterableRichIterable with its indices.zipWithIndex in interface com.gs.collections.api.bag.Bag<T>zipWithIndex in interface com.gs.collections.api.bag.MutableBagIterable<T>zipWithIndex in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>zipWithIndex in interface com.gs.collections.api.bag.sorted.SortedBag<T>zipWithIndex in interface com.gs.collections.api.collection.MutableCollection<T>zipWithIndex in interface com.gs.collections.api.ordered.OrderedIterable<T>zipWithIndex in interface com.gs.collections.api.ordered.ReversibleIterable<T>zipWithIndex in interface com.gs.collections.api.ordered.SortedIterable<T>zipWithIndex in interface com.gs.collections.api.RichIterable<T>RichIterable containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)public <P,V> com.gs.collections.api.list.MutableList<V> collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter)
com.gs.collections.api.RichIterableRichIterable.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));
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));
collectWith in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>collectWith in interface com.gs.collections.api.bag.sorted.SortedBag<T>collectWith in interface com.gs.collections.api.collection.MutableCollection<T>collectWith in interface com.gs.collections.api.ordered.OrderedIterable<T>collectWith in interface com.gs.collections.api.ordered.ReversibleIterable<T>collectWith in interface com.gs.collections.api.RichIterable<T>function - A Function2 to use as the collect transformation functionparameter - A parameter to pass in for evaluation of the second argument P in functionRichIterable that contains the transformed elements returned by Function2.value(Object, Object)RichIterable.collect(Function)public <V> com.gs.collections.api.list.MutableList<V> collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.RichIterableExample using a Java 8 lambda and method reference:
RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);
Example using Predicates factory:
RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
collectIf in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>collectIf in interface com.gs.collections.api.bag.sorted.SortedBag<T>collectIf in interface com.gs.collections.api.collection.MutableCollection<T>collectIf in interface com.gs.collections.api.ordered.OrderedIterable<T>collectIf in interface com.gs.collections.api.ordered.ReversibleIterable<T>collectIf in interface com.gs.collections.api.RichIterable<T>public <V> com.gs.collections.api.list.MutableList<V> flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
com.gs.collections.api.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 = 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 com.gs.collections.api.bag.sorted.MutableSortedBag<T>flatCollect in interface com.gs.collections.api.bag.sorted.SortedBag<T>flatCollect in interface com.gs.collections.api.collection.MutableCollection<T>flatCollect in interface com.gs.collections.api.ordered.OrderedIterable<T>flatCollect in interface com.gs.collections.api.ordered.ReversibleIterable<T>flatCollect in interface com.gs.collections.api.RichIterable<T>function - The Function to applyfunctionpublic <V> com.gs.collections.api.multimap.sortedbag.MutableSortedBagMultimap<V,T> groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
com.gs.collections.api.RichIterableExample 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 value(Person person)
{
return person.getLastName();
}
});
groupBy in interface com.gs.collections.api.bag.Bag<T>groupBy in interface com.gs.collections.api.bag.MutableBagIterable<T>groupBy in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>groupBy in interface com.gs.collections.api.bag.sorted.SortedBag<T>groupBy in interface com.gs.collections.api.collection.MutableCollection<T>groupBy in interface com.gs.collections.api.ordered.OrderedIterable<T>groupBy in interface com.gs.collections.api.ordered.ReversibleIterable<T>groupBy in interface com.gs.collections.api.ordered.SortedIterable<T>groupBy in interface com.gs.collections.api.RichIterable<T>public <V> com.gs.collections.api.multimap.sortedbag.MutableSortedBagMultimap<V,T> groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
com.gs.collections.api.RichIterableRichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys
for each value.groupByEach in interface com.gs.collections.api.bag.Bag<T>groupByEach in interface com.gs.collections.api.bag.MutableBagIterable<T>groupByEach in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>groupByEach in interface com.gs.collections.api.bag.sorted.SortedBag<T>groupByEach in interface com.gs.collections.api.collection.MutableCollection<T>groupByEach in interface com.gs.collections.api.ordered.OrderedIterable<T>groupByEach in interface com.gs.collections.api.ordered.ReversibleIterable<T>groupByEach in interface com.gs.collections.api.ordered.SortedIterable<T>groupByEach in interface com.gs.collections.api.RichIterable<T>public <S> com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<T,S>> zip(java.lang.Iterable<S> that)
com.gs.collections.api.RichIterableRichIterable 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.zip in interface com.gs.collections.api.bag.sorted.MutableSortedBag<T>zip in interface com.gs.collections.api.collection.MutableCollection<T>zip in interface com.gs.collections.api.ordered.OrderedIterable<T>zip in interface com.gs.collections.api.ordered.ReversibleIterable<T>zip in interface com.gs.collections.api.ordered.SortedIterable<T>zip in interface com.gs.collections.api.RichIterable<T>S - the type of the second half of the returned pairsthat - The RichIterable providing the second half of each result pairRichIterable 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.public com.gs.collections.api.bag.sorted.MutableSortedBag<T> asUnmodifiable()
com.gs.collections.api.bag.sorted.MutableSortedBagpublic com.gs.collections.api.bag.sorted.MutableSortedBag<T> asSynchronized()
com.gs.collections.api.collection.MutableCollectionIt is imperative that the user manually synchronize on the returned collection when iterating over it using the standard JDK iterator or JDK 5 for loop.
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.
public com.gs.collections.api.bag.sorted.ImmutableSortedBag<T> toImmutable()
com.gs.collections.api.bag.sorted.SortedBagpublic com.gs.collections.api.bag.sorted.MutableSortedBag<T> drop(int count)
com.gs.collections.api.ordered.ReversibleIterablecount elements
or an empty iterable if the count is greater than the length of the iterable.public com.gs.collections.api.bag.sorted.MutableSortedBag<T> take(int count)
com.gs.collections.api.ordered.ReversibleIterablecount elements of the iterable
or all the elements in the iterable if count is greater than the length of
the iterable.public com.gs.collections.api.bag.sorted.MutableSortedBag<T> toReversed()
com.gs.collections.api.ordered.ReversibleIterablepublic void reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
com.gs.collections.api.ordered.ReversibleIterable
e.g. people.reverseForEach(new Procedure() { public void value(Person person) { LOGGER.info(person.getName()); } });
reverseForEach in interface com.gs.collections.api.ordered.ReversibleIterable<T>public com.gs.collections.api.LazyIterable<T> asReversed()
com.gs.collections.api.ordered.ReversibleIterableasReversed in interface com.gs.collections.api.ordered.ReversibleIterable<T>public int detectLastIndex(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
com.gs.collections.api.ordered.ReversibleIterableReversibleIterable for which the predicate evaluates to true.
Returns -1 if no element evaluates true for the predicate.detectLastIndex in interface com.gs.collections.api.ordered.ReversibleIterable<T>public com.gs.collections.api.bag.ParallelBag<T> asParallel(java.util.concurrent.ExecutorService executorService, int batchSize)