Class OrderedMapAdapter<K,V>
- All Implemented Interfaces:
Serializable
,Iterable<V>
,Map<K,V>
,InternalIterable<V>
,MapIterable<K,V>
,MutableMapIterable<K,V>
,MutableOrderedMap<K,V>
,OrderedMap<K,V>
,OrderedIterable<V>
,ReversibleIterable<V>
,RichIterable<V>
public class OrderedMapAdapter<K,V> extends AbstractMapIterable<K,V> implements MutableOrderedMap<K,V>, Serializable
- Since:
- 9.2
- See Also:
- Serialized Form
-
Nested Class Summary
-
Method Summary
Modifier and Type Method Description static <K, V> MutableOrderedMap<K,V>
adapt(Map<K,V> map)
<K2, V2> MutableMap<K2,V2>
aggregateBy(Function<? super V,? extends K2> groupBy, Function0<? extends V2> zeroValueFactory, Function2<? super V2,? super V,? extends V2> nonMutatingAggregator)
Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.<K2, V2> MutableMap<K2,V2>
aggregateInPlaceBy(Function<? super V,? extends K2> groupBy, Function0<? extends V2> zeroValueFactory, Procedure2<? super V2,? super V> mutatingAggregator)
Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.LazyIterable<V>
asReversed()
Returns a reversed view of this ReversibleIterable.MutableOrderedMap<K,V>
asSynchronized()
Returns a synchronized wrapper backed by this map.MutableOrderedMap<K,V>
asUnmodifiable()
Returns an unmodifiable view of this map.void
clear()
MutableOrderedMap<K,V>
clone()
<R> MutableList<R>
collect(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.<K2, V2> MutableOrderedMap<K2,V2>
collect(Function2<? super K,? super V,Pair<K2,V2>> function)
For each key and value of the map the function is evaluated.MutableBooleanList
collectBoolean(BooleanFunction<? super V> booleanFunction)
Returns a new primitiveboolean
iterable with the results of applying the specified function on each element of the source collection.MutableByteList
collectByte(ByteFunction<? super V> byteFunction)
Returns a new primitivebyte
iterable with the results of applying the specified function on each element of the source collection.MutableCharList
collectChar(CharFunction<? super V> charFunction)
Returns a new primitivechar
iterable with the results of applying the specified function on each element of the source collection.MutableDoubleList
collectDouble(DoubleFunction<? super V> doubleFunction)
Returns a new primitivedouble
iterable with the results of applying the specified function on each element of the source collection.MutableFloatList
collectFloat(FloatFunction<? super V> floatFunction)
Returns a new primitivefloat
iterable with the results of applying the specified function on each element of the source collection.<R> MutableList<R>
collectIf(Predicate<? super V> predicate, 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.MutableIntList
collectInt(IntFunction<? super V> intFunction)
Returns a new primitiveint
iterable with the results of applying the specified function on each element of the source collection.MutableLongList
collectLong(LongFunction<? super V> longFunction)
Returns a new primitivelong
iterable with the results of applying the specified function on each element of the source collection.MutableShortList
collectShort(ShortFunction<? super V> shortFunction)
Returns a new primitiveshort
iterable with the results of applying the specified function on each element of the source collection.<R> MutableOrderedMap<K,R>
collectValues(Function2<? super K,? super V,? extends R> function)
For each key and value of the map the function is evaluated.<P, VV> MutableList<VV>
collectWith(Function2<? super V,? super P,? extends VV> function, P parameter)
Same asRichIterable.collect(Function)
with aFunction2
and specified parameter which is passed to the block.boolean
containsKey(Object key)
boolean
containsValue(Object value)
<S> boolean
corresponds(OrderedIterable<S> other, Predicate2<? super V,? super S> predicate)
Returns true if both OrderedIterables have the same length andpredicate
returns true for all corresponding elements e1 of thisOrderedIterable
and e2 ofother
.<V1> MutableBag<V1>
countBy(Function<? super V,? extends V1> function)
This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.<V1> MutableBag<V1>
countByEach(Function<? super V,? extends Iterable<V1>> function)
This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.<V1, P> MutableBag<V1>
countByWith(Function2<? super V,? super P,? extends V1> function, P parameter)
This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.Pair<K,V>
detect(Predicate2<? super K,? super V> predicate)
Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments.int
detectIndex(Predicate<? super V> predicate)
Returns the index of the first element of theOrderedIterable
for which thepredicate
evaluates to true.int
detectLastIndex(Predicate<? super V> predicate)
Returns the index of the last element of theReversibleIterable
for which thepredicate
evaluates to true.Optional<Pair<K,V>>
detectOptional(Predicate2<? super K,? super V> predicate)
Return the first key and value of the map as an Optional for which the predicate evaluates to true when they are given as arguments.MutableList<V>
distinct()
Returns a newOrderedIterable
containing the distinct elements in this iterable.MutableOrderedMap<K,V>
drop(int count)
Returns an iterable after skipping the firstcount
elements or an empty iterable if thecount
is greater than the length of the iterable.MutableOrderedMap<K,V>
dropWhile(Predicate<? super V> predicate)
Returns the final elements that do not satisfy the Predicate.MutableSet<Map.Entry<K,V>>
entrySet()
boolean
equals(Object o)
Follows the same general contract asMap.equals(Object)
.<R> MutableList<R>
flatCollect(Function<? super V,? extends Iterable<R>> function)
flatCollect
is a special case ofRichIterable.collect(Function)
.MutableListMultimap<V,K>
flip()
Given a map from Domain->
Range return a multimap from Range->
Domain.MutableOrderedMap<V,K>
flipUniqueValues()
Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.void
forEach(int startIndex, int endIndex, Procedure<? super V> procedure)
Iterates over the section of the iterable covered by the specified inclusive indexes.void
forEachKeyValue(Procedure2<? super K,? super V> procedure)
Calls theprocedure
with each key-value pair of the map.void
forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super V> objectIntProcedure)
Iterates over the section of the iterable covered by the specified inclusive indexes.V
get(Object key)
V
getIfAbsentPut(K key, Function0<? extends V> function)
Get and return the value in the Map at the specified key.V
getIfAbsentPut(K key, V value)
Get and return the value in the Map at the specified key.<P> V
getIfAbsentPutWith(K key, Function<? super P,? extends V> function, P parameter)
Get and return the value in the Map at the specified key.V
getIfAbsentPutWithKey(K key, Function<? super K,? extends V> function)
Get and return the value in the Map at the specified key.<VV> MutableListMultimap<VV,V>
groupBy(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> MutableListMultimap<VV,V>
groupByEach(Function<? super V,? extends Iterable<VV>> function)
Similar toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.<VV> MutableOrderedMap<VV,V>
groupByUniqueKey(Function<? super V,? extends VV> function)
For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key.int
hashCode()
Follows the same general contract asMap.hashCode()
.int
indexOf(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.boolean
isEmpty()
Returns true if this iterable has zero items.Iterator<V>
iterator()
MutableSet<K>
keySet()
RichIterable<K>
keysView()
Returns an unmodifiable lazy iterable wrapped around the keySet for the map.RichIterable<Pair<K,V>>
keyValuesView()
Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map.MutableOrderedMap<K,V>
newEmpty()
Creates a new instance of the same type, using the default capacity and growth parameters.PartitionMutableList<V>
partition(Predicate<? super V> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.PartitionMutableList<V>
partitionWhile(Predicate<? super V> predicate)
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.<P> PartitionMutableList<V>
partitionWith(Predicate2<? super V,? super P> predicate, P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.V
put(K key, V value)
void
putAll(Map<? extends K,? extends V> map)
MutableList<V>
reject(Predicate<? super V> predicate)
Returns all elements of the source collection that return false when evaluating of the predicate.MutableOrderedMap<K,V>
reject(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> MutableList<V>
rejectWith(Predicate2<? super V,? super P> predicate, P parameter)
Similar toRichIterable.reject(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.V
remove(Object key)
V
removeKey(K key)
Remove an entry from the map at the specifiedkey
.MutableList<V>
select(Predicate<? super V> predicate)
Returns all elements of the source collection that return true when evaluating the predicate.MutableOrderedMap<K,V>
select(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> MutableList<S>
selectInstancesOf(Class<S> clazz)
Returns all elements of the source collection that are instances of the Classclazz
.<P> MutableList<V>
selectWith(Predicate2<? super V,? super P> predicate, P parameter)
Similar toRichIterable.select(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.int
size()
Returns the number of items in this iterable.<V1> MutableObjectDoubleMap<V1>
sumByDouble(Function<? super V,? extends V1> groupBy, DoubleFunction<? super V> function)
Groups and sums the values using the two specified functions.<V1> MutableObjectDoubleMap<V1>
sumByFloat(Function<? super V,? extends V1> groupBy, FloatFunction<? super V> function)
Groups and sums the values using the two specified functions.<V1> MutableObjectLongMap<V1>
sumByInt(Function<? super V,? extends V1> groupBy, IntFunction<? super V> function)
Groups and sums the values using the two specified functions.<V1> MutableObjectLongMap<V1>
sumByLong(Function<? super V,? extends V1> groupBy, LongFunction<? super V> function)
Groups and sums the values using the two specified functions.MutableOrderedMap<K,V>
take(int count)
Returns the firstcount
elements of the iterable or all the elements in the iterable ifcount
is greater than the length of the iterable.MutableOrderedMap<K,V>
takeWhile(Predicate<? super V> predicate)
Returns the initial elements that satisfy the Predicate.MutableOrderedMap<K,V>
tap(Procedure<? super V> procedure)
Executes the Procedure for each value of the map and returnsthis
.ImmutableOrderedMap<K,V>
toImmutable()
Returns an immutable copy of this map.MutableOrderedMap<K,V>
toReversed()
Returns a new ReversibleIterable in reverse order.MutableStack<V>
toStack()
Converts the OrderedIterable to a mutable MutableStack implementation.String
toString()
Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets.V
updateValue(K key, Function0<? extends V> factory, Function<? super V,? extends V> function)
Looks up the value associated withkey
, applies thefunction
to it, and replaces the value.<P> V
updateValueWith(K key, Function0<? extends V> factory, Function2<? super V,? super P,? extends V> function, P parameter)
Same asMutableMapIterable.updateValue(Object, Function0, Function)
with a Function2 and specified parameter which is passed to the function.MutableCollection<V>
values()
RichIterable<V>
valuesView()
Returns an unmodifiable lazy iterable wrapped around the values for the map.MutableOrderedMap<K,V>
withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValues)
Convenience var-args version of withAllKeyValuesMutableOrderedMap<K,V>
withAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)
This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.MutableOrderedMap<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.MutableOrderedMap<K,V>
withMap(Map<? extends K,? extends V> map)
Similar toMap.putAll(Map)
, but returns this instead of voidMutableOrderedMap<K,V>
withoutAllKeys(Iterable<? extends K> keys)
This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.MutableOrderedMap<K,V>
withoutKey(K key)
This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.<S> MutableList<Pair<V,S>>
zip(Iterable<S> that)
Returns aRichIterable
formed from thisRichIterable
and anotherRichIterable
by combining corresponding elements in pairs.MutableList<Pair<V,Integer>>
zipWithIndex()
Zips thisRichIterable
with its indices.Methods inherited from class org.eclipse.collections.impl.map.AbstractMapIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, asLazy, chunk, contains, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, forEachKey, forEachValue, forEachWith, forEachWithIndex, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, getOnly, getOrDefault, ifPresentApply, noneSatisfy, noneSatisfyWith, toArray, toArray
Methods inherited from class org.eclipse.collections.impl.AbstractRichIterable
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, into, max, max, maxBy, min, min, minBy, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toBiMap, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, merge, putIfAbsent, remove, replace, replace, replaceAll
Methods inherited from interface org.eclipse.collections.api.map.MapIterable
forEachKey, forEachValue, getIfAbsent, getIfAbsentValue, getIfAbsentWith, ifPresentApply, parallelStream, spliterator, stream
Methods inherited from interface org.eclipse.collections.api.map.MutableMapIterable
add, aggregateBy, getOrDefault, putPair, removeAllKeys, removeIf
Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable
collectWithIndex, forEachWithIndex, getFirst, getFirstOptional, getLast, getLastOptional, max, min, zip, zipWithIndex
Methods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterable
collectWithIndex, reverseForEach, reverseForEachWithIndex
Methods inherited from interface org.eclipse.collections.api.RichIterable
aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsBy, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy
-
Method Details
-
adapt
-
equals
Description copied from interface:MapIterable
Follows the same general contract asMap.equals(Object)
. -
hashCode
public int hashCode()Description copied from interface:MapIterable
Follows the same general contract asMap.hashCode()
. -
newEmpty
Description copied from interface:MutableMapIterable
Creates a new instance of the same type, using the default capacity and growth parameters.- Specified by:
newEmpty
in interfaceMutableMapIterable<K,V>
-
forEachKeyValue
Description copied from interface:MapIterable
Calls theprocedure
with each key-value pair of the map.final Collection<String> collection = new ArrayList<String>(); MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "One", 2, "Two", 3, "Three"); map.forEachKeyValue((Integer key, String value) -> collection.add(String.valueOf(key) + value)); Verify.assertContainsAll(collection, "1One", "2Two", "3Three");
- Specified by:
forEachKeyValue
in interfaceMapIterable<K,V>
-
containsKey
- Specified by:
containsKey
in interfaceMap<K,V>
- Specified by:
containsKey
in interfaceMapIterable<K,V>
- See Also:
Map.containsKey(Object)
-
containsValue
- Specified by:
containsValue
in interfaceMap<K,V>
- Specified by:
containsValue
in interfaceMapIterable<K,V>
- See Also:
Map.containsValue(Object)
-
size
public int size()Description copied from interface:RichIterable
Returns the number of items in this iterable. -
isEmpty
public boolean isEmpty()Description copied from interface:RichIterable
Returns true if this iterable has zero items.- Specified by:
isEmpty
in interfaceMap<K,V>
- Specified by:
isEmpty
in interfaceRichIterable<K>
- Overrides:
isEmpty
in classAbstractRichIterable<V>
-
iterator
-
remove
-
putAll
-
values
-
entrySet
-
keySet
-
clear
public void clear() -
get
- Specified by:
get
in interfaceMap<K,V>
- Specified by:
get
in interfaceMapIterable<K,V>
- See Also:
Map.get(Object)
-
put
-
removeKey
Description copied from interface:MutableMapIterable
Remove an entry from the map at the specifiedkey
.- Specified by:
removeKey
in interfaceMutableMapIterable<K,V>
- Returns:
- The value removed from entry at key, or null if not found.
- See Also:
Map.remove(Object)
-
toString
Description copied from class:AbstractRichIterable
Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets.Assert.assertEquals("[]", Lists.mutable.empty().toString()); Assert.assertEquals("[1]", Lists.mutable.with(1).toString()); Assert.assertEquals("[1, 2, 3]", Lists.mutable.with(1, 2, 3).toString());
- Specified by:
toString
in interfaceMapIterable<K,V>
- Specified by:
toString
in interfaceRichIterable<K>
- Overrides:
toString
in classAbstractRichIterable<V>
- Returns:
- a string representation of this collection.
- See Also:
AbstractCollection.toString()
-
clone
-
toReversed
Description copied from interface:ReversibleIterable
Returns a new ReversibleIterable in reverse order.- Specified by:
toReversed
in interfaceMutableOrderedMap<K,V>
- Specified by:
toReversed
in interfaceOrderedMap<K,V>
- Specified by:
toReversed
in interfaceReversibleIterable<K>
-
take
Description copied from interface:ReversibleIterable
Returns the firstcount
elements of the iterable or all the elements in the iterable ifcount
is greater than the length of the iterable.- Specified by:
take
in interfaceMutableOrderedMap<K,V>
- Specified by:
take
in interfaceOrderedMap<K,V>
- Specified by:
take
in interfaceReversibleIterable<K>
- Parameters:
count
- the number of items to take.
-
takeWhile
Description copied from interface:ReversibleIterable
Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.- Specified by:
takeWhile
in interfaceMutableOrderedMap<K,V>
- Specified by:
takeWhile
in interfaceOrderedIterable<K>
- Specified by:
takeWhile
in interfaceOrderedMap<K,V>
- Specified by:
takeWhile
in interfaceReversibleIterable<K>
-
drop
Description copied from interface:ReversibleIterable
Returns an iterable after skipping the firstcount
elements or an empty iterable if thecount
is greater than the length of the iterable.- Specified by:
drop
in interfaceMutableOrderedMap<K,V>
- Specified by:
drop
in interfaceOrderedMap<K,V>
- Specified by:
drop
in interfaceReversibleIterable<K>
- Parameters:
count
- the number of items to drop.
-
dropWhile
Description copied from interface:ReversibleIterable
Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.- Specified by:
dropWhile
in interfaceMutableOrderedMap<K,V>
- Specified by:
dropWhile
in interfaceOrderedIterable<K>
- Specified by:
dropWhile
in interfaceOrderedMap<K,V>
- Specified by:
dropWhile
in interfaceReversibleIterable<K>
-
partitionWhile
Description copied from interface:OrderedIterable
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.- Specified by:
partitionWhile
in interfaceMutableOrderedMap<K,V>
- Specified by:
partitionWhile
in interfaceOrderedIterable<K>
- Specified by:
partitionWhile
in interfaceOrderedMap<K,V>
- Specified by:
partitionWhile
in interfaceReversibleIterable<K>
-
distinct
Description copied from interface:OrderedIterable
Returns a newOrderedIterable
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.- Specified by:
distinct
in interfaceMutableOrderedMap<K,V>
- Specified by:
distinct
in interfaceOrderedIterable<K>
- Specified by:
distinct
in interfaceOrderedMap<K,V>
- Specified by:
distinct
in interfaceReversibleIterable<K>
- Returns:
OrderedIterable
of distinct elements
-
withKeyValue
Description copied from interface:MutableMapIterable
This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus the additional key and value. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken: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.- Specified by:
withKeyValue
in interfaceMutableMapIterable<K,V>
- Specified by:
withKeyValue
in interfaceMutableOrderedMap<K,V>
- See Also:
Map.put(Object, Object)
-
withMap
Description copied from interface:MutableMapIterable
Similar toMap.putAll(Map)
, but returns this instead of void- Specified by:
withMap
in interfaceMutableMapIterable<K,V>
- Specified by:
withMap
in interfaceMutableOrderedMap<K,V>
- See Also:
Map.putAll(Map)
-
withAllKeyValues
public MutableOrderedMap<K,V> withAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)Description copied from interface:MutableMapIterable
This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus all of the additional keys and values. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken: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.- Specified by:
withAllKeyValues
in interfaceMutableMapIterable<K,V>
- Specified by:
withAllKeyValues
in interfaceMutableOrderedMap<K,V>
- See Also:
Map.put(Object, Object)
-
withAllKeyValueArguments
public MutableOrderedMap<K,V> withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValues)Description copied from interface:MutableMapIterable
Convenience var-args version of withAllKeyValues- Specified by:
withAllKeyValueArguments
in interfaceMutableMapIterable<K,V>
- Specified by:
withAllKeyValueArguments
in interfaceMutableOrderedMap<K,V>
- See Also:
MutableMapIterable.withAllKeyValues(Iterable)
-
withoutKey
Description copied from interface:MutableMapIterable
This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus the key and value to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken: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.- Specified by:
withoutKey
in interfaceMutableMapIterable<K,V>
- Specified by:
withoutKey
in interfaceMutableOrderedMap<K,V>
- See Also:
Map.remove(Object)
-
withoutAllKeys
Description copied from interface:MutableMapIterable
This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus all of the keys and values to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken: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.- Specified by:
withoutAllKeys
in interfaceMutableMapIterable<K,V>
- Specified by:
withoutAllKeys
in interfaceMutableOrderedMap<K,V>
- See Also:
Map.remove(Object)
-
asUnmodifiable
Description copied from interface:MutableMapIterable
Returns an unmodifiable view of this map. This is the equivalent of usingCollections.unmodifiableMap(this)
only with a return type that supports the full iteration protocols available onMutableMapIterable
. Methods which would mutate the underlying map will throw UnsupportedOperationExceptions.- Specified by:
asUnmodifiable
in interfaceMutableMapIterable<K,V>
- Specified by:
asUnmodifiable
in interfaceMutableOrderedMap<K,V>
- Returns:
- an unmodifiable view of this map.
- See Also:
Collections.unmodifiableMap(Map)
-
toImmutable
Description copied from interface:MutableMapIterable
Returns an immutable copy of this map. If the map is immutable, it returns itself.- Specified by:
toImmutable
in interfaceMapIterable<K,V>
- Specified by:
toImmutable
in interfaceMutableMapIterable<K,V>
- Specified by:
toImmutable
in interfaceOrderedMap<K,V>
-
asSynchronized
Description copied from interface:MutableMapIterable
Returns a synchronized wrapper backed by this map. This is the equivalent of callingCollections.synchronizedMap(this)
only with the more feature rich return type ofMutableMapIterable
.The preferred way of iterating over a synchronized map is to use the forEachKey(), forEachValue() and forEachKeyValue() methods which are properly synchronized internally.
MutableMap synchedMap = map.asSynchronized(); synchedMap.forEachKey(key -> ... ); synchedMap.forEachValue(value -> ... ); synchedMap.forEachKeyValue((key, value) -> ... );
If you want to iterate imperatively over the keySet(), values(), or entrySet(), you will need to protect the iteration by wrapping the code in a synchronized block on the map.
- Specified by:
asSynchronized
in interfaceMutableMapIterable<K,V>
- See Also:
Collections.synchronizedMap(Map)
-
flip
Description copied from interface:MapIterable
Given a map from Domain->
Range return a multimap from Range->
Domain. We chose the name 'flip' rather than 'invert' or 'transpose' since this method does not have the property of applying twice returns the original.Since 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.
- Specified by:
flip
in interfaceMapIterable<K,V>
- Specified by:
flip
in interfaceMutableMapIterable<K,V>
- Specified by:
flip
in interfaceMutableOrderedMap<K,V>
- Specified by:
flip
in interfaceOrderedMap<K,V>
-
collectBoolean
Description copied from interface:RichIterable
Returns a new primitiveboolean
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
BooleanIterable licenses = people.collectBoolean(person -> person.hasDrivingLicense());
Example using an anonymous inner class:
BooleanIterable licenses = people.collectBoolean(new BooleanFunction<Person>() { public boolean booleanValueOf(Person person) { return person.hasDrivingLicense(); } });
- Specified by:
collectBoolean
in interfaceMutableOrderedMap<K,V>
- Specified by:
collectBoolean
in interfaceOrderedIterable<K>
- Specified by:
collectBoolean
in interfaceOrderedMap<K,V>
- Specified by:
collectBoolean
in interfaceReversibleIterable<K>
- Specified by:
collectBoolean
in interfaceRichIterable<K>
-
collectByte
Description copied from interface:RichIterable
Returns a new primitivebyte
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
ByteIterable bytes = people.collectByte(person -> person.getCode());
Example using an anonymous inner class:
ByteIterable bytes = people.collectByte(new ByteFunction<Person>() { public byte byteValueOf(Person person) { return person.getCode(); } });
- Specified by:
collectByte
in interfaceMutableOrderedMap<K,V>
- Specified by:
collectByte
in interfaceOrderedIterable<K>
- Specified by:
collectByte
in interfaceOrderedMap<K,V>
- Specified by:
collectByte
in interfaceReversibleIterable<K>
- Specified by:
collectByte
in interfaceRichIterable<K>
-
collectChar
Description copied from interface:RichIterable
Returns a new primitivechar
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
CharIterable chars = people.collectChar(person -> person.getMiddleInitial());
Example using an anonymous inner class:
CharIterable chars = people.collectChar(new CharFunction<Person>() { public char charValueOf(Person person) { return person.getMiddleInitial(); } });
- Specified by:
collectChar
in interfaceMutableOrderedMap<K,V>
- Specified by:
collectChar
in interfaceOrderedIterable<K>
- Specified by:
collectChar
in interfaceOrderedMap<K,V>
- Specified by:
collectChar
in interfaceReversibleIterable<K>
- Specified by:
collectChar
in interfaceRichIterable<K>
-
collectDouble
Description copied from interface:RichIterable
Returns a new primitivedouble
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
DoubleIterable doubles = people.collectDouble(person -> person.getMilesFromNorthPole());
Example using an anonymous inner class:
DoubleIterable doubles = people.collectDouble(new DoubleFunction<Person>() { public double doubleValueOf(Person person) { return person.getMilesFromNorthPole(); } });
- Specified by:
collectDouble
in interfaceMutableOrderedMap<K,V>
- Specified by:
collectDouble
in interfaceOrderedIterable<K>
- Specified by:
collectDouble
in interfaceOrderedMap<K,V>
- Specified by:
collectDouble
in interfaceReversibleIterable<K>
- Specified by:
collectDouble
in interfaceRichIterable<K>
-
collectFloat
Description copied from interface:RichIterable
Returns a new primitivefloat
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
FloatIterable floats = people.collectFloat(person -> person.getHeightInInches());
Example using an anonymous inner class:
FloatIterable floats = people.collectFloat(new FloatFunction<Person>() { public float floatValueOf(Person person) { return person.getHeightInInches(); } });
- Specified by:
collectFloat
in interfaceMutableOrderedMap<K,V>
- Specified by:
collectFloat
in interfaceOrderedIterable<K>
- Specified by:
collectFloat
in interfaceOrderedMap<K,V>
- Specified by:
collectFloat
in interfaceReversibleIterable<K>
- Specified by:
collectFloat
in interfaceRichIterable<K>
-
collectInt
Description copied from interface:RichIterable
Returns a new primitiveint
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
IntIterable ints = people.collectInt(person -> person.getAge());
Example using an anonymous inner class:
IntIterable ints = people.collectInt(new IntFunction<Person>() { public int intValueOf(Person person) { return person.getAge(); } });
- Specified by:
collectInt
in interfaceMutableOrderedMap<K,V>
- Specified by:
collectInt
in interfaceOrderedIterable<K>
- Specified by:
collectInt
in interfaceOrderedMap<K,V>
- Specified by:
collectInt
in interfaceReversibleIterable<K>
- Specified by:
collectInt
in interfaceRichIterable<K>
-
collectLong
Description copied from interface:RichIterable
Returns a new primitivelong
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
LongIterable longs = people.collectLong(person -> person.getGuid());
Example using an anonymous inner class:
LongIterable longs = people.collectLong(new LongFunction<Person>() { public long longValueOf(Person person) { return person.getGuid(); } });
- Specified by:
collectLong
in interfaceMutableOrderedMap<K,V>
- Specified by:
collectLong
in interfaceOrderedIterable<K>
- Specified by:
collectLong
in interfaceOrderedMap<K,V>
- Specified by:
collectLong
in interfaceReversibleIterable<K>
- Specified by:
collectLong
in interfaceRichIterable<K>
-
collectShort
Description copied from interface:RichIterable
Returns a new primitiveshort
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
ShortIterable shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
Example using an anonymous inner class:
ShortIterable shorts = people.collectShort(new ShortFunction<Person>() { public short shortValueOf(Person person) { return person.getNumberOfJunkMailItemsReceivedPerMonth(); } });
- Specified by:
collectShort
in interfaceMutableOrderedMap<K,V>
- Specified by:
collectShort
in interfaceOrderedIterable<K>
- Specified by:
collectShort
in interfaceOrderedMap<K,V>
- Specified by:
collectShort
in interfaceReversibleIterable<K>
- Specified by:
collectShort
in interfaceRichIterable<K>
-
collectValues
public <R> MutableOrderedMap<K,R> collectValues(Function2<? super K,? super V,? extends R> function)Description copied from interface:MapIterable
For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.MapIterable<City, String> collected = peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName());
- Specified by:
collectValues
in interfaceMapIterable<K,V>
- Specified by:
collectValues
in interfaceMutableMapIterable<K,V>
- Specified by:
collectValues
in interfaceMutableOrderedMap<K,V>
- Specified by:
collectValues
in interfaceOrderedMap<K,V>
-
tap
Description copied from interface:MapIterable
Executes the Procedure for each value of the map and returnsthis
.return peopleByCity.tap(person -> LOGGER.info(person.getName()));
- Specified by:
tap
in interfaceMapIterable<K,V>
- Specified by:
tap
in interfaceMutableMapIterable<K,V>
- Specified by:
tap
in interfaceMutableOrderedMap<K,V>
- Specified by:
tap
in interfaceOrderedIterable<K>
- Specified by:
tap
in interfaceOrderedMap<K,V>
- Specified by:
tap
in interfaceReversibleIterable<K>
- Specified by:
tap
in interfaceRichIterable<K>
- See Also:
RichIterable.forEach(Procedure)
-
select
Description copied from interface:MapIterable
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.MapIterable<City, Person> selected = peopleByCity.select((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
- Specified by:
select
in interfaceMapIterable<K,V>
- Specified by:
select
in interfaceMutableMapIterable<K,V>
- Specified by:
select
in interfaceMutableOrderedMap<K,V>
- Specified by:
select
in interfaceOrderedMap<K,V>
-
reject
Description copied from interface:MapIterable
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.MapIterable<City, Person> rejected = peopleByCity.reject((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
- Specified by:
reject
in interfaceMapIterable<K,V>
- Specified by:
reject
in interfaceMutableMapIterable<K,V>
- Specified by:
reject
in interfaceMutableOrderedMap<K,V>
- Specified by:
reject
in interfaceOrderedMap<K,V>
-
collect
Description copied from interface:RichIterable
Returns a new collection 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:
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(); } });
- Specified by:
collect
in interfaceMutableOrderedMap<K,V>
- Specified by:
collect
in interfaceOrderedIterable<K>
- Specified by:
collect
in interfaceOrderedMap<K,V>
- Specified by:
collect
in interfaceReversibleIterable<K>
- Specified by:
collect
in interfaceRichIterable<K>
-
collectWith
public <P, VV> MutableList<VV> collectWith(Function2<? super V,? super P,? extends VV> function, P parameter)Description copied from interface:RichIterable
Same asRichIterable.collect(Function)
with aFunction2
and specified parameter which is passed to the block.Example using a Java 8 lambda expression:
RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
Example using an anonymous inner class:
Function2<Integer, Integer, Integer> addParameterFunction = new Function2<Integer, Integer, Integer>() { public Integer value(Integer each, Integer parameter) { return each + parameter; } }; RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
- Specified by:
collectWith
in interfaceMutableOrderedMap<K,V>
- Specified by:
collectWith
in interfaceOrderedIterable<K>
- Specified by:
collectWith
in interfaceOrderedMap<K,V>
- Specified by:
collectWith
in interfaceReversibleIterable<K>
- Specified by:
collectWith
in interfaceRichIterable<K>
- Parameters:
function
- AFunction2
to use as the collect transformation functionparameter
- A parameter to pass in for evaluation of the second argumentP
infunction
- Returns:
- A new
RichIterable
that contains the transformed elements returned byFunction2.value(Object, Object)
- See Also:
RichIterable.collect(Function)
-
collectIf
public <R> MutableList<R> collectIf(Predicate<? super V> predicate, Function<? super V,? extends R> function)Description copied from interface:RichIterable
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. This is the the optimized equivalent of calling iterable.select(predicate).collect(function).Example 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());
- Specified by:
collectIf
in interfaceMutableOrderedMap<K,V>
- Specified by:
collectIf
in interfaceOrderedIterable<K>
- Specified by:
collectIf
in interfaceOrderedMap<K,V>
- Specified by:
collectIf
in interfaceReversibleIterable<K>
- Specified by:
collectIf
in interfaceRichIterable<K>
-
flatCollect
Description copied from interface:RichIterable
flatCollect
is a special case ofRichIterable.collect(Function)
. Withcollect
, when theFunction
returns a collection, the result is a collection of collections.flatCollect
outputs a single "flattened" collection instead. This method is commonly called flatMap.Consider the following example where we have a
Person
class, and eachPerson
has a list ofAddress
objects. Take the followingFunction
:Function<Person, List<Address>> addressFunction = Person::getAddresses; RichIterable<Person> people = ...;
Usingcollect
returns a collection of collections of addresses.RichIterable<List<Address>> addresses = people.collect(addressFunction);
UsingflatCollect
returns a single flattened list of addresses.RichIterable<Address> addresses = people.flatCollect(addressFunction);
- Specified by:
flatCollect
in interfaceMutableOrderedMap<K,V>
- Specified by:
flatCollect
in interfaceOrderedIterable<K>
- Specified by:
flatCollect
in interfaceOrderedMap<K,V>
- Specified by:
flatCollect
in interfaceReversibleIterable<K>
- Specified by:
flatCollect
in interfaceRichIterable<K>
- Parameters:
function
- TheFunction
to apply- Returns:
- a new flattened collection produced by applying the given
function
-
select
Description copied from interface:RichIterable
Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.Example 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"); } });
- Specified by:
select
in interfaceMutableMapIterable<K,V>
- Specified by:
select
in interfaceMutableOrderedMap<K,V>
- Specified by:
select
in interfaceOrderedIterable<K>
- Specified by:
select
in interfaceOrderedMap<K,V>
- Specified by:
select
in interfaceReversibleIterable<K>
- Specified by:
select
in interfaceRichIterable<K>
-
reject
Description copied from interface:RichIterable
Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).Example 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"); } });
- Specified by:
reject
in interfaceMutableMapIterable<K,V>
- Specified by:
reject
in interfaceMutableOrderedMap<K,V>
- Specified by:
reject
in interfaceOrderedIterable<K>
- Specified by:
reject
in interfaceOrderedMap<K,V>
- Specified by:
reject
in interfaceReversibleIterable<K>
- Specified by:
reject
in interfaceRichIterable<K>
- Parameters:
predicate
- aPredicate
to use as the reject criteria- Returns:
- a RichIterable that contains elements that cause
Predicate.accept(Object)
method to evaluate to false
-
selectWith
Description copied from interface:RichIterable
Similar toRichIterable.select(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample 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));
- Specified by:
selectWith
in interfaceMutableMapIterable<K,V>
- Specified by:
selectWith
in interfaceMutableOrderedMap<K,V>
- Specified by:
selectWith
in interfaceOrderedIterable<K>
- Specified by:
selectWith
in interfaceOrderedMap<K,V>
- Specified by:
selectWith
in interfaceReversibleIterable<K>
- Specified by:
selectWith
in interfaceRichIterable<K>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
rejectWith
Description copied from interface:RichIterable
Similar toRichIterable.reject(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample 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));
- Specified by:
rejectWith
in interfaceMutableMapIterable<K,V>
- Specified by:
rejectWith
in interfaceMutableOrderedMap<K,V>
- Specified by:
rejectWith
in interfaceOrderedIterable<K>
- Specified by:
rejectWith
in interfaceOrderedMap<K,V>
- Specified by:
rejectWith
in interfaceReversibleIterable<K>
- Specified by:
rejectWith
in interfaceRichIterable<K>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
partition
Description copied from interface:RichIterable
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.Example using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(person -> person.getAddress().getState().getName().equals("New York"));
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(new Predicate<Person>() { public boolean accept(Person person) { return person.getAddress().getState().getName().equals("New York"); } });
- Specified by:
partition
in interfaceMutableMapIterable<K,V>
- Specified by:
partition
in interfaceMutableOrderedMap<K,V>
- Specified by:
partition
in interfaceOrderedIterable<K>
- Specified by:
partition
in interfaceOrderedMap<K,V>
- Specified by:
partition
in interfaceReversibleIterable<K>
- Specified by:
partition
in interfaceRichIterable<K>
-
partitionWith
public <P> PartitionMutableList<V> partitionWith(Predicate2<? super V,? super P> predicate, P parameter)Description copied from interface:RichIterable
Filters a collection into a PartitionIterable based on the evaluation of the predicate.Example using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith(new Predicate2<Person, String>() { public boolean accept(Person person, String state) { return person.getAddress().getState().getName().equals(state); } }, "New York");
- Specified by:
partitionWith
in interfaceMutableOrderedMap<K,V>
- Specified by:
partitionWith
in interfaceOrderedIterable<K>
- Specified by:
partitionWith
in interfaceOrderedMap<K,V>
- Specified by:
partitionWith
in interfaceReversibleIterable<K>
- Specified by:
partitionWith
in interfaceRichIterable<K>
-
selectInstancesOf
Description copied from interface:RichIterable
Returns all elements of the source collection that are instances of the Classclazz
.RichIterable<Integer> integers = List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
- Specified by:
selectInstancesOf
in interfaceMutableMapIterable<K,V>
- Specified by:
selectInstancesOf
in interfaceMutableOrderedMap<K,V>
- Specified by:
selectInstancesOf
in interfaceOrderedIterable<K>
- Specified by:
selectInstancesOf
in interfaceOrderedMap<K,V>
- Specified by:
selectInstancesOf
in interfaceReversibleIterable<K>
- Specified by:
selectInstancesOf
in interfaceRichIterable<K>
-
zip
Description copied from interface:RichIterable
Returns aRichIterable
formed from thisRichIterable
and anotherRichIterable
by combining corresponding elements in pairs. If one of the twoRichIterable
s is longer than the other, its remaining elements are ignored.- Specified by:
zip
in interfaceMutableMapIterable<K,V>
- Specified by:
zip
in interfaceMutableOrderedMap<K,V>
- Specified by:
zip
in interfaceOrderedIterable<K>
- Specified by:
zip
in interfaceOrderedMap<K,V>
- Specified by:
zip
in interfaceReversibleIterable<K>
- Specified by:
zip
in interfaceRichIterable<K>
- Type Parameters:
S
- the type of the second half of the returned pairs- Parameters:
that
- TheRichIterable
providing the second half of each result pair- Returns:
- A new
RichIterable
containing pairs consisting of corresponding elements of thisRichIterable
and that. The length of the returnedRichIterable
is the minimum of the lengths of thisRichIterable
and that.
-
zipWithIndex
Description copied from interface:RichIterable
Zips thisRichIterable
with its indices.- Specified by:
zipWithIndex
in interfaceMutableMapIterable<K,V>
- Specified by:
zipWithIndex
in interfaceMutableOrderedMap<K,V>
- Specified by:
zipWithIndex
in interfaceOrderedIterable<K>
- Specified by:
zipWithIndex
in interfaceOrderedMap<K,V>
- Specified by:
zipWithIndex
in interfaceReversibleIterable<K>
- Specified by:
zipWithIndex
in interfaceRichIterable<K>
- Returns:
- A new
RichIterable
containing pairs consisting of all elements of thisRichIterable
paired with their index. Indices start at 0. - See Also:
RichIterable.zip(Iterable)
-
groupBy
Description copied from interface:RichIterable
For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.Example using a Java 8 method reference:
Multimap<String, Person> peopleByLastName = people.groupBy(Person::getLastName);
Example using an anonymous inner class:
Multimap<String, Person> peopleByLastName = people.groupBy(new Function<Person, String>() { public String valueOf(Person person) { return person.getLastName(); } });
- Specified by:
groupBy
in interfaceMutableMapIterable<K,V>
- Specified by:
groupBy
in interfaceMutableOrderedMap<K,V>
- Specified by:
groupBy
in interfaceOrderedIterable<K>
- Specified by:
groupBy
in interfaceOrderedMap<K,V>
- Specified by:
groupBy
in interfaceReversibleIterable<K>
- Specified by:
groupBy
in interfaceRichIterable<K>
-
groupByEach
public <VV> MutableListMultimap<VV,V> groupByEach(Function<? super V,? extends Iterable<VV>> function)Description copied from interface:RichIterable
Similar toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.- Specified by:
groupByEach
in interfaceMutableMapIterable<K,V>
- Specified by:
groupByEach
in interfaceMutableOrderedMap<K,V>
- Specified by:
groupByEach
in interfaceOrderedIterable<K>
- Specified by:
groupByEach
in interfaceOrderedMap<K,V>
- Specified by:
groupByEach
in interfaceReversibleIterable<K>
- Specified by:
groupByEach
in interfaceRichIterable<K>
-
groupByUniqueKey
Description copied from interface:RichIterable
For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.- Specified by:
groupByUniqueKey
in interfaceMutableMapIterable<K,V>
- Specified by:
groupByUniqueKey
in interfaceMutableOrderedMap<K,V>
- Specified by:
groupByUniqueKey
in interfaceOrderedMap<K,V>
- Specified by:
groupByUniqueKey
in interfaceRichIterable<K>
- See Also:
RichIterable.groupBy(Function)
-
asReversed
Description copied from interface:ReversibleIterable
Returns a reversed view of this ReversibleIterable.- Specified by:
asReversed
in interfaceReversibleIterable<K>
-
detectLastIndex
Description copied from interface:ReversibleIterable
Returns the index of the last element of theReversibleIterable
for which thepredicate
evaluates to true. Returns -1 if no element evaluates true for thepredicate
.- Specified by:
detectLastIndex
in interfaceReversibleIterable<K>
-
indexOf
Description copied from interface:OrderedIterable
Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.- Specified by:
indexOf
in interfaceOrderedIterable<K>
- See Also:
List.indexOf(Object)
-
corresponds
public <S> boolean corresponds(OrderedIterable<S> other, Predicate2<? super V,? super S> predicate)Description copied from interface:OrderedIterable
Returns true if both OrderedIterables have the same length andpredicate
returns true for all corresponding elements e1 of thisOrderedIterable
and e2 ofother
. Thepredicate
is evaluated for each element at the same position of eachOrderedIterable
in a forward iteration order. This is a short circuit pattern.- Specified by:
corresponds
in interfaceOrderedIterable<K>
-
forEach
Description copied from interface:OrderedIterable
Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.e.g. OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally) people.forEach(0, 1, new Procedure<Person>() { public void value(Person person) { LOGGER.info(person.getName()); } });
This code would output ted and mary's names.
- Specified by:
forEach
in interfaceOrderedIterable<K>
-
forEachWithIndex
public void forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super V> objectIntProcedure)Description copied from interface:OrderedIterable
Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.e.g. OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally) people.forEachWithIndex(0, 1, new ObjectIntProcedure<Person>() { public void value(Person person, int index) { LOGGER.info(person.getName()); } });
This code would output ted and mary's names.
- Specified by:
forEachWithIndex
in interfaceOrderedIterable<K>
-
toStack
Description copied from interface:OrderedIterable
Converts the OrderedIterable to a mutable MutableStack implementation.- Specified by:
toStack
in interfaceOrderedIterable<K>
-
detectIndex
Description copied from interface:OrderedIterable
Returns the index of the first element of theOrderedIterable
for which thepredicate
evaluates to true. Returns -1 if no element evaluates true for thepredicate
.- Specified by:
detectIndex
in interfaceOrderedIterable<K>
-
getIfAbsentPut
Description copied from interface:MutableMapIterable
Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map at the key, return the result of evaluating the specified Function0, and put that value in the map at the specified key.- Specified by:
getIfAbsentPut
in interfaceMutableMapIterable<K,V>
-
getIfAbsentPut
Description copied from interface:MutableMapIterable
Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map at the key, return the specified value, and put that value in the map at the specified key.- Specified by:
getIfAbsentPut
in interfaceMutableMapIterable<K,V>
-
getIfAbsentPutWithKey
Description copied from interface:MutableMapIterable
Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map for that key return the result of evaluating the specified Function using the specified key, and put that value in the map at the specified key.- Specified by:
getIfAbsentPutWithKey
in interfaceMutableMapIterable<K,V>
-
getIfAbsentPutWith
Description copied from interface:MutableMapIterable
Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map for that key return the result of evaluating the specified Function using the specified parameter, and put that value in the map at the specified key.- Specified by:
getIfAbsentPutWith
in interfaceMutableMapIterable<K,V>
-
updateValue
public V updateValue(K key, Function0<? extends V> factory, Function<? super V,? extends V> function)Description copied from interface:MutableMapIterable
Looks up the value associated withkey
, applies thefunction
to it, and replaces the value. If there is no value associated withkey
, starts it off with a value supplied byfactory
.- Specified by:
updateValue
in interfaceMutableMapIterable<K,V>
-
updateValueWith
public <P> V updateValueWith(K key, Function0<? extends V> factory, Function2<? super V,? super P,? extends V> function, P parameter)Description copied from interface:MutableMapIterable
Same asMutableMapIterable.updateValue(Object, Function0, Function)
with a Function2 and specified parameter which is passed to the function.- Specified by:
updateValueWith
in interfaceMutableMapIterable<K,V>
-
aggregateInPlaceBy
public <K2, V2> MutableMap<K2,V2> aggregateInPlaceBy(Function<? super V,? extends K2> groupBy, Function0<? extends V2> zeroValueFactory, Procedure2<? super V2,? super V> mutatingAggregator)Description copied from interface:RichIterable
Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).- Specified by:
aggregateInPlaceBy
in interfaceMutableMapIterable<K,V>
- Specified by:
aggregateInPlaceBy
in interfaceRichIterable<K>
-
aggregateBy
public <K2, V2> MutableMap<K2,V2> aggregateBy(Function<? super V,? extends K2> groupBy, Function0<? extends V2> zeroValueFactory, Function2<? super V2,? super V,? extends V2> nonMutatingAggregator)Description copied from interface:RichIterable
Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with (i.e. Integer.valueOf(0)).- Specified by:
aggregateBy
in interfaceMutableMapIterable<K,V>
- Specified by:
aggregateBy
in interfaceRichIterable<K>
-
keysView
Description copied from interface:MapIterable
Returns an unmodifiable lazy iterable wrapped around the keySet for the map.- Specified by:
keysView
in interfaceMapIterable<K,V>
-
valuesView
Description copied from interface:MapIterable
Returns an unmodifiable lazy iterable wrapped around the values for the map.- Specified by:
valuesView
in interfaceMapIterable<K,V>
-
keyValuesView
Description copied from interface:MapIterable
Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map.- Specified by:
keyValuesView
in interfaceMapIterable<K,V>
-
collect
public <K2, V2> MutableOrderedMap<K2,V2> collect(Function2<? super K,? super V,Pair<K2,V2>> function)Description copied from interface:MapIterable
For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.MapIterable<String, String> collected = peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity()));
- Specified by:
collect
in interfaceMapIterable<K,V>
- Specified by:
collect
in interfaceMutableMapIterable<K,V>
- Specified by:
collect
in interfaceMutableOrderedMap<K,V>
- Specified by:
collect
in interfaceOrderedMap<K,V>
-
flipUniqueValues
Description copied from interface:MapIterable
Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.MapIterable<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3"); MapIterable<String, Integer> result = map.flipUniqueValues(); Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
- Specified by:
flipUniqueValues
in interfaceMapIterable<K,V>
- Specified by:
flipUniqueValues
in interfaceMutableMapIterable<K,V>
- Specified by:
flipUniqueValues
in interfaceMutableOrderedMap<K,V>
- Specified by:
flipUniqueValues
in interfaceOrderedMap<K,V>
-
detect
Description copied from interface:MapIterable
Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments. The predicate will only be evaluated until such pair is found or until all of the keys and values of the map have been used as arguments. That is, there may be keys and values of the map that are never used as arguments to the predicate. The result is null if predicate does not evaluate to true for any key/value combination.Pair<City, Person> detected = peopleByCity.detect((City city, Person person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
- Specified by:
detect
in interfaceMapIterable<K,V>
-
detectOptional
Description copied from interface:MapIterable
Return the first key and value of the map as an Optional for which the predicate evaluates to true when they are given as arguments. The predicate will only be evaluated until such pair is found or until all of the keys and values of the map have been used as arguments. That is, there may be keys and values of the map that are never used as arguments to the predicate.Optional<Pair<City, Person>> detected = peopleByCity.detectOptional((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
- Specified by:
detectOptional
in interfaceMapIterable<K,V>
-
sumByInt
public <V1> MutableObjectLongMap<V1> sumByInt(Function<? super V,? extends V1> groupBy, IntFunction<? super V> function)Description copied from interface:RichIterable
Groups and sums the values using the two specified functions.- Specified by:
sumByInt
in interfaceMutableMapIterable<K,V>
- Specified by:
sumByInt
in interfaceRichIterable<K>
-
sumByFloat
public <V1> MutableObjectDoubleMap<V1> sumByFloat(Function<? super V,? extends V1> groupBy, FloatFunction<? super V> function)Description copied from interface:RichIterable
Groups and sums the values using the two specified functions.- Specified by:
sumByFloat
in interfaceMutableMapIterable<K,V>
- Specified by:
sumByFloat
in interfaceRichIterable<K>
-
sumByLong
public <V1> MutableObjectLongMap<V1> sumByLong(Function<? super V,? extends V1> groupBy, LongFunction<? super V> function)Description copied from interface:RichIterable
Groups and sums the values using the two specified functions.- Specified by:
sumByLong
in interfaceMutableMapIterable<K,V>
- Specified by:
sumByLong
in interfaceRichIterable<K>
-
sumByDouble
public <V1> MutableObjectDoubleMap<V1> sumByDouble(Function<? super V,? extends V1> groupBy, DoubleFunction<? super V> function)Description copied from interface:RichIterable
Groups and sums the values using the two specified functions.- Specified by:
sumByDouble
in interfaceMutableMapIterable<K,V>
- Specified by:
sumByDouble
in interfaceRichIterable<K>
-
countBy
Description copied from interface:RichIterable
This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.- Specified by:
countBy
in interfaceMutableMapIterable<K,V>
- Specified by:
countBy
in interfaceRichIterable<K>
-
countByWith
public <V1, P> MutableBag<V1> countByWith(Function2<? super V,? super P,? extends V1> function, P parameter)Description copied from interface:RichIterable
This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.- Specified by:
countByWith
in interfaceMutableMapIterable<K,V>
- Specified by:
countByWith
in interfaceRichIterable<K>
-
countByEach
Description copied from interface:RichIterable
This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.- Specified by:
countByEach
in interfaceMutableMapIterable<K,V>
- Specified by:
countByEach
in interfaceRichIterable<K>
- Overrides:
countByEach
in classAbstractRichIterable<V>
- Since:
- 10.0.0
-