com.gs.collections.api.bimap

Interface BiMap<K,V>

All Superinterfaces:

InternalIterable<V>, Iterable<V>, MapIterable<K,V>, RichIterable<V>

All Known Subinterfaces:

ImmutableBiMap<K,V>, MutableBiMap<K,V>

All Known Implementing Classes:

HashBiMap

public interface BiMap<K,V>
extends MapIterable<K,V>

A map that allows users to look up key-value pairs from either direction. Uniqueness is enforced on both the keys and values.

Since:

4.2

Method Summary

Modifier and Type	Method and Description
<K2,V2> BiMap<K2,V2>	collect(Function2<? super K,? super V,Pair<K2,V2>> function) For each key and value of the map the function is evaluated.
<R> BiMap<K,R>	collectValues(Function2<? super K,? super V,? extends R> function) For each key and value of the map the function is evaluated.
BiMap<V,K>	inverse() Returns an inversed view of this BiMap, where the associations are in the direction of this bimap’s values to keys.
BiMap<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.
BiMap<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.
ImmutableBiMap<K,V>	toImmutable() Converts the BiMap to an ImmutableBiMap.

Methods inherited from interface com.gs.collections.api.map.MapIterable

containsKey, containsValue, detect, equals, flip, flipUniqueValues, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, keysView, keyValuesView, toString, valuesView

Methods inherited from interface com.gs.collections.api.RichIterable

aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collect, collectBoolean, collectBoolean, collectByte, collectByte, collectChar, collectChar, collectDouble, collectDouble, collectFloat, collectFloat, collectIf, collectIf, collectInt, collectInt, collectLong, collectLong, collectShort, collectShort, collectWith, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, flatCollect, getFirst, getLast, groupBy, groupBy, groupByEach, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, partition, partitionWith, reject, reject, rejectWith, rejectWith, select, select, selectInstancesOf, selectWith, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zip, zipWithIndex, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

inverse

BiMap<V,K> inverse()

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

toImmutable

ImmutableBiMap<K,V> toImmutable()

Converts the BiMap to an ImmutableBiMap. If the bimap is immutable, it returns itself.

collectValues

<R> BiMap<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.

e.g.
 peopleByCity.collectValues(new Function2<City, Person, String>()
 {
     public String value(City city, Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 

Specified by:

collectValues in interface MapIterable<K,V>

select

BiMap<K,V> select(Predicate2<? super K,? super V> predicate)

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.

e.g.
 peopleByCity.select(new Predicate2<City, Person>()
 {
     public boolean accept(City city, Person person)
     {
         return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
     }
 });
 

Specified by:

select in interface MapIterable<K,V>

collect

<K2,V2> BiMap<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.

e.g.
 peopleByCity.collect(new Function2<City, Person, String>()
 {
     public String value(City city, Person person)
     {
         return Pair.of(city.getCountry(), person.getAddress().getCity());
     }
 });
 

Specified by:

collect in interface MapIterable<K,V>

reject

BiMap<K,V> reject(Predicate2<? super K,? super V> predicate)

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.

e.g.
 peopleByCity.reject(new Predicate2<City, Person>()
 {
     public boolean accept(City city, Person person)
     {
         return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
     }
 });
 

Specified by:

reject in interface MapIterable<K,V>