public abstract class AbstractMutableSortedMap<K,V> extends AbstractMutableMapIterable<K,V> implements com.gs.collections.api.map.sorted.MutableSortedMap<K,V>
| Constructor and Description |
|---|
AbstractMutableSortedMap() |
| Modifier and Type | Method and Description |
|---|---|
com.gs.collections.api.LazyIterable<V> |
asReversed()
Returns a reversed view of this ReversibleIterable.
|
com.gs.collections.api.map.sorted.MutableSortedMap<K,V> |
asSynchronized()
Returns a synchronized (thread-safe) map backed by the specified map.
|
com.gs.collections.api.map.sorted.MutableSortedMap<K,V> |
asUnmodifiable()
Returns an unmodifiable view of this map.
|
abstract com.gs.collections.api.map.sorted.MutableSortedMap<K,V> |
clone() |
<R> com.gs.collections.api.list.MutableList<R> |
collect(com.gs.collections.api.block.function.Function<? super V,? extends R> 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 V> 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 V> 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 V> 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 V> 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 V> floatFunction)
Returns a new primitive
float iterable with the results of applying the specified function on each element
of the source collection. |
<R> com.gs.collections.api.list.MutableList<R> |
collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate,
com.gs.collections.api.block.function.Function<? super V,? extends R> 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 V> intFunction)
Returns a new primitive
int iterable with the results of applying the specified function on each element
of the source collection. |
<E> com.gs.collections.api.map.sorted.MutableSortedMap<K,V> |
collectKeysAndValues(java.lang.Iterable<E> iterable,
com.gs.collections.api.block.function.Function<? super E,? extends K> keyFunction,
com.gs.collections.api.block.function.Function<? super E,? extends V> valueFunction)
Adds all the entries derived from
iterable to this. |
com.gs.collections.api.list.primitive.MutableLongList |
collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super V> 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 V> shortFunction)
Returns a new primitive
short iterable with the results of applying the specified function on each element
of the source collection. |
<R> com.gs.collections.api.map.sorted.MutableSortedMap<K,R> |
collectValues(com.gs.collections.api.block.function.Function2<? super K,? super V,? extends R> function)
For each key and value of the map the function is evaluated.
|
<P,VV> com.gs.collections.api.list.MutableList<VV> |
collectWith(com.gs.collections.api.block.function.Function2<? super V,? super P,? extends VV> function,
P parameter)
Same as
RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block. |
<S> boolean |
corresponds(com.gs.collections.api.ordered.OrderedIterable<S> other,
com.gs.collections.api.block.predicate.Predicate2<? super V,? 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 V> 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 V> predicate)
Returns the index of the last element of the
ReversibleIterable for which the predicate evaluates to true. |
<R> com.gs.collections.api.list.MutableList<R> |
flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<R>> function)
flatCollect is a special case of RichIterable.collect(Function). |
com.gs.collections.api.multimap.sortedset.MutableSortedSetMultimap<V,K> |
flip()
Given a map from Domain -> Range return a multimap from Range -> Domain.
|
void |
forEach(int startIndex,
int endIndex,
com.gs.collections.api.block.procedure.Procedure<? super V> 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 V> objectIntProcedure)
Iterates over the section of the iterable covered by the specified inclusive indexes.
|
<VV> com.gs.collections.api.multimap.list.MutableListMultimap<VV,V> |
groupBy(com.gs.collections.api.block.function.Function<? super V,? extends VV> 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.
|
<VV> com.gs.collections.api.multimap.list.MutableListMultimap<VV,V> |
groupByEach(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<VV>> 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.partition.list.PartitionMutableList<V> |
partition(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
<P> com.gs.collections.api.partition.list.PartitionMutableList<V> |
partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
|
com.gs.collections.api.list.MutableList<V> |
reject(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)
Returns all elements of the source collection that return false when evaluating of the predicate.
|
com.gs.collections.api.map.sorted.MutableSortedMap<K,V> |
reject(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)
For each key and value of the map the predicate is evaluated, if the result of the evaluation is false,
that key and value are returned in a new map.
|
<P> com.gs.collections.api.list.MutableList<V> |
rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
P parameter)
Similar to
RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2. |
void |
reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)
Evaluates the procedure for each element of the list iterating in reverse order.
|
com.gs.collections.api.list.MutableList<V> |
select(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)
Returns all elements of the source collection that return true when evaluating the predicate.
|
com.gs.collections.api.map.sorted.MutableSortedMap<K,V> |
select(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)
For each key and value of the map the predicate is evaluated, if the result of the evaluation is true,
that key and value are returned in a new map.
|
<S> com.gs.collections.api.list.MutableList<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.list.MutableList<V> |
selectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
P parameter)
Similar to
RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2. |
com.gs.collections.api.map.sorted.MutableSortedMap<K,V> |
tap(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)
Executes the Procedure for each value of the map and returns
this. |
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> |
toImmutable()
Returns an immutable copy of this map.
|
com.gs.collections.api.stack.MutableStack<V> |
toStack()
Converts the OrderedIterable to a mutable MutableStack implementation.
|
com.gs.collections.api.map.sorted.MutableSortedMap<K,V> |
with(com.gs.collections.api.tuple.Pair<K,V>... pairs)
Deprecated.
in 6.0 Use
withAllKeyValueArguments(Pair[]) instead. Inlineable. |
com.gs.collections.api.map.sorted.MutableSortedMap<K,V> |
withAllKeyValueArguments(com.gs.collections.api.tuple.Pair<? extends K,? extends V>... keyValues)
Convenience var-args version of withAllKeyValues
|
com.gs.collections.api.map.sorted.MutableSortedMap<K,V> |
withAllKeyValues(java.lang.Iterable<? extends com.gs.collections.api.tuple.Pair<? extends K,? extends V>> keyValues)
This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing
elements.
|
com.gs.collections.api.map.sorted.MutableSortedMap<K,V> |
withKeyValue(K key,
V value)
This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing
elements.
|
com.gs.collections.api.map.sorted.MutableSortedMap<K,V> |
withoutAllKeys(java.lang.Iterable<? extends K> keys)
This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing
elements.
|
com.gs.collections.api.map.sorted.MutableSortedMap<K,V> |
withoutKey(K key)
This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing
elements.
|
<S> com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<V,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.list.MutableList<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
add, aggregateBy, aggregateInPlaceBy, collect, detect, flipUniqueValues, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWith, getIfAbsentPutWithKey, groupByUniqueKey, iterator, keysView, keyValuesView, updateValue, updateValueWith, valuesViewallSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, asLazy, chunk, contains, detect, detectIfNone, detectWith, detectWithIfNone, each, forEachKey, forEachValue, forEachWith, forEachWithIndex, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, ifPresentApply, isAbsent, keyAndValueEquals, keyAndValueHashCode, noneSatisfy, noneSatisfyWith, toArray, toArrayappendString, appendString, appendString, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAll, containsAllArguments, containsAllIterable, count, countWith, flatCollect, forEach, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, notEmpty, reject, rejectWith, select, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndexequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaggregateBy, aggregateInPlaceBy, collect, distinct, drop, dropWhile, entrySet, getIfAbsentPutWith, groupByUniqueKey, headMap, keySet, newEmpty, partitionWhile, subMap, tailMap, take, takeWhile, toReversed, valuesadd, flipUniqueValues, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWithKey, removeKey, updateValue, updateValueWithcontainsKey, containsValue, detect, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, keysView, keyValuesView, toString, valuesViewforEachWithIndex, getFirst, getLast, max, min, 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, 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, toSortedSetBypublic com.gs.collections.api.map.sorted.MutableSortedMap<K,V> withKeyValue(K key, V value)
com.gs.collections.api.map.MutableMapIterable
map = map.withKeyValue("new key", "new value");
In the case of FixedSizeMap, a new instance will be returned by withKeyValue, and any variables that
previously referenced the original map will need to be redirected to reference the new instance. In the case
of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap
will both return "this" after calling put on themselves.public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> withAllKeyValues(java.lang.Iterable<? extends com.gs.collections.api.tuple.Pair<? extends K,? extends V>> keyValues)
com.gs.collections.api.map.MutableMapIterable
map = map.withAllKeyValues(FastList.newListWith(PairImpl.of("new key", "new value")));
In the case of FixedSizeMap, a new instance will be returned by withAllKeyValues, and any variables that
previously referenced the original map will need to be redirected to reference the new instance. In the case
of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap
will both return "this" after calling put on themselves.@Deprecated public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> with(com.gs.collections.api.tuple.Pair<K,V>... pairs)
withAllKeyValueArguments(Pair[]) instead. Inlineable.public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> withAllKeyValueArguments(com.gs.collections.api.tuple.Pair<? extends K,? extends V>... keyValues)
com.gs.collections.api.map.MutableMapIterablepublic com.gs.collections.api.map.sorted.MutableSortedMap<K,V> withoutKey(K key)
com.gs.collections.api.map.MutableMapIterable
map = map.withoutKey("key");
In the case of FixedSizeMap, a new instance will be returned by withoutKey, and any variables that previously
referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap
or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return
"this" after calling remove on themselves.public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> withoutAllKeys(java.lang.Iterable<? extends K> keys)
com.gs.collections.api.map.MutableMapIterable
map = map.withoutAllKeys(FastList.newListWith("key1", "key2"));
In the case of FixedSizeMap, a new instance will be returned by withoutAllKeys, and any variables that previously
referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap
or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return
"this" after calling remove on themselves.public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> asUnmodifiable()
com.gs.collections.api.map.MutableMapIterableUnsupportedOperationException.
The returned map will be Serializable if this map is Serializable.public com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> toImmutable()
com.gs.collections.api.map.MutableMapIterablepublic com.gs.collections.api.map.sorted.MutableSortedMap<K,V> asSynchronized()
com.gs.collections.api.map.MutableMapIterable
It is imperative that the user manually synchronize on the returned map when iterating over any of its collection views:
MutableMap map = myMutableMap.asSynchronized();
...
Set set = map.keySet(); // Needn't be in synchronized block
...
synchronized(map)
{ // Synchronizing on map, not set!
Iterator i = s.iterator(); // Must be in 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.
MutableMap map = myMutableMap.asSynchronized();
...
Set set = map.keySet(); // Needn't be in synchronized block
...
Iterate.forEach(set, new Procedure()
{
public void value(Object each)
{
...
}
});
The returned map will be serializable if the specified map is serializable.
public com.gs.collections.api.multimap.sortedset.MutableSortedSetMultimap<V,K> flip()
com.gs.collections.api.map.MapIterableSince the keys in the input are unique, the values in the output are unique, so the return type should be a SetMultimap. However since SetMultimap and SortedSetMultimap don't inherit from one another, SetMultimap here does not allow SortedMapIterable to have a SortedSetMultimap return. Thus we compromise and call this Multimap, even though all implementations will be a SetMultimap or SortedSetMultimap.
flip in interface com.gs.collections.api.map.MapIterable<K,V>flip in interface com.gs.collections.api.map.MutableMapIterable<K,V>flip in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>flip in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>public com.gs.collections.api.list.primitive.MutableBooleanList collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super V> 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.map.sorted.MutableSortedMap<K,V>collectBoolean in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>collectBoolean in interface com.gs.collections.api.ordered.OrderedIterable<V>collectBoolean in interface com.gs.collections.api.ordered.ReversibleIterable<V>collectBoolean in interface com.gs.collections.api.RichIterable<V>public com.gs.collections.api.list.primitive.MutableByteList collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super V> 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.map.sorted.MutableSortedMap<K,V>collectByte in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>collectByte in interface com.gs.collections.api.ordered.OrderedIterable<V>collectByte in interface com.gs.collections.api.ordered.ReversibleIterable<V>collectByte in interface com.gs.collections.api.RichIterable<V>public com.gs.collections.api.list.primitive.MutableCharList collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super V> 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.map.sorted.MutableSortedMap<K,V>collectChar in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>collectChar in interface com.gs.collections.api.ordered.OrderedIterable<V>collectChar in interface com.gs.collections.api.ordered.ReversibleIterable<V>collectChar in interface com.gs.collections.api.RichIterable<V>public com.gs.collections.api.list.primitive.MutableDoubleList collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super V> 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.map.sorted.MutableSortedMap<K,V>collectDouble in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>collectDouble in interface com.gs.collections.api.ordered.OrderedIterable<V>collectDouble in interface com.gs.collections.api.ordered.ReversibleIterable<V>collectDouble in interface com.gs.collections.api.RichIterable<V>public com.gs.collections.api.list.primitive.MutableFloatList collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super V> 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.map.sorted.MutableSortedMap<K,V>collectFloat in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>collectFloat in interface com.gs.collections.api.ordered.OrderedIterable<V>collectFloat in interface com.gs.collections.api.ordered.ReversibleIterable<V>collectFloat in interface com.gs.collections.api.RichIterable<V>public com.gs.collections.api.list.primitive.MutableIntList collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super V> 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.map.sorted.MutableSortedMap<K,V>collectInt in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>collectInt in interface com.gs.collections.api.ordered.OrderedIterable<V>collectInt in interface com.gs.collections.api.ordered.ReversibleIterable<V>collectInt in interface com.gs.collections.api.RichIterable<V>public com.gs.collections.api.list.primitive.MutableLongList collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super V> 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.map.sorted.MutableSortedMap<K,V>collectLong in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>collectLong in interface com.gs.collections.api.ordered.OrderedIterable<V>collectLong in interface com.gs.collections.api.ordered.ReversibleIterable<V>collectLong in interface com.gs.collections.api.RichIterable<V>public com.gs.collections.api.list.primitive.MutableShortList collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super V> 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.map.sorted.MutableSortedMap<K,V>collectShort in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>collectShort in interface com.gs.collections.api.ordered.OrderedIterable<V>collectShort in interface com.gs.collections.api.ordered.ReversibleIterable<V>collectShort in interface com.gs.collections.api.RichIterable<V>public <E> com.gs.collections.api.map.sorted.MutableSortedMap<K,V> collectKeysAndValues(java.lang.Iterable<E> iterable, com.gs.collections.api.block.function.Function<? super E,? extends K> keyFunction, com.gs.collections.api.block.function.Function<? super E,? extends V> valueFunction)
com.gs.collections.api.map.sorted.MutableSortedMapiterable to this.
The key and value for each entry is determined by applying the keyFunction and valueFunction to each item in collection.
Any entry in map that has the same key as an entry in this will have it's value replaced by that in map.public <R> com.gs.collections.api.map.sorted.MutableSortedMap<K,R> collectValues(com.gs.collections.api.block.function.Function2<? super K,? super V,? extends R> function)
com.gs.collections.api.map.MapIterable
e.g.
peopleByCity.collectValues(new Function2<City, Person, String>()
{
public String value(City city, Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
collectValues in interface com.gs.collections.api.map.MapIterable<K,V>collectValues in interface com.gs.collections.api.map.MutableMapIterable<K,V>collectValues in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>collectValues in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> tap(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)
com.gs.collections.api.map.MapIterablethis.
e.g. return peopleByCity.tap(new Procedure() { public void value(Person person) { LOGGER.info(person.getName()); } });
tap in interface com.gs.collections.api.map.MapIterable<K,V>tap in interface com.gs.collections.api.map.MutableMapIterable<K,V>tap in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>tap in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>tap in interface com.gs.collections.api.RichIterable<V>InternalIterable.forEach(Procedure)public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> select(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)
com.gs.collections.api.map.MapIterable
e.g.
peopleByCity.select(new Predicate2<City, Person>()
{
public boolean accept(City city, Person person)
{
return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
}
});
select in interface com.gs.collections.api.map.MapIterable<K,V>select in interface com.gs.collections.api.map.MutableMapIterable<K,V>select in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>select in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> reject(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)
com.gs.collections.api.map.MapIterable
e.g.
peopleByCity.reject(new Predicate2<City, Person>()
{
public boolean accept(City city, Person person)
{
return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
}
});
reject in interface com.gs.collections.api.map.MapIterable<K,V>reject in interface com.gs.collections.api.map.MutableMapIterable<K,V>reject in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>reject in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>public <R> com.gs.collections.api.list.MutableList<R> collect(com.gs.collections.api.block.function.Function<? super V,? extends R> 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.map.sorted.MutableSortedMap<K,V>collect in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>collect in interface com.gs.collections.api.ordered.OrderedIterable<V>collect in interface com.gs.collections.api.ordered.ReversibleIterable<V>collect in interface com.gs.collections.api.RichIterable<V>public <P,VV> com.gs.collections.api.list.MutableList<VV> collectWith(com.gs.collections.api.block.function.Function2<? super V,? super P,? extends VV> 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.map.sorted.MutableSortedMap<K,V>collectWith in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>collectWith in interface com.gs.collections.api.ordered.OrderedIterable<V>collectWith in interface com.gs.collections.api.ordered.ReversibleIterable<V>collectWith in interface com.gs.collections.api.RichIterable<V>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 <R> com.gs.collections.api.list.MutableList<R> collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate, com.gs.collections.api.block.function.Function<? super V,? extends R> 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.map.sorted.MutableSortedMap<K,V>collectIf in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>collectIf in interface com.gs.collections.api.ordered.OrderedIterable<V>collectIf in interface com.gs.collections.api.ordered.ReversibleIterable<V>collectIf in interface com.gs.collections.api.RichIterable<V>public <R> com.gs.collections.api.list.MutableList<R> flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<R>> 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.map.sorted.MutableSortedMap<K,V>flatCollect in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>flatCollect in interface com.gs.collections.api.ordered.OrderedIterable<V>flatCollect in interface com.gs.collections.api.ordered.ReversibleIterable<V>flatCollect in interface com.gs.collections.api.RichIterable<V>function - The Function to applyfunctionpublic com.gs.collections.api.list.MutableList<V> reject(com.gs.collections.api.block.predicate.Predicate<? super V> 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.map.MutableMapIterable<K,V>reject in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>reject in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>reject in interface com.gs.collections.api.ordered.OrderedIterable<V>reject in interface com.gs.collections.api.ordered.ReversibleIterable<V>reject in interface com.gs.collections.api.RichIterable<V>predicate - a Predicate to use as the reject criteriaPredicate.accept(Object) method to evaluate to falsepublic <P> com.gs.collections.api.list.MutableList<V> selectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? 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.map.MutableMapIterable<K,V>selectWith in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>selectWith in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>selectWith in interface com.gs.collections.api.ordered.OrderedIterable<V>selectWith in interface com.gs.collections.api.ordered.ReversibleIterable<V>selectWith in interface com.gs.collections.api.RichIterable<V>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 <P> com.gs.collections.api.list.MutableList<V> rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? 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.map.MutableMapIterable<K,V>rejectWith in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>rejectWith in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>rejectWith in interface com.gs.collections.api.ordered.OrderedIterable<V>rejectWith in interface com.gs.collections.api.ordered.ReversibleIterable<V>rejectWith in interface com.gs.collections.api.RichIterable<V>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.list.MutableList<V> select(com.gs.collections.api.block.predicate.Predicate<? super V> 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.map.MutableMapIterable<K,V>select in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>select in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>select in interface com.gs.collections.api.ordered.OrderedIterable<V>select in interface com.gs.collections.api.ordered.ReversibleIterable<V>select in interface com.gs.collections.api.RichIterable<V>public com.gs.collections.api.partition.list.PartitionMutableList<V> partition(com.gs.collections.api.block.predicate.Predicate<? super V> 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.map.MutableMapIterable<K,V>partition in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>partition in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>partition in interface com.gs.collections.api.ordered.OrderedIterable<V>partition in interface com.gs.collections.api.ordered.ReversibleIterable<V>partition in interface com.gs.collections.api.RichIterable<V>public <P> com.gs.collections.api.partition.list.PartitionMutableList<V> partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? 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.map.sorted.MutableSortedMap<K,V>partitionWith in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>partitionWith in interface com.gs.collections.api.ordered.OrderedIterable<V>partitionWith in interface com.gs.collections.api.ordered.ReversibleIterable<V>partitionWith in interface com.gs.collections.api.RichIterable<V>public <S> com.gs.collections.api.list.MutableList<S> selectInstancesOf(java.lang.Class<S> clazz)
com.gs.collections.api.RichIterableclazz.selectInstancesOf in interface com.gs.collections.api.map.MutableMapIterable<K,V>selectInstancesOf in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>selectInstancesOf in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>selectInstancesOf in interface com.gs.collections.api.ordered.OrderedIterable<V>selectInstancesOf in interface com.gs.collections.api.ordered.ReversibleIterable<V>selectInstancesOf in interface com.gs.collections.api.RichIterable<V>public <S> com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<V,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.map.MutableMapIterable<K,V>zip in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>zip in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>zip in interface com.gs.collections.api.ordered.OrderedIterable<V>zip in interface com.gs.collections.api.ordered.ReversibleIterable<V>zip in interface com.gs.collections.api.RichIterable<V>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.list.MutableList<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>> zipWithIndex()
com.gs.collections.api.RichIterableRichIterable with its indices.zipWithIndex in interface com.gs.collections.api.map.MutableMapIterable<K,V>zipWithIndex in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>zipWithIndex in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>zipWithIndex in interface com.gs.collections.api.ordered.OrderedIterable<V>zipWithIndex in interface com.gs.collections.api.ordered.ReversibleIterable<V>zipWithIndex in interface com.gs.collections.api.RichIterable<V>RichIterable containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)public <VV> com.gs.collections.api.multimap.list.MutableListMultimap<VV,V> groupBy(com.gs.collections.api.block.function.Function<? super V,? extends VV> 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.map.MutableMapIterable<K,V>groupBy in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>groupBy in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>groupBy in interface com.gs.collections.api.ordered.OrderedIterable<V>groupBy in interface com.gs.collections.api.ordered.ReversibleIterable<V>groupBy in interface com.gs.collections.api.RichIterable<V>public <VV> com.gs.collections.api.multimap.list.MutableListMultimap<VV,V> groupByEach(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<VV>> 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.map.MutableMapIterable<K,V>groupByEach in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>groupByEach in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>groupByEach in interface com.gs.collections.api.ordered.OrderedIterable<V>groupByEach in interface com.gs.collections.api.ordered.ReversibleIterable<V>groupByEach in interface com.gs.collections.api.RichIterable<V>public void reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super V> 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<V>public com.gs.collections.api.LazyIterable<V> asReversed()
com.gs.collections.api.ordered.ReversibleIterableasReversed in interface com.gs.collections.api.ordered.ReversibleIterable<V>public int detectLastIndex(com.gs.collections.api.block.predicate.Predicate<? super V> 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<V>public int indexOf(java.lang.Object object)
com.gs.collections.api.ordered.OrderedIterableindexOf in interface com.gs.collections.api.ordered.OrderedIterable<V>List.indexOf(Object)public <S> boolean corresponds(com.gs.collections.api.ordered.OrderedIterable<S> other,
com.gs.collections.api.block.predicate.Predicate2<? super V,? 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<V>public void forEach(int startIndex,
int endIndex,
com.gs.collections.api.block.procedure.Procedure<? super V> 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<V>public void forEachWithIndex(int fromIndex,
int toIndex,
com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super V> 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<V>public com.gs.collections.api.stack.MutableStack<V> toStack()
com.gs.collections.api.ordered.OrderedIterabletoStack in interface com.gs.collections.api.ordered.OrderedIterable<V>public int detectIndex(com.gs.collections.api.block.predicate.Predicate<? super V> 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<V>