public Interface ImmutableBiMap<K, V>

Overrides default org.eclipse.collections.api.RichIterable.aggregateBy, org.eclipse.collections.api.map.ImmutableMapIterable.aggregateBy.

Doc from org.eclipse.collections.api.RichIterable.aggregateBy.

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)).

Annotations

@Override

Since

11.0

Overrides default org.eclipse.collections.api.map.MapIterable.aggregateBy, org.eclipse.collections.api.map.ImmutableMapIterable.aggregateBy.

Doc from org.eclipse.collections.api.map.MapIterable.aggregateBy.

Applies an aggregate function over the map grouping results into a map based on the specific key and value groupBy functions. 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.

MapIterable<String, Interval> map = Maps.mutable.with("oneToFive", Interval.fromTo(1, 5), "sixToNine", Interval.fromTo(6, 9));

MapIterable<String, Long> result = map.aggregateBy(
        eachKey -> {
            return eachKey.equals("oneToFive")  ? "lessThanSix" : "greaterOrEqualsToSix";
        },
        each -> each.sumOfInt(Integer::intValue),
        () -> 0L,
        (argument1, argument2) -> argument1 + argument2);

MapIterable<String, Long> expected =
        Maps.mutable.with("lessThanSix", Interval.fromTo(1, 5).sumOfInt(Integer::intValue),
                "greaterOrEqualsToSix", Interval.fromTo(6, 9).sumOfInt(Integer::intValue));
Assert.assertEquals(expected, result);

Annotations

@Override

Since

11.0

Overrides default org.eclipse.collections.api.RichIterable.aggregateInPlaceBy, org.eclipse.collections.api.map.ImmutableMapIterable.aggregateInPlaceBy.

Doc from org.eclipse.collections.api.RichIterable.aggregateInPlaceBy.

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)).

Annotations

@Override

Since

11.0

Redeclares org.eclipse.collections.api.bimap.BiMap.collect, org.eclipse.collections.api.map.ImmutableMapIterable.collect.

Doc from org.eclipse.collections.api.bimap.BiMap.collect.

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()));

Annotations

@Override

Redeclares org.eclipse.collections.api.RichIterable.collect.

Doc from org.eclipse.collections.api.RichIterable.collect.

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());

Annotations

@Override

Redeclares org.eclipse.collections.api.RichIterable.collectIf.

Doc from org.eclipse.collections.api.RichIterable.collectIf.

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 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());

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.collectKeysUnique, org.eclipse.collections.api.map.ImmutableMapIterable.collectKeysUnique.

Doc from org.eclipse.collections.api.map.MapIterable.collectKeysUnique.

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 keys projected from the function rather than the original keys.

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.collectValues, org.eclipse.collections.api.map.ImmutableMapIterable.collectValues.

Doc from org.eclipse.collections.api.bimap.BiMap.collectValues.

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());

Annotations

@Override

Redeclares org.eclipse.collections.api.RichIterable.collectWith.

Doc from org.eclipse.collections.api.RichIterable.collectWith.

Same as 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));

Annotations

@Override

Redeclares org.eclipse.collections.api.RichIterable.flatCollect.

Doc from org.eclipse.collections.api.RichIterable.flatCollect.

flatCollect is a special case of 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;
RichIterable<Person> people = ...;

RichIterable<List<Address>> addresses = people.collect(addressFunction);

RichIterable<Address> addresses = people.flatCollect(addressFunction);

Annotations

@Override

Overrides default org.eclipse.collections.api.RichIterable.flatCollectWith.

Doc from org.eclipse.collections.api.RichIterable.flatCollectWith.

Same as flatCollect, only with a Function2 that is passed an extra parameter.

Annotations

@Override

Since

9.2

Redeclares org.eclipse.collections.api.bimap.BiMap.flip, org.eclipse.collections.api.map.ImmutableMapIterable.flip.

Doc from org.eclipse.collections.api.map.MapIterable.flip.

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.

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.flipUniqueValues, org.eclipse.collections.api.map.ImmutableMapIterable.flipUniqueValues.

Doc from org.eclipse.collections.api.map.MapIterable.flipUniqueValues.

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)));

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.groupBy, org.eclipse.collections.api.map.ImmutableMapIterable.groupBy.

Doc from org.eclipse.collections.api.RichIterable.groupBy.

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);

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.groupByEach, org.eclipse.collections.api.map.ImmutableMapIterable.groupByEach.

