| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.2) on Sat Aug 08 22:45:01 CDT 2020 --> |
| <title>BiMap (Eclipse Collections - 10.3.0)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2020-08-08"> |
| <meta name="description" content="declaration: package: org.eclipse.collections.api.bimap, interface: BiMap"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":38,"i20":38}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BiMap.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.collections.api.bimap</a></div> |
| <h1 title="Interface BiMap" class="title">Interface BiMap<K,​V></h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../InternalIterable.html" title="interface in org.eclipse.collections.api">InternalIterable</a><V></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><V></code>, <code><a href="../map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><K,​V></code>, <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><V></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="ImmutableBiMap.html" title="interface in org.eclipse.collections.api.bimap">ImmutableBiMap</a><K,​V></code>, <code><a href="MutableBiMap.html" title="interface in org.eclipse.collections.api.bimap">MutableBiMap</a><K,​V></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../impl/bimap/AbstractBiMap.html" title="class in org.eclipse.collections.impl.bimap">AbstractBiMap</a></code>, <code><a href="../../impl/bimap/immutable/AbstractImmutableBiMap.html" title="class in org.eclipse.collections.impl.bimap.immutable">AbstractImmutableBiMap</a></code>, <code><a href="../../impl/bimap/mutable/HashBiMap.html" title="class in org.eclipse.collections.impl.bimap.mutable">HashBiMap</a></code>, <code><a href="../../impl/bimap/mutable/SynchronizedBiMap.html" title="class in org.eclipse.collections.impl.bimap.mutable">SynchronizedBiMap</a></code>, <code><a href="../../impl/bimap/mutable/UnmodifiableBiMap.html" title="class in org.eclipse.collections.impl.bimap.mutable">UnmodifiableBiMap</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">BiMap<K,​V></span> |
| extends <a href="../map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><K,​V></pre> |
| <div class="block">A map that allows users to look up key-value pairs from either direction. Uniqueness is enforced on both the keys and values.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.2</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Deprecated Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code><K2,​ |
| V2> <a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><K2,​V2></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collect(org.eclipse.collections.api.block.function.Function2)">collect</a></span>​(<a href="../block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="BiMap.html" title="type parameter in BiMap">K</a>,​? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​<a href="../tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><K2,​V2>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">For each key and value of the map the function is evaluated.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code><R> <a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​R></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectValues(org.eclipse.collections.api.block.function.Function2)">collectValues</a></span>​(<a href="../block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="BiMap.html" title="type parameter in BiMap">K</a>,​? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? extends R> function)</code></th> |
| <td class="colLast"> |
| <div class="block">For each key and value of the map the function is evaluated.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><a href="../multimap/set/SetMultimap.html" title="interface in org.eclipse.collections.api.multimap.set">SetMultimap</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>,​<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flip()">flip</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Given a map from Domain <code>-></code> Range return a multimap from Range <code>-></code> Domain.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code><a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>,​<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flipUniqueValues()">flipUniqueValues</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return the MapIterable that is obtained by flipping the direction of this map and making the associations |
| from value to key.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code><V1> <a href="../multimap/set/SetMultimap.html" title="interface in org.eclipse.collections.api.multimap.set">SetMultimap</a><V1,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupBy(org.eclipse.collections.api.block.function.Function)">groupBy</a></span>​(<a href="../block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? extends V1> function)</code></th> |
| <td class="colLast"> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code><V1> <a href="../multimap/set/SetMultimap.html" title="interface in org.eclipse.collections.api.multimap.set">SetMultimap</a><V1,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupByEach(org.eclipse.collections.api.block.function.Function)">groupByEach</a></span>​(<a href="../block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><V1>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Similar to <a href="../RichIterable.html#groupBy(org.eclipse.collections.api.block.function.Function)"><code>RichIterable.groupBy(Function)</code></a>, except the result of evaluating function will return a collection of keys |
| for each value.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code><VV> <a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><VV,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupByUniqueKey(org.eclipse.collections.api.block.function.Function)">groupByUniqueKey</a></span>​(<a href="../block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? extends VV> function)</code></th> |
| <td class="colLast"> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code><a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>,​<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#inverse()">inverse</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an inversed view of this BiMap, where the associations are in the direction of this bimap's values to keys.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code><a href="../partition/set/PartitionUnsortedSet.html" title="interface in org.eclipse.collections.api.partition.set">PartitionUnsortedSet</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#partition(org.eclipse.collections.api.block.predicate.Predicate)">partition</a></span>​(<a href="../block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>> predicate)</code></th> |
| <td class="colLast"> |
| <div class="block">Filters a collection into a PartitionedIterable based on the evaluation of the predicate.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code><P> <a href="../partition/set/PartitionUnsortedSet.html" title="interface in org.eclipse.collections.api.partition.set">PartitionUnsortedSet</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#partitionWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">partitionWith</a></span>​(<a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? super P> predicate, |
| P parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Filters a collection into a PartitionIterable based on the evaluation of the predicate.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code><a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reject(org.eclipse.collections.api.block.predicate.Predicate)">reject</a></span>​(<a href="../block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>> predicate)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns all elements of the source collection that return false when evaluating of the predicate.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code><a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reject(org.eclipse.collections.api.block.predicate.Predicate2)">reject</a></span>​(<a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="BiMap.html" title="type parameter in BiMap">K</a>,​? super <a href="BiMap.html" title="type parameter in BiMap">V</a>> predicate)</code></th> |
| <td class="colLast"> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code><P> <a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rejectWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">rejectWith</a></span>​(<a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? super P> predicate, |
| P parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Similar to <a href="../RichIterable.html#reject(org.eclipse.collections.api.block.predicate.Predicate)"><code>RichIterable.reject(Predicate)</code></a>, except with an evaluation parameter for the second generic argument in <a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate"><code>Predicate2</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code><a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#select(org.eclipse.collections.api.block.predicate.Predicate)">select</a></span>​(<a href="../block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>> predicate)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns all elements of the source collection that return true when evaluating the predicate.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code><a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#select(org.eclipse.collections.api.block.predicate.Predicate2)">select</a></span>​(<a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="BiMap.html" title="type parameter in BiMap">K</a>,​? super <a href="BiMap.html" title="type parameter in BiMap">V</a>> predicate)</code></th> |
| <td class="colLast"> |
| <div class="block">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.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <td class="colFirst"><code><S> <a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><S></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectInstancesOf(java.lang.Class)">selectInstancesOf</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><S> clazz)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns all elements of the source collection that are instances of the Class <code>clazz</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i16"> |
| <td class="colFirst"><code><P> <a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">selectWith</a></span>​(<a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? super P> predicate, |
| P parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Similar to <a href="../RichIterable.html#select(org.eclipse.collections.api.block.predicate.Predicate)"><code>RichIterable.select(Predicate)</code></a>, except with an evaluation parameter for the second generic argument in <a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate"><code>Predicate2</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i17"> |
| <td class="colFirst"><code><a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tap(org.eclipse.collections.api.block.procedure.Procedure)">tap</a></span>​(<a href="../block/procedure/Procedure.html" title="interface in org.eclipse.collections.api.block.procedure">Procedure</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>> procedure)</code></th> |
| <td class="colLast"> |
| <div class="block">Executes the Procedure for each value of the map and returns <code>this</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i18"> |
| <td class="colFirst"><code><a href="ImmutableBiMap.html" title="interface in org.eclipse.collections.api.bimap">ImmutableBiMap</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toImmutable()">toImmutable</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the BiMap to an ImmutableBiMap.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i19"> |
| <td class="colFirst"><code><S> <a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><<a href="../tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>,​S>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#zip(java.lang.Iterable)">zip</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><S> that)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in 8.0.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i20"> |
| <td class="colFirst"><code><a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><<a href="../tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#zipWithIndex()">zipWithIndex</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in 8.0.</div> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.eclipse.collections.api.<a href="../InternalIterable.html" title="interface in org.eclipse.collections.api">InternalIterable</a></h3> |
| <a id="methods.inherited.from.class.org.eclipse.collections.api.InternalIterable"> |
| <!-- --> |
| </a><code><a href="../InternalIterable.html#forEach(java.util.function.Consumer)">forEach</a>, <a href="../InternalIterable.html#forEachWith(org.eclipse.collections.api.block.procedure.Procedure2,P)">forEachWith</a>, <a href="../InternalIterable.html#forEachWithIndex(org.eclipse.collections.api.block.procedure.primitive.ObjectIntProcedure)">forEachWithIndex</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Iterable"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang" class="externalLink">iterator</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.eclipse.collections.api.map.<a href="../map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a></h3> |
| <a id="methods.inherited.from.class.org.eclipse.collections.api.map.MapIterable"> |
| <!-- --> |
| </a><code><a href="../map/MapIterable.html#aggregateBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function0,org.eclipse.collections.api.block.function.Function2)">aggregateBy</a>, <a href="../map/MapIterable.html#containsKey(java.lang.Object)">containsKey</a>, <a href="../map/MapIterable.html#containsValue(java.lang.Object)">containsValue</a>, <a href="../map/MapIterable.html#detect(org.eclipse.collections.api.block.predicate.Predicate2)">detect</a>, <a href="../map/MapIterable.html#detectOptional(org.eclipse.collections.api.block.predicate.Predicate2)">detectOptional</a>, <a href="../map/MapIterable.html#equals(java.lang.Object)">equals</a>, <a href="../map/MapIterable.html#forEachKey(org.eclipse.collections.api.block.procedure.Procedure)">forEachKey</a>, <a href="../map/MapIterable.html#forEachKeyValue(org.eclipse.collections.api.block.procedure.Procedure2)">forEachKeyValue</a>, <a href="../map/MapIterable.html#forEachValue(org.eclipse.collections.api.block.procedure.Procedure)">forEachValue</a>, <a href="../map/MapIterable.html#get(java.lang.Object)">get</a>, <a href="../map/MapIterable.html#getIfAbsent(K,org.eclipse.collections.api.block.function.Function0)">getIfAbsent</a>, <a href="../map/MapIterable.html#getIfAbsentValue(K,V)">getIfAbsentValue</a>, <a href="../map/MapIterable.html#getIfAbsentWith(K,org.eclipse.collections.api.block.function.Function,P)">getIfAbsentWith</a>, <a href="../map/MapIterable.html#getOrDefault(java.lang.Object,V)">getOrDefault</a>, <a href="../map/MapIterable.html#hashCode()">hashCode</a>, <a href="../map/MapIterable.html#ifPresentApply(K,org.eclipse.collections.api.block.function.Function)">ifPresentApply</a>, <a href="../map/MapIterable.html#keysView()">keysView</a>, <a href="../map/MapIterable.html#keyValuesView()">keyValuesView</a>, <a href="../map/MapIterable.html#parallelStream()">parallelStream</a>, <a href="../map/MapIterable.html#spliterator()">spliterator</a>, <a href="../map/MapIterable.html#stream()">stream</a>, <a href="../map/MapIterable.html#toString()">toString</a>, <a href="../map/MapIterable.html#valuesView()">valuesView</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.eclipse.collections.api.<a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a></h3> |
| <a id="methods.inherited.from.class.org.eclipse.collections.api.RichIterable"> |
| <!-- --> |
| </a><code><a href="../RichIterable.html#aggregateBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function0,org.eclipse.collections.api.block.function.Function2)">aggregateBy</a>, <a href="../RichIterable.html#aggregateBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function0,org.eclipse.collections.api.block.function.Function2,R)">aggregateBy</a>, <a href="../RichIterable.html#aggregateInPlaceBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function0,org.eclipse.collections.api.block.procedure.Procedure2)">aggregateInPlaceBy</a>, <a href="../RichIterable.html#allSatisfy(org.eclipse.collections.api.block.predicate.Predicate)">allSatisfy</a>, <a href="../RichIterable.html#allSatisfyWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">allSatisfyWith</a>, <a href="../RichIterable.html#anySatisfy(org.eclipse.collections.api.block.predicate.Predicate)">anySatisfy</a>, <a href="../RichIterable.html#anySatisfyWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">anySatisfyWith</a>, <a href="../RichIterable.html#appendString(java.lang.Appendable)">appendString</a>, <a href="../RichIterable.html#appendString(java.lang.Appendable,java.lang.String)">appendString</a>, <a href="../RichIterable.html#appendString(java.lang.Appendable,java.lang.String,java.lang.String,java.lang.String)">appendString</a>, <a href="../RichIterable.html#asLazy()">asLazy</a>, <a href="../RichIterable.html#chunk(int)">chunk</a>, <a href="../RichIterable.html#collect(org.eclipse.collections.api.block.function.Function)">collect</a>, <a href="../RichIterable.html#collect(org.eclipse.collections.api.block.function.Function,R)">collect</a>, <a href="../RichIterable.html#collectBoolean(org.eclipse.collections.api.block.function.primitive.BooleanFunction)">collectBoolean</a>, <a href="../RichIterable.html#collectBoolean(org.eclipse.collections.api.block.function.primitive.BooleanFunction,R)">collectBoolean</a>, <a href="../RichIterable.html#collectByte(org.eclipse.collections.api.block.function.primitive.ByteFunction)">collectByte</a>, <a href="../RichIterable.html#collectByte(org.eclipse.collections.api.block.function.primitive.ByteFunction,R)">collectByte</a>, <a href="../RichIterable.html#collectChar(org.eclipse.collections.api.block.function.primitive.CharFunction)">collectChar</a>, <a href="../RichIterable.html#collectChar(org.eclipse.collections.api.block.function.primitive.CharFunction,R)">collectChar</a>, <a href="../RichIterable.html#collectDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction)">collectDouble</a>, <a href="../RichIterable.html#collectDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction,R)">collectDouble</a>, <a href="../RichIterable.html#collectFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction)">collectFloat</a>, <a href="../RichIterable.html#collectFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction,R)">collectFloat</a>, <a href="../RichIterable.html#collectIf(org.eclipse.collections.api.block.predicate.Predicate,org.eclipse.collections.api.block.function.Function)">collectIf</a>, <a href="../RichIterable.html#collectIf(org.eclipse.collections.api.block.predicate.Predicate,org.eclipse.collections.api.block.function.Function,R)">collectIf</a>, <a href="../RichIterable.html#collectInt(org.eclipse.collections.api.block.function.primitive.IntFunction)">collectInt</a>, <a href="../RichIterable.html#collectInt(org.eclipse.collections.api.block.function.primitive.IntFunction,R)">collectInt</a>, <a href="../RichIterable.html#collectLong(org.eclipse.collections.api.block.function.primitive.LongFunction)">collectLong</a>, <a href="../RichIterable.html#collectLong(org.eclipse.collections.api.block.function.primitive.LongFunction,R)">collectLong</a>, <a href="../RichIterable.html#collectShort(org.eclipse.collections.api.block.function.primitive.ShortFunction)">collectShort</a>, <a href="../RichIterable.html#collectShort(org.eclipse.collections.api.block.function.primitive.ShortFunction,R)">collectShort</a>, <a href="../RichIterable.html#collectWith(org.eclipse.collections.api.block.function.Function2,P)">collectWith</a>, <a href="../RichIterable.html#collectWith(org.eclipse.collections.api.block.function.Function2,P,R)">collectWith</a>, <a href="../RichIterable.html#contains(java.lang.Object)">contains</a>, <a href="../RichIterable.html#containsAll(java.util.Collection)">containsAll</a>, <a href="../RichIterable.html#containsAllArguments(java.lang.Object...)">containsAllArguments</a>, <a href="../RichIterable.html#containsAllIterable(java.lang.Iterable)">containsAllIterable</a>, <a href="../RichIterable.html#containsBy(org.eclipse.collections.api.block.function.Function,V)">containsBy</a>, <a href="../RichIterable.html#count(org.eclipse.collections.api.block.predicate.Predicate)">count</a>, <a href="../RichIterable.html#countBy(org.eclipse.collections.api.block.function.Function)">countBy</a>, <a href="../RichIterable.html#countBy(org.eclipse.collections.api.block.function.Function,R)">countBy</a>, <a href="../RichIterable.html#countByEach(org.eclipse.collections.api.block.function.Function)">countByEach</a>, <a href="../RichIterable.html#countByEach(org.eclipse.collections.api.block.function.Function,R)">countByEach</a>, <a href="../RichIterable.html#countByWith(org.eclipse.collections.api.block.function.Function2,P)">countByWith</a>, <a href="../RichIterable.html#countByWith(org.eclipse.collections.api.block.function.Function2,P,R)">countByWith</a>, <a href="../RichIterable.html#countWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">countWith</a>, <a href="../RichIterable.html#detect(org.eclipse.collections.api.block.predicate.Predicate)">detect</a>, <a href="../RichIterable.html#detectIfNone(org.eclipse.collections.api.block.predicate.Predicate,org.eclipse.collections.api.block.function.Function0)">detectIfNone</a>, <a href="../RichIterable.html#detectOptional(org.eclipse.collections.api.block.predicate.Predicate)">detectOptional</a>, <a href="../RichIterable.html#detectWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">detectWith</a>, <a href="../RichIterable.html#detectWithIfNone(org.eclipse.collections.api.block.predicate.Predicate2,P,org.eclipse.collections.api.block.function.Function0)">detectWithIfNone</a>, <a href="../RichIterable.html#detectWithOptional(org.eclipse.collections.api.block.predicate.Predicate2,P)">detectWithOptional</a>, <a href="../RichIterable.html#each(org.eclipse.collections.api.block.procedure.Procedure)">each</a>, <a href="../RichIterable.html#flatCollect(org.eclipse.collections.api.block.function.Function)">flatCollect</a>, <a href="../RichIterable.html#flatCollect(org.eclipse.collections.api.block.function.Function,R)">flatCollect</a>, <a href="../RichIterable.html#flatCollectBoolean(org.eclipse.collections.api.block.function.Function,R)">flatCollectBoolean</a>, <a href="../RichIterable.html#flatCollectByte(org.eclipse.collections.api.block.function.Function,R)">flatCollectByte</a>, <a href="../RichIterable.html#flatCollectChar(org.eclipse.collections.api.block.function.Function,R)">flatCollectChar</a>, <a href="../RichIterable.html#flatCollectDouble(org.eclipse.collections.api.block.function.Function,R)">flatCollectDouble</a>, <a href="../RichIterable.html#flatCollectFloat(org.eclipse.collections.api.block.function.Function,R)">flatCollectFloat</a>, <a href="../RichIterable.html#flatCollectInt(org.eclipse.collections.api.block.function.Function,R)">flatCollectInt</a>, <a href="../RichIterable.html#flatCollectLong(org.eclipse.collections.api.block.function.Function,R)">flatCollectLong</a>, <a href="../RichIterable.html#flatCollectShort(org.eclipse.collections.api.block.function.Function,R)">flatCollectShort</a>, <a href="../RichIterable.html#flatCollectWith(org.eclipse.collections.api.block.function.Function2,P)">flatCollectWith</a>, <a href="../RichIterable.html#flatCollectWith(org.eclipse.collections.api.block.function.Function2,P,R)">flatCollectWith</a>, <a href="../RichIterable.html#forEach(org.eclipse.collections.api.block.procedure.Procedure)">forEach</a>, <a href="../RichIterable.html#getAny()">getAny</a>, <a href="../RichIterable.html#getFirst()">getFirst</a>, <a href="../RichIterable.html#getLast()">getLast</a>, <a href="../RichIterable.html#getOnly()">getOnly</a>, <a href="../RichIterable.html#groupBy(org.eclipse.collections.api.block.function.Function,R)">groupBy</a>, <a href="../RichIterable.html#groupByAndCollect(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function,R)">groupByAndCollect</a>, <a href="../RichIterable.html#groupByEach(org.eclipse.collections.api.block.function.Function,R)">groupByEach</a>, <a href="../RichIterable.html#groupByUniqueKey(org.eclipse.collections.api.block.function.Function,R)">groupByUniqueKey</a>, <a href="../RichIterable.html#injectInto(double,org.eclipse.collections.api.block.function.primitive.DoubleObjectToDoubleFunction)">injectInto</a>, <a href="../RichIterable.html#injectInto(float,org.eclipse.collections.api.block.function.primitive.FloatObjectToFloatFunction)">injectInto</a>, <a href="../RichIterable.html#injectInto(int,org.eclipse.collections.api.block.function.primitive.IntObjectToIntFunction)">injectInto</a>, <a href="../RichIterable.html#injectInto(long,org.eclipse.collections.api.block.function.primitive.LongObjectToLongFunction)">injectInto</a>, <a href="../RichIterable.html#injectInto(IV,org.eclipse.collections.api.block.function.Function2)">injectInto</a>, <a href="../RichIterable.html#into(R)">into</a>, <a href="../RichIterable.html#isEmpty()">isEmpty</a>, <a href="../RichIterable.html#makeString()">makeString</a>, <a href="../RichIterable.html#makeString(java.lang.String)">makeString</a>, <a href="../RichIterable.html#makeString(java.lang.String,java.lang.String,java.lang.String)">makeString</a>, <a href="../RichIterable.html#max()">max</a>, <a href="../RichIterable.html#max(java.util.Comparator)">max</a>, <a href="../RichIterable.html#maxBy(org.eclipse.collections.api.block.function.Function)">maxBy</a>, <a href="../RichIterable.html#maxByOptional(org.eclipse.collections.api.block.function.Function)">maxByOptional</a>, <a href="../RichIterable.html#maxOptional()">maxOptional</a>, <a href="../RichIterable.html#maxOptional(java.util.Comparator)">maxOptional</a>, <a href="../RichIterable.html#min()">min</a>, <a href="../RichIterable.html#min(java.util.Comparator)">min</a>, <a href="../RichIterable.html#minBy(org.eclipse.collections.api.block.function.Function)">minBy</a>, <a href="../RichIterable.html#minByOptional(org.eclipse.collections.api.block.function.Function)">minByOptional</a>, <a href="../RichIterable.html#minOptional()">minOptional</a>, <a href="../RichIterable.html#minOptional(java.util.Comparator)">minOptional</a>, <a href="../RichIterable.html#noneSatisfy(org.eclipse.collections.api.block.predicate.Predicate)">noneSatisfy</a>, <a href="../RichIterable.html#noneSatisfyWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">noneSatisfyWith</a>, <a href="../RichIterable.html#notEmpty()">notEmpty</a>, <a href="../RichIterable.html#reduce(java.util.function.BinaryOperator)">reduce</a>, <a href="../RichIterable.html#reduceInPlace(java.util.function.Supplier,java.util.function.BiConsumer)">reduceInPlace</a>, <a href="../RichIterable.html#reduceInPlace(java.util.stream.Collector)">reduceInPlace</a>, <a href="../RichIterable.html#reject(org.eclipse.collections.api.block.predicate.Predicate,R)">reject</a>, <a href="../RichIterable.html#rejectWith(org.eclipse.collections.api.block.predicate.Predicate2,P,R)">rejectWith</a>, <a href="../RichIterable.html#select(org.eclipse.collections.api.block.predicate.Predicate,R)">select</a>, <a href="../RichIterable.html#selectWith(org.eclipse.collections.api.block.predicate.Predicate2,P,R)">selectWith</a>, <a href="../RichIterable.html#size()">size</a>, <a href="../RichIterable.html#sumByDouble(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.primitive.DoubleFunction)">sumByDouble</a>, <a href="../RichIterable.html#sumByFloat(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.primitive.FloatFunction)">sumByFloat</a>, <a href="../RichIterable.html#sumByInt(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.primitive.IntFunction)">sumByInt</a>, <a href="../RichIterable.html#sumByLong(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.primitive.LongFunction)">sumByLong</a>, <a href="../RichIterable.html#summarizeDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction)">summarizeDouble</a>, <a href="../RichIterable.html#summarizeFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction)">summarizeFloat</a>, <a href="../RichIterable.html#summarizeInt(org.eclipse.collections.api.block.function.primitive.IntFunction)">summarizeInt</a>, <a href="../RichIterable.html#summarizeLong(org.eclipse.collections.api.block.function.primitive.LongFunction)">summarizeLong</a>, <a href="../RichIterable.html#sumOfDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction)">sumOfDouble</a>, <a href="../RichIterable.html#sumOfFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction)">sumOfFloat</a>, <a href="../RichIterable.html#sumOfInt(org.eclipse.collections.api.block.function.primitive.IntFunction)">sumOfInt</a>, <a href="../RichIterable.html#sumOfLong(org.eclipse.collections.api.block.function.primitive.LongFunction)">sumOfLong</a>, <a href="../RichIterable.html#toArray()">toArray</a>, <a href="../RichIterable.html#toArray(E%5B%5D)">toArray</a>, <a href="../RichIterable.html#toBag()">toBag</a>, <a href="../RichIterable.html#toBiMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toBiMap</a>, <a href="../RichIterable.html#toList()">toList</a>, <a href="../RichIterable.html#toMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toMap</a>, <a href="../RichIterable.html#toMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function,R)">toMap</a>, <a href="../RichIterable.html#toSet()">toSet</a>, <a href="../RichIterable.html#toSortedBag()">toSortedBag</a>, <a href="../RichIterable.html#toSortedBag(java.util.Comparator)">toSortedBag</a>, <a href="../RichIterable.html#toSortedBagBy(org.eclipse.collections.api.block.function.Function)">toSortedBagBy</a>, <a href="../RichIterable.html#toSortedList()">toSortedList</a>, <a href="../RichIterable.html#toSortedList(java.util.Comparator)">toSortedList</a>, <a href="../RichIterable.html#toSortedListBy(org.eclipse.collections.api.block.function.Function)">toSortedListBy</a>, <a href="../RichIterable.html#toSortedMap(java.util.Comparator,org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toSortedMap</a>, <a href="../RichIterable.html#toSortedMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toSortedMap</a>, <a href="../RichIterable.html#toSortedMapBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toSortedMapBy</a>, <a href="../RichIterable.html#toSortedSet()">toSortedSet</a>, <a href="../RichIterable.html#toSortedSet(java.util.Comparator)">toSortedSet</a>, <a href="../RichIterable.html#toSortedSetBy(org.eclipse.collections.api.block.function.Function)">toSortedSetBy</a>, <a href="../RichIterable.html#zip(java.lang.Iterable,R)">zip</a>, <a href="../RichIterable.html#zipWithIndex(R)">zipWithIndex</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="inverse()">inverse</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>,​<a href="BiMap.html" title="type parameter in BiMap">K</a>></span> <span class="memberName">inverse</span>()</div> |
| <div class="block">Returns an inversed view of this BiMap, where the associations are in the direction of this bimap's values to keys.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flip()">flip</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../multimap/set/SetMultimap.html" title="interface in org.eclipse.collections.api.multimap.set">SetMultimap</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>,​<a href="BiMap.html" title="type parameter in BiMap">K</a>></span> <span class="memberName">flip</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../map/MapIterable.html#flip()">MapIterable</a></code></span></div> |
| <div class="block">Given a map from Domain <code>-></code> Range return a multimap from Range <code>-></code> 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. |
| <p> |
| 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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../map/MapIterable.html#flip()">flip</a></code> in interface <code><a href="../map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flipUniqueValues()">flipUniqueValues</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>,​<a href="BiMap.html" title="type parameter in BiMap">K</a>></span> <span class="memberName">flipUniqueValues</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../map/MapIterable.html#flipUniqueValues()">MapIterable</a></code></span></div> |
| <div class="block">Return the MapIterable that is obtained by flipping the direction of this map and making the associations |
| from value to key. |
| <pre> |
| 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))); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../map/MapIterable.html#flipUniqueValues()">flipUniqueValues</a></code> in interface <code><a href="../map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toImmutable()">toImmutable</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="ImmutableBiMap.html" title="interface in org.eclipse.collections.api.bimap">ImmutableBiMap</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></span> <span class="memberName">toImmutable</span>()</div> |
| <div class="block">Converts the BiMap to an ImmutableBiMap. If the bimap is immutable, it returns itself.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../map/MapIterable.html#toImmutable()">toImmutable</a></code> in interface <code><a href="../map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="tap(org.eclipse.collections.api.block.procedure.Procedure)">tap</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></span> <span class="memberName">tap</span>​(<span class="arguments"><a href="../block/procedure/Procedure.html" title="interface in org.eclipse.collections.api.block.procedure">Procedure</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>> procedure)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../map/MapIterable.html#tap(org.eclipse.collections.api.block.procedure.Procedure)">MapIterable</a></code></span></div> |
| <div class="block">Executes the Procedure for each value of the map and returns <code>this</code>. |
| |
| <pre> |
| return peopleByCity.<b>tap</b>(person -> LOGGER.info(person.getName())); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../map/MapIterable.html#tap(org.eclipse.collections.api.block.procedure.Procedure)">tap</a></code> in interface <code><a href="../map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../RichIterable.html#tap(org.eclipse.collections.api.block.procedure.Procedure)">tap</a></code> in interface <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../RichIterable.html#forEach(org.eclipse.collections.api.block.procedure.Procedure)"><code>RichIterable.forEach(Procedure)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="select(org.eclipse.collections.api.block.predicate.Predicate2)">select</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></span> <span class="memberName">select</span>​(<span class="arguments"><a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="BiMap.html" title="type parameter in BiMap">K</a>,​? super <a href="BiMap.html" title="type parameter in BiMap">V</a>> predicate)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../map/MapIterable.html#select(org.eclipse.collections.api.block.predicate.Predicate2)">MapIterable</a></code></span></div> |
| <div class="block">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. |
| |
| <pre> |
| MapIterable<City, Person> selected = |
| peopleByCity.select((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith")); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../map/MapIterable.html#select(org.eclipse.collections.api.block.predicate.Predicate2)">select</a></code> in interface <code><a href="../map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="reject(org.eclipse.collections.api.block.predicate.Predicate2)">reject</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></span> <span class="memberName">reject</span>​(<span class="arguments"><a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="BiMap.html" title="type parameter in BiMap">K</a>,​? super <a href="BiMap.html" title="type parameter in BiMap">V</a>> predicate)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../map/MapIterable.html#reject(org.eclipse.collections.api.block.predicate.Predicate2)">MapIterable</a></code></span></div> |
| <div class="block">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. |
| |
| <pre> |
| MapIterable<City, Person> rejected = |
| peopleByCity.reject((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith")); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../map/MapIterable.html#reject(org.eclipse.collections.api.block.predicate.Predicate2)">reject</a></code> in interface <code><a href="../map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collect(org.eclipse.collections.api.block.function.Function2)">collect</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><K2,​ |
| V2></span> <span class="returnType"><a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><K2,​V2></span> <span class="memberName">collect</span>​(<span class="arguments"><a href="../block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="BiMap.html" title="type parameter in BiMap">K</a>,​? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​<a href="../tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><K2,​V2>> function)</span></div> |
| <div class="block">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. |
| |
| <pre> |
| MapIterable<String, String> collected = |
| peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity())); |
| </pre> |
| |
| Implementations are expected to delegate to <a href="MutableBiMap.html#put(K,V)"><code>MutableBiMap.put(Object, Object)</code></a>, |
| <a href="ImmutableBiMap.html#newWithKeyValue(K,V)"><code>ImmutableBiMap.newWithKeyValue(Object, Object)</code></a>, or equivalent, not <a href="MutableBiMap.html#forcePut(K,V)"><code>MutableBiMap.forcePut(Object, Object)</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../map/MapIterable.html#collect(org.eclipse.collections.api.block.function.Function2)">collect</a></code> in interface <code><a href="../map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang" class="externalLink">RuntimeException</a></code> - when <code>function</code> returns colliding keys or values.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectValues(org.eclipse.collections.api.block.function.Function2)">collectValues</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><R></span> <span class="returnType"><a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​R></span> <span class="memberName">collectValues</span>​(<span class="arguments"><a href="../block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="BiMap.html" title="type parameter in BiMap">K</a>,​? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? extends R> function)</span></div> |
| <div class="block">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. |
| |
| <pre> |
| MapIterable<City, String> collected = |
| peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName()); |
| </pre> |
| |
| Implementations are expected to delegate to <a href="MutableBiMap.html#put(K,V)"><code>MutableBiMap.put(Object, Object)</code></a>, |
| <a href="ImmutableBiMap.html#newWithKeyValue(K,V)"><code>ImmutableBiMap.newWithKeyValue(Object, Object)</code></a>, or equivalent, not <a href="MutableBiMap.html#forcePut(K,V)"><code>MutableBiMap.forcePut(Object, Object)</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../map/MapIterable.html#collectValues(org.eclipse.collections.api.block.function.Function2)">collectValues</a></code> in interface <code><a href="../map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang" class="externalLink">RuntimeException</a></code> - when <code>function</code> returns colliding values.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="select(org.eclipse.collections.api.block.predicate.Predicate)">select</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>></span> <span class="memberName">select</span>​(<span class="arguments"><a href="../block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>> predicate)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../RichIterable.html#select(org.eclipse.collections.api.block.predicate.Predicate)">RichIterable</a></code></span></div> |
| <div class="block">Returns all elements of the source collection that return true when evaluating the predicate. This method is also |
| commonly called filter. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| RichIterable<Person> selected = |
| people.<b>select</b>(person -> person.getAddress().getCity().equals("London")); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| RichIterable<Person> selected = |
| people.<b>select</b>(new Predicate<Person>() |
| { |
| public boolean accept(Person person) |
| { |
| return person.getAddress().getCity().equals("London"); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../RichIterable.html#select(org.eclipse.collections.api.block.predicate.Predicate)">select</a></code> in interface <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="selectWith(org.eclipse.collections.api.block.predicate.Predicate2,java.lang.Object)"> |
| <!-- --> |
| </a><a id="selectWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">selectWith</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P></span> <span class="returnType"><a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>></span> <span class="memberName">selectWith</span>​(<span class="arguments"><a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? super P> predicate, |
| P parameter)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../RichIterable.html#selectWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">RichIterable</a></code></span></div> |
| <div class="block">Similar to <a href="../RichIterable.html#select(org.eclipse.collections.api.block.predicate.Predicate)"><code>RichIterable.select(Predicate)</code></a>, except with an evaluation parameter for the second generic argument in <a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate"><code>Predicate2</code></a>. |
| <p> |
| E.g. return a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Collection</code></a> of Person elements where the person has an age <b>greater than or equal to</b> 18 years |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| RichIterable<Person> selected = |
| people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18)); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| RichIterable<Person> selected = |
| people.selectWith(new Predicate2<Person, Integer>() |
| { |
| public boolean accept(Person person, Integer age) |
| { |
| return person.getAge()>= age; |
| } |
| }, Integer.valueOf(18)); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../RichIterable.html#selectWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">selectWith</a></code> in interface <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>predicate</code> - a <a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate"><code>Predicate2</code></a> to use as the select criteria</dd> |
| <dd><code>parameter</code> - a parameter to pass in for evaluation of the second argument <code>P</code> in <code>predicate</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../RichIterable.html#select(org.eclipse.collections.api.block.predicate.Predicate)"><code>RichIterable.select(Predicate)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="reject(org.eclipse.collections.api.block.predicate.Predicate)">reject</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>></span> <span class="memberName">reject</span>​(<span class="arguments"><a href="../block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>> predicate)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../RichIterable.html#reject(org.eclipse.collections.api.block.predicate.Predicate)">RichIterable</a></code></span></div> |
| <div class="block">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)). |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| RichIterable<Person> rejected = |
| people.reject(person -> person.person.getLastName().equals("Smith")); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| RichIterable<Person> rejected = |
| people.reject(new Predicate<Person>() |
| { |
| public boolean accept(Person person) |
| { |
| return person.person.getLastName().equals("Smith"); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../RichIterable.html#reject(org.eclipse.collections.api.block.predicate.Predicate)">reject</a></code> in interface <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>predicate</code> - a <a href="../block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate"><code>Predicate</code></a> to use as the reject criteria</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a RichIterable that contains elements that cause <a href="../block/predicate/Predicate.html#accept(T)"><code>Predicate.accept(Object)</code></a> method to evaluate to false</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="rejectWith(org.eclipse.collections.api.block.predicate.Predicate2,java.lang.Object)"> |
| <!-- --> |
| </a><a id="rejectWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">rejectWith</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P></span> <span class="returnType"><a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>></span> <span class="memberName">rejectWith</span>​(<span class="arguments"><a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? super P> predicate, |
| P parameter)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../RichIterable.html#rejectWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">RichIterable</a></code></span></div> |
| <div class="block">Similar to <a href="../RichIterable.html#reject(org.eclipse.collections.api.block.predicate.Predicate)"><code>RichIterable.reject(Predicate)</code></a>, except with an evaluation parameter for the second generic argument in <a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate"><code>Predicate2</code></a>. |
| <p> |
| E.g. return a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Collection</code></a> of Person elements where the person has an age <b>greater than or equal to</b> 18 years |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| RichIterable<Person> rejected = |
| people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18)); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| MutableList<Person> rejected = |
| people.rejectWith(new Predicate2<Person, Integer>() |
| { |
| public boolean accept(Person person, Integer age) |
| { |
| return person.getAge() < age; |
| } |
| }, Integer.valueOf(18)); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../RichIterable.html#rejectWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">rejectWith</a></code> in interface <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>predicate</code> - a <a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate"><code>Predicate2</code></a> to use as the select criteria</dd> |
| <dd><code>parameter</code> - a parameter to pass in for evaluation of the second argument <code>P</code> in <code>predicate</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../RichIterable.html#select(org.eclipse.collections.api.block.predicate.Predicate)"><code>RichIterable.select(Predicate)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="partition(org.eclipse.collections.api.block.predicate.Predicate)">partition</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../partition/set/PartitionUnsortedSet.html" title="interface in org.eclipse.collections.api.partition.set">PartitionUnsortedSet</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>></span> <span class="memberName">partition</span>​(<span class="arguments"><a href="../block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>> predicate)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../RichIterable.html#partition(org.eclipse.collections.api.block.predicate.Predicate)">RichIterable</a></code></span></div> |
| <div class="block">Filters a collection into a PartitionedIterable based on the evaluation of the predicate. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| PartitionIterable<Person> newYorkersAndNonNewYorkers = |
| people.<b>partition</b>(person -> person.getAddress().getState().getName().equals("New York")); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| PartitionIterable<Person> newYorkersAndNonNewYorkers = |
| people.<b>partition</b>(new Predicate<Person>() |
| { |
| public boolean accept(Person person) |
| { |
| return person.getAddress().getState().getName().equals("New York"); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../RichIterable.html#partition(org.eclipse.collections.api.block.predicate.Predicate)">partition</a></code> in interface <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="partitionWith(org.eclipse.collections.api.block.predicate.Predicate2,java.lang.Object)"> |
| <!-- --> |
| </a><a id="partitionWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">partitionWith</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P></span> <span class="returnType"><a href="../partition/set/PartitionUnsortedSet.html" title="interface in org.eclipse.collections.api.partition.set">PartitionUnsortedSet</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>></span> <span class="memberName">partitionWith</span>​(<span class="arguments"><a href="../block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? super P> predicate, |
| P parameter)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../RichIterable.html#partitionWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">RichIterable</a></code></span></div> |
| <div class="block">Filters a collection into a PartitionIterable based on the evaluation of the predicate. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| PartitionIterable<Person> newYorkersAndNonNewYorkers = |
| people.<b>partitionWith</b>((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York"); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| PartitionIterable<Person> newYorkersAndNonNewYorkers = |
| people.<b>partitionWith</b>(new Predicate2<Person, String>() |
| { |
| public boolean accept(Person person, String state) |
| { |
| return person.getAddress().getState().getName().equals(state); |
| } |
| }, "New York"); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../RichIterable.html#partitionWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">partitionWith</a></code> in interface <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="selectInstancesOf(java.lang.Class)">selectInstancesOf</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><S></span> <span class="returnType"><a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><S></span> <span class="memberName">selectInstancesOf</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><S> clazz)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../RichIterable.html#selectInstancesOf(java.lang.Class)">RichIterable</a></code></span></div> |
| <div class="block">Returns all elements of the source collection that are instances of the Class <code>clazz</code>. |
| |
| <pre> |
| RichIterable<Integer> integers = |
| List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../RichIterable.html#selectInstancesOf(java.lang.Class)">selectInstancesOf</a></code> in interface <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="zip(java.lang.Iterable)">zip</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="typeParameters"><S></span> <span class="returnType"><a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><<a href="../tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>,​S>></span> <span class="memberName">zip</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><S> that)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in 8.0. Use <a href="../ordered/OrderedIterable.html#zip(java.lang.Iterable)"><code>OrderedIterable.zip(Iterable)</code></a> instead.</div> |
| </div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../RichIterable.html#zip(java.lang.Iterable)">RichIterable</a></code></span></div> |
| <div class="block">Returns a <code>RichIterable</code> formed from this <code>RichIterable</code> and another <code>RichIterable</code> by |
| combining corresponding elements in pairs. If one of the two <code>RichIterable</code>s is longer than the other, its |
| remaining elements are ignored.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../RichIterable.html#zip(java.lang.Iterable)">zip</a></code> in interface <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>S</code> - the type of the second half of the returned pairs</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>that</code> - The <code>RichIterable</code> providing the second half of each result pair</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new <code>RichIterable</code> containing pairs consisting of corresponding elements of this <code> |
| RichIterable</code> and that. The length of the returned <code>RichIterable</code> is the minimum of the lengths of |
| this <code>RichIterable</code> and that.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="zipWithIndex()">zipWithIndex</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="returnType"><a href="../set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><<a href="../tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><<a href="BiMap.html" title="type parameter in BiMap">V</a>,​<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>>></span> <span class="memberName">zipWithIndex</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in 8.0. Use <a href="../ordered/OrderedIterable.html#zipWithIndex()"><code>OrderedIterable.zipWithIndex()</code></a> instead.</div> |
| </div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../RichIterable.html#zipWithIndex()">RichIterable</a></code></span></div> |
| <div class="block">Zips this <code>RichIterable</code> with its indices.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../RichIterable.html#zipWithIndex()">zipWithIndex</a></code> in interface <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new <code>RichIterable</code> containing pairs consisting of all elements of this <code>RichIterable</code> |
| paired with their index. Indices start at 0.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../RichIterable.html#zip(java.lang.Iterable)"><code>RichIterable.zip(Iterable)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="groupBy(org.eclipse.collections.api.block.function.Function)">groupBy</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V1></span> <span class="returnType"><a href="../multimap/set/SetMultimap.html" title="interface in org.eclipse.collections.api.multimap.set">SetMultimap</a><V1,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></span> <span class="memberName">groupBy</span>​(<span class="arguments"><a href="../block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? extends V1> function)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../RichIterable.html#groupBy(org.eclipse.collections.api.block.function.Function)">RichIterable</a></code></span></div> |
| <div class="block">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. |
| <p> |
| Example using a Java 8 method reference: |
| <pre> |
| Multimap<String, Person> peopleByLastName = |
| people.groupBy(Person::getLastName); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| Multimap<String, Person> peopleByLastName = |
| people.groupBy(new Function<Person, String>() |
| { |
| public String valueOf(Person person) |
| { |
| return person.getLastName(); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../RichIterable.html#groupBy(org.eclipse.collections.api.block.function.Function)">groupBy</a></code> in interface <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="groupByEach(org.eclipse.collections.api.block.function.Function)">groupByEach</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V1></span> <span class="returnType"><a href="../multimap/set/SetMultimap.html" title="interface in org.eclipse.collections.api.multimap.set">SetMultimap</a><V1,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></span> <span class="memberName">groupByEach</span>​(<span class="arguments"><a href="../block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><V1>> function)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../RichIterable.html#groupByEach(org.eclipse.collections.api.block.function.Function)">RichIterable</a></code></span></div> |
| <div class="block">Similar to <a href="../RichIterable.html#groupBy(org.eclipse.collections.api.block.function.Function)"><code>RichIterable.groupBy(Function)</code></a>, except the result of evaluating function will return a collection of keys |
| for each value.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../RichIterable.html#groupByEach(org.eclipse.collections.api.block.function.Function)">groupByEach</a></code> in interface <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="groupByUniqueKey(org.eclipse.collections.api.block.function.Function)">groupByUniqueKey</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><VV></span> <span class="returnType"><a href="BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><VV,​<a href="BiMap.html" title="type parameter in BiMap">V</a>></span> <span class="memberName">groupByUniqueKey</span>​(<span class="arguments"><a href="../block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="BiMap.html" title="type parameter in BiMap">V</a>,​? extends VV> function)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../RichIterable.html#groupByUniqueKey(org.eclipse.collections.api.block.function.Function)">RichIterable</a></code></span></div> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../RichIterable.html#groupByUniqueKey(org.eclipse.collections.api.block.function.Function)">groupByUniqueKey</a></code> in interface <code><a href="../RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="BiMap.html" title="type parameter in BiMap">K</a>></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../RichIterable.html#groupBy(org.eclipse.collections.api.block.function.Function)"><code>RichIterable.groupBy(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BiMap.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2020. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
