public abstract class AbstractImmutableBiMap<K,V> extends AbstractBiMap<K,V> implements com.gs.collections.api.bimap.ImmutableBiMap<K,V>, java.util.Map<K,V>
| Modifier and Type | Method and Description |
|---|---|
<K2,V2> com.gs.collections.api.map.ImmutableMap<K2,V2> |
aggregateBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy,
com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory,
com.gs.collections.api.block.function.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> com.gs.collections.api.map.ImmutableMap<K2,V2> |
aggregateInPlaceBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy,
com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory,
com.gs.collections.api.block.procedure.Procedure2<? super V2,? super V> mutatingAggregator)
Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
|
java.util.Map<K,V> |
castToMap() |
void |
clear() |
<VV> com.gs.collections.api.bag.ImmutableBag<VV> |
collect(com.gs.collections.api.block.function.Function<? super V,? extends VV> function)
Returns a new collection with the results of applying the specified function on each element of the source
collection.
|
<K2,V2> com.gs.collections.api.bimap.ImmutableBiMap<K2,V2> |
collect(com.gs.collections.api.block.function.Function2<? super K,? super V,com.gs.collections.api.tuple.Pair<K2,V2>> function)
For each key and value of the map the function is evaluated.
|
com.gs.collections.api.bag.primitive.ImmutableBooleanBag |
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.bag.primitive.ImmutableByteBag |
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.bag.primitive.ImmutableCharBag |
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.bag.primitive.ImmutableDoubleBag |
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.bag.primitive.ImmutableFloatBag |
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. |
<VV> com.gs.collections.api.bag.ImmutableBag<VV> |
collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate,
com.gs.collections.api.block.function.Function<? super V,? extends VV> 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.bag.primitive.ImmutableIntBag |
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. |
com.gs.collections.api.bag.primitive.ImmutableLongBag |
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.bag.primitive.ImmutableShortBag |
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.bimap.ImmutableBiMap<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.bag.ImmutableBag<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. |
java.util.Set<java.util.Map.Entry<K,V>> |
entrySet() |
<VV> com.gs.collections.api.bag.ImmutableBag<VV> |
flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<VV>> function)
flatCollect is a special case of RichIterable.collect(Function). |
com.gs.collections.api.multimap.set.ImmutableSetMultimap<V,K> |
flip()
Given a map from Domain -> Range return a multimap from Range -> Domain.
|
com.gs.collections.api.bimap.ImmutableBiMap<V,K> |
flipUniqueValues()
Return the MapIterable that is obtained by flipping the direction of this map and making the associations
from value to key.
|
protected com.gs.collections.api.map.ImmutableMap<K,V> |
getDelegate() |
protected com.gs.collections.api.map.ImmutableMap<V,K> |
getInverse() |
<VV> com.gs.collections.api.multimap.set.ImmutableSetMultimap<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.set.ImmutableSetMultimap<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. |
<VV> com.gs.collections.api.bimap.ImmutableBiMap<VV,V> |
groupByUniqueKey(com.gs.collections.api.block.function.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.
|
com.gs.collections.api.bimap.ImmutableBiMap<V,K> |
inverse()
Returns an inversed view of this BiMap, where the associations are in the direction of this bimap's values to keys.
|
java.util.Iterator<V> |
iterator() |
java.util.Set<K> |
keySet() |
com.gs.collections.api.bimap.ImmutableBiMap<K,V> |
newWithAllKeyValueArguments(com.gs.collections.api.tuple.Pair<? extends K,? extends V>... keyValuePairs) |
com.gs.collections.api.bimap.ImmutableBiMap<K,V> |
newWithAllKeyValues(java.lang.Iterable<? extends com.gs.collections.api.tuple.Pair<? extends K,? extends V>> keyValues) |
com.gs.collections.api.bimap.ImmutableBiMap<K,V> |
newWithKeyValue(K key,
V value) |
com.gs.collections.api.bimap.ImmutableBiMap<K,V> |
newWithoutAllKeys(java.lang.Iterable<? extends K> keys) |
com.gs.collections.api.bimap.ImmutableBiMap<K,V> |
newWithoutKey(K key) |
com.gs.collections.api.partition.set.PartitionImmutableSet<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.set.PartitionImmutableSet<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.
|
V |
put(K key,
V value) |
void |
putAll(java.util.Map<? extends K,? extends V> map) |
com.gs.collections.api.set.ImmutableSet<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.bimap.ImmutableBiMap<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.set.ImmutableSet<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. |
V |
remove(java.lang.Object key) |
com.gs.collections.api.set.ImmutableSet<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.bimap.ImmutableBiMap<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.set.ImmutableSet<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.set.ImmutableSet<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.bimap.ImmutableBiMap<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.bimap.ImmutableBiMap<K,V> |
toImmutable()
Converts the BiMap to an ImmutableBiMap.
|
com.gs.collections.api.map.MutableMap<K,V> |
toMap() |
java.util.Collection<V> |
values() |
<S> com.gs.collections.api.set.ImmutableSet<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.set.ImmutableSet<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsKey, containsValue, count, countWith, detect, detect, detectIfNone, detectWith, detectWithIfNone, each, equals, flatCollect, forEach, forEachKey, forEachKeyValue, forEachValue, forEachWith, forEachWithIndex, get, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, groupBy, groupByEach, groupByUniqueKey, hashCode, ifPresentApply, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, keysView, keyValuesView, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, valuesView, zip, zipWithIndexclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitcontainsKey, containsValue, detect, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, keysView, keyValuesView, toString, valuesViewallSatisfy, 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, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndexprotected com.gs.collections.api.map.ImmutableMap<K,V> getDelegate()
getDelegate in class AbstractBiMap<K,V>protected com.gs.collections.api.map.ImmutableMap<V,K> getInverse()
getInverse in class AbstractBiMap<K,V>public com.gs.collections.api.bimap.ImmutableBiMap<K,V> newWithKeyValue(K key, V value)
public com.gs.collections.api.bimap.ImmutableBiMap<K,V> newWithAllKeyValues(java.lang.Iterable<? extends com.gs.collections.api.tuple.Pair<? extends K,? extends V>> keyValues)
public com.gs.collections.api.bimap.ImmutableBiMap<K,V> newWithAllKeyValueArguments(com.gs.collections.api.tuple.Pair<? extends K,? extends V>... keyValuePairs)
public com.gs.collections.api.bimap.ImmutableBiMap<K,V> newWithoutAllKeys(java.lang.Iterable<? extends K> keys)
public com.gs.collections.api.bimap.ImmutableBiMap<V,K> inverse()
com.gs.collections.api.bimap.BiMappublic com.gs.collections.api.multimap.set.ImmutableSetMultimap<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.bimap.BiMap<K,V>flip in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>flip in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>flip in interface com.gs.collections.api.map.MapIterable<K,V>public com.gs.collections.api.bimap.ImmutableBiMap<V,K> flipUniqueValues()
com.gs.collections.api.map.MapIterable
MapIterable map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
MapIterable result = map.flipUniqueValues();
Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
flipUniqueValues in interface com.gs.collections.api.bimap.BiMap<K,V>flipUniqueValues in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>flipUniqueValues in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>flipUniqueValues in interface com.gs.collections.api.map.MapIterable<K,V>public java.util.Iterator<V> iterator()
iterator in interface java.lang.Iterable<V>public com.gs.collections.api.bimap.ImmutableBiMap<K,V> toImmutable()
com.gs.collections.api.bimap.BiMappublic <K2,V2> com.gs.collections.api.bimap.ImmutableBiMap<K2,V2> collect(com.gs.collections.api.block.function.Function2<? super K,? super V,com.gs.collections.api.tuple.Pair<K2,V2>> function)
com.gs.collections.api.bimap.BiMap
e.g.
peopleByCity.collect(new Function2<City, Person, String>()
{
public String value(City city, Person person)
{
return Pair.of(city.getCountry(), person.getAddress().getCity());
}
});
Implementations are expected to delegate to MutableBiMap.put(Object, Object),
ImmutableBiMap.newWithKeyValue(Object, Object), or equivalent, not MutableBiMap.forcePut(Object, Object).collect in interface com.gs.collections.api.bimap.BiMap<K,V>collect in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>collect in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>collect in interface com.gs.collections.api.map.MapIterable<K,V>public <VV> com.gs.collections.api.bag.ImmutableBag<VV> collect(com.gs.collections.api.block.function.Function<? super V,? extends VV> 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();
}
});
public <R> com.gs.collections.api.bimap.ImmutableBiMap<K,R> collectValues(com.gs.collections.api.block.function.Function2<? super K,? super V,? extends R> function)
com.gs.collections.api.bimap.BiMap
e.g.
peopleByCity.collectValues(new Function2<City, Person, String>()
{
public String value(City city, Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
Implementations are expected to delegate to MutableBiMap.put(Object, Object),
ImmutableBiMap.newWithKeyValue(Object, Object), or equivalent, not MutableBiMap.forcePut(Object, Object).collectValues in interface com.gs.collections.api.bimap.BiMap<K,V>collectValues in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>collectValues in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>collectValues in interface com.gs.collections.api.map.MapIterable<K,V>public com.gs.collections.api.bag.primitive.ImmutableBooleanBag 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.RichIterable<V>public com.gs.collections.api.bag.primitive.ImmutableByteBag 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.RichIterable<V>public com.gs.collections.api.bag.primitive.ImmutableCharBag 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.RichIterable<V>public com.gs.collections.api.bag.primitive.ImmutableDoubleBag 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.RichIterable<V>public com.gs.collections.api.bag.primitive.ImmutableFloatBag 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.RichIterable<V>public com.gs.collections.api.bag.primitive.ImmutableIntBag 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.RichIterable<V>public com.gs.collections.api.bag.primitive.ImmutableLongBag 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.RichIterable<V>public com.gs.collections.api.bag.primitive.ImmutableShortBag 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.RichIterable<V>public <P,VV> com.gs.collections.api.bag.ImmutableBag<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.bimap.ImmutableBiMap<K,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 <VV> com.gs.collections.api.bag.ImmutableBag<VV> collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate, com.gs.collections.api.block.function.Function<? super V,? extends VV> 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());
public <VV> com.gs.collections.api.bag.ImmutableBag<VV> flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<VV>> 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);
public com.gs.collections.api.bimap.ImmutableBiMap<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.bimap.BiMap<K,V>select in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>select in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>select in interface com.gs.collections.api.map.MapIterable<K,V>public com.gs.collections.api.bimap.ImmutableBiMap<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.bimap.BiMap<K,V>tap in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>tap in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>tap in interface com.gs.collections.api.map.MapIterable<K,V>tap in interface com.gs.collections.api.RichIterable<V>InternalIterable.forEach(Procedure)public com.gs.collections.api.set.ImmutableSet<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.bimap.BiMap<K,V>select in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>select in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>select in interface com.gs.collections.api.RichIterable<V>public <P> com.gs.collections.api.set.ImmutableSet<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.bimap.BiMap<K,V>selectWith in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>selectWith in interface com.gs.collections.api.map.ImmutableMapIterable<K,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 com.gs.collections.api.bimap.ImmutableBiMap<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.bimap.BiMap<K,V>reject in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>reject in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>reject in interface com.gs.collections.api.map.MapIterable<K,V>public com.gs.collections.api.set.ImmutableSet<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.bimap.BiMap<K,V>reject in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>reject in interface com.gs.collections.api.map.ImmutableMapIterable<K,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.set.ImmutableSet<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.bimap.BiMap<K,V>rejectWith in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>rejectWith in interface com.gs.collections.api.map.ImmutableMapIterable<K,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.partition.set.PartitionImmutableSet<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.bimap.BiMap<K,V>partition in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>partition in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>partition in interface com.gs.collections.api.RichIterable<V>public <P> com.gs.collections.api.partition.set.PartitionImmutableSet<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");
public <S> com.gs.collections.api.set.ImmutableSet<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.bimap.BiMap<K,V>zip in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>zip in interface com.gs.collections.api.map.ImmutableMapIterable<K,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.set.ImmutableSet<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.bimap.BiMap<K,V>zipWithIndex in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>zipWithIndex in interface com.gs.collections.api.map.ImmutableMapIterable<K,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.set.ImmutableSetMultimap<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.bimap.BiMap<K,V>groupBy in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>groupBy in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>groupBy in interface com.gs.collections.api.RichIterable<V>public <VV> com.gs.collections.api.multimap.set.ImmutableSetMultimap<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.bimap.BiMap<K,V>groupByEach in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>groupByEach in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>groupByEach in interface com.gs.collections.api.RichIterable<V>public <VV> com.gs.collections.api.bimap.ImmutableBiMap<VV,V> groupByUniqueKey(com.gs.collections.api.block.function.Function<? super V,? extends VV> function)
com.gs.collections.api.RichIterablegroupByUniqueKey in interface com.gs.collections.api.bimap.BiMap<K,V>groupByUniqueKey in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>groupByUniqueKey in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>groupByUniqueKey in interface com.gs.collections.api.RichIterable<V>RichIterable.groupBy(Function)public <K2,V2> com.gs.collections.api.map.ImmutableMap<K2,V2> aggregateBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy, com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory, com.gs.collections.api.block.function.Function2<? super V2,? super V,? extends V2> nonMutatingAggregator)
com.gs.collections.api.RichIterablepublic <K2,V2> com.gs.collections.api.map.ImmutableMap<K2,V2> aggregateInPlaceBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy, com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory, com.gs.collections.api.block.procedure.Procedure2<? super V2,? super V> mutatingAggregator)
com.gs.collections.api.RichIterablepublic <S> com.gs.collections.api.set.ImmutableSet<S> selectInstancesOf(java.lang.Class<S> clazz)
com.gs.collections.api.RichIterableclazz.selectInstancesOf in interface com.gs.collections.api.bimap.BiMap<K,V>selectInstancesOf in interface com.gs.collections.api.bimap.ImmutableBiMap<K,V>selectInstancesOf in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>selectInstancesOf in interface com.gs.collections.api.RichIterable<V>