Doc from org.eclipse.collections.api.RichIterable.groupByEach.

Similar to groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Annotations

@Override

Implements org.eclipse.collections.api.bimap.BiMap.groupByUniqueKey, org.eclipse.collections.api.map.ImmutableMapIterable.groupByUniqueKey.

Doc from org.eclipse.collections.api.RichIterable.groupByUniqueKey.

For each element of the iterable, the function is evaluated, and the 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.

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.inverse.

Doc from org.eclipse.collections.api.bimap.BiMap.inverse.

Returns an inversed view of this BiMap, where the associations are in the direction of this bimap's values to keys.

Annotations

@Override

Redeclares org.eclipse.collections.api.map.ImmutableMapIterable.newWithAllKeyValueArguments.

Annotations

@Override

Redeclares org.eclipse.collections.api.map.ImmutableMapIterable.newWithAllKeyValues.

Annotations

@Override

Redeclares org.eclipse.collections.api.map.ImmutableMapIterable.newWithKeyValue.

Annotations

@Override

Redeclares org.eclipse.collections.api.map.ImmutableMapIterable.newWithMap.

Annotations

@Override

Redeclares org.eclipse.collections.api.map.ImmutableMapIterable.newWithMapIterable.

Annotations

@Override

Redeclares org.eclipse.collections.api.map.ImmutableMapIterable.newWithoutAllKeys.

Annotations

@Override

Redeclares org.eclipse.collections.api.map.ImmutableMapIterable.newWithoutKey.

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.partition, org.eclipse.collections.api.map.ImmutableMapIterable.partition.

Doc from org.eclipse.collections.api.RichIterable.partition.

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"));

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.partitionWith, org.eclipse.collections.api.RichIterable.partitionWith.

Doc from org.eclipse.collections.api.RichIterable.partitionWith.

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");

Annotations

@Override

Overrides default org.eclipse.collections.api.RichIterable.reduceBy, org.eclipse.collections.api.map.ImmutableMapIterable.reduceBy.

Doc from org.eclipse.collections.api.RichIterable.reduceBy.

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.

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.reject, org.eclipse.collections.api.map.ImmutableMapIterable.reject.

Doc from org.eclipse.collections.api.map.MapIterable.reject.

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"));

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.reject, org.eclipse.collections.api.map.ImmutableMapIterable.reject.

Doc from org.eclipse.collections.api.RichIterable.reject.

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"));

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.rejectWith, org.eclipse.collections.api.map.ImmutableMapIterable.rejectWith.

Doc from org.eclipse.collections.api.RichIterable.rejectWith.

Similar to 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));

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.select, org.eclipse.collections.api.map.ImmutableMapIterable.select.

Doc from org.eclipse.collections.api.map.MapIterable.select.

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"));

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.select, org.eclipse.collections.api.map.ImmutableMapIterable.select.

Doc from org.eclipse.collections.api.RichIterable.select.

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"));

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.selectInstancesOf, org.eclipse.collections.api.map.ImmutableMapIterable.selectInstancesOf.

Doc from org.eclipse.collections.api.RichIterable.selectInstancesOf.

Returns all elements of the source collection that are instances of the Class clazz.

RichIterable<Integer> integers =
    List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.selectWith, org.eclipse.collections.api.map.ImmutableMapIterable.selectWith.

Doc from org.eclipse.collections.api.RichIterable.selectWith.

Similar to 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));

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.tap, org.eclipse.collections.api.map.ImmutableMapIterable.tap.

Doc from org.eclipse.collections.api.map.MapIterable.tap.

Executes the Procedure for each value of the map and returns this.

return peopleByCity.tap(person -> LOGGER.info(person.getName()));

Annotations

@Override

Redeclares org.eclipse.collections.api.bimap.BiMap.zip, org.eclipse.collections.api.map.ImmutableMapIterable.zip.

Doc from org.eclipse.collections.api.RichIterable.zip.

Returns a RichIterable 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.

Annotations

@Override

@Deprecated

Redeclares org.eclipse.collections.api.bimap.BiMap.zipWithIndex, org.eclipse.collections.api.map.ImmutableMapIterable.zipWithIndex.

Doc from org.eclipse.collections.api.RichIterable.zipWithIndex.

Zips this RichIterable with its indices.

Annotations

@Override

@Deprecated