| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.2) on Sat Aug 08 22:45:01 CDT 2020 --> |
| <title>RichIterable (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, interface: RichIterable"> |
| <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":18,"i1":18,"i2":18,"i3":6,"i4":6,"i5":6,"i6":6,"i7":18,"i8":18,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":18,"i39":6,"i40":18,"i41":18,"i42":18,"i43":18,"i44":18,"i45":18,"i46":6,"i47":6,"i48":18,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":18,"i57":18,"i58":18,"i59":18,"i60":18,"i61":18,"i62":18,"i63":18,"i64":18,"i65":18,"i66":18,"i67":18,"i68":38,"i69":38,"i70":18,"i71":6,"i72":6,"i73":18,"i74":6,"i75":6,"i76":6,"i77":6,"i78":6,"i79":6,"i80":6,"i81":6,"i82":6,"i83":6,"i84":6,"i85":18,"i86":18,"i87":18,"i88":6,"i89":6,"i90":6,"i91":18,"i92":18,"i93":18,"i94":6,"i95":6,"i96":6,"i97":18,"i98":18,"i99":18,"i100":6,"i101":6,"i102":18,"i103":6,"i104":6,"i105":18,"i106":18,"i107":18,"i108":6,"i109":6,"i110":6,"i111":6,"i112":6,"i113":6,"i114":6,"i115":6,"i116":6,"i117":6,"i118":6,"i119":6,"i120":6,"i121":6,"i122":18,"i123":18,"i124":18,"i125":18,"i126":6,"i127":6,"i128":6,"i129":6,"i130":6,"i131":6,"i132":6,"i133":6,"i134":6,"i135":6,"i136":6,"i137":18,"i138":6,"i139":6,"i140":6,"i141":18,"i142":18,"i143":18,"i144":18,"i145":6,"i146":6,"i147":18,"i148":6,"i149":6,"i150":18,"i151":6,"i152":38,"i153":38,"i154":38,"i155":38}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/RichIterable.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</a></div> |
| <h1 title="Interface RichIterable" class="title">Interface RichIterable<T></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><T></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><T></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="bag/Bag.html" title="interface in org.eclipse.collections.api.bag">Bag</a><T></code>, <code><a href="bimap/BiMap.html" title="interface in org.eclipse.collections.api.bimap">BiMap</a><K,​V></code>, <code><a href="map/primitive/ByteObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">ByteObjectMap</a><V></code>, <code><a href="map/primitive/CharObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">CharObjectMap</a><V></code>, <code><a href="map/ConcurrentMutableMap.html" title="interface in org.eclipse.collections.api.map">ConcurrentMutableMap</a><K,​V></code>, <code><a href="map/primitive/DoubleObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">DoubleObjectMap</a><V></code>, <code><a href="collection/FixedSizeCollection.html" title="interface in org.eclipse.collections.api.collection">FixedSizeCollection</a><T></code>, <code><a href="list/FixedSizeList.html" title="interface in org.eclipse.collections.api.list">FixedSizeList</a><T></code>, <code><a href="map/FixedSizeMap.html" title="interface in org.eclipse.collections.api.map">FixedSizeMap</a><K,​V></code>, <code><a href="set/FixedSizeSet.html" title="interface in org.eclipse.collections.api.set">FixedSizeSet</a><T></code>, <code><a href="map/primitive/FloatObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">FloatObjectMap</a><V></code>, <code><a href="bag/ImmutableBag.html" title="interface in org.eclipse.collections.api.bag">ImmutableBag</a><T></code>, <code><a href="bag/ImmutableBagIterable.html" title="interface in org.eclipse.collections.api.bag">ImmutableBagIterable</a><T></code>, <code><a href="bimap/ImmutableBiMap.html" title="interface in org.eclipse.collections.api.bimap">ImmutableBiMap</a><K,​V></code>, <code><a href="map/primitive/ImmutableByteObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">ImmutableByteObjectMap</a><V></code>, <code><a href="map/primitive/ImmutableCharObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">ImmutableCharObjectMap</a><V></code>, <code><a href="collection/ImmutableCollection.html" title="interface in org.eclipse.collections.api.collection">ImmutableCollection</a><T></code>, <code><a href="map/primitive/ImmutableDoubleObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">ImmutableDoubleObjectMap</a><V></code>, <code><a href="map/primitive/ImmutableFloatObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">ImmutableFloatObjectMap</a><V></code>, <code><a href="map/primitive/ImmutableIntObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">ImmutableIntObjectMap</a><V></code>, <code><a href="list/ImmutableList.html" title="interface in org.eclipse.collections.api.list">ImmutableList</a><T></code>, <code><a href="map/primitive/ImmutableLongObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">ImmutableLongObjectMap</a><V></code>, <code><a href="map/ImmutableMap.html" title="interface in org.eclipse.collections.api.map">ImmutableMap</a><K,​V></code>, <code><a href="map/ImmutableMapIterable.html" title="interface in org.eclipse.collections.api.map">ImmutableMapIterable</a><K,​V></code>, <code><a href="map/ImmutableOrderedMap.html" title="interface in org.eclipse.collections.api.map">ImmutableOrderedMap</a><K,​V></code>, <code><a href="map/primitive/ImmutablePrimitiveObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">ImmutablePrimitiveObjectMap</a><V></code>, <code><a href="set/ImmutableSet.html" title="interface in org.eclipse.collections.api.set">ImmutableSet</a><T></code>, <code><a href="set/ImmutableSetIterable.html" title="interface in org.eclipse.collections.api.set">ImmutableSetIterable</a><T></code>, <code><a href="map/primitive/ImmutableShortObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">ImmutableShortObjectMap</a><V></code>, <code><a href="bag/sorted/ImmutableSortedBag.html" title="interface in org.eclipse.collections.api.bag.sorted">ImmutableSortedBag</a><T></code>, <code><a href="map/sorted/ImmutableSortedMap.html" title="interface in org.eclipse.collections.api.map.sorted">ImmutableSortedMap</a><K,​V></code>, <code><a href="set/sorted/ImmutableSortedSet.html" title="interface in org.eclipse.collections.api.set.sorted">ImmutableSortedSet</a><T></code>, <code><a href="stack/ImmutableStack.html" title="interface in org.eclipse.collections.api.stack">ImmutableStack</a><T></code>, <code><a href="map/primitive/IntObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">IntObjectMap</a><V></code>, <code><a href="LazyIterable.html" title="interface in org.eclipse.collections.api">LazyIterable</a><T></code>, <code><a href="list/ListIterable.html" title="interface in org.eclipse.collections.api.list">ListIterable</a><T></code>, <code><a href="map/primitive/LongObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">LongObjectMap</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="bag/MultiReaderBag.html" title="interface in org.eclipse.collections.api.bag">MultiReaderBag</a><T></code>, <code><a href="list/MultiReaderList.html" title="interface in org.eclipse.collections.api.list">MultiReaderList</a><T></code>, <code><a href="set/MultiReaderSet.html" title="interface in org.eclipse.collections.api.set">MultiReaderSet</a><T></code>, <code><a href="bag/MutableBag.html" title="interface in org.eclipse.collections.api.bag">MutableBag</a><T></code>, <code><a href="bag/MutableBagIterable.html" title="interface in org.eclipse.collections.api.bag">MutableBagIterable</a><T></code>, <code><a href="bimap/MutableBiMap.html" title="interface in org.eclipse.collections.api.bimap">MutableBiMap</a><K,​V></code>, <code><a href="map/primitive/MutableByteObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">MutableByteObjectMap</a><V></code>, <code><a href="map/primitive/MutableCharObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">MutableCharObjectMap</a><V></code>, <code><a href="collection/MutableCollection.html" title="interface in org.eclipse.collections.api.collection">MutableCollection</a><T></code>, <code><a href="map/primitive/MutableDoubleObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">MutableDoubleObjectMap</a><V></code>, <code><a href="map/primitive/MutableFloatObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">MutableFloatObjectMap</a><V></code>, <code><a href="map/primitive/MutableIntObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">MutableIntObjectMap</a><V></code>, <code><a href="list/MutableList.html" title="interface in org.eclipse.collections.api.list">MutableList</a><T></code>, <code><a href="map/primitive/MutableLongObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">MutableLongObjectMap</a><V></code>, <code><a href="map/MutableMap.html" title="interface in org.eclipse.collections.api.map">MutableMap</a><K,​V></code>, <code><a href="map/MutableMapIterable.html" title="interface in org.eclipse.collections.api.map">MutableMapIterable</a><K,​V></code>, <code><a href="map/MutableOrderedMap.html" title="interface in org.eclipse.collections.api.map">MutableOrderedMap</a><K,​V></code>, <code><a href="map/primitive/MutablePrimitiveObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">MutablePrimitiveObjectMap</a><V></code>, <code><a href="set/MutableSet.html" title="interface in org.eclipse.collections.api.set">MutableSet</a><T></code>, <code><a href="set/MutableSetIterable.html" title="interface in org.eclipse.collections.api.set">MutableSetIterable</a><T></code>, <code><a href="map/primitive/MutableShortObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">MutableShortObjectMap</a><V></code>, <code><a href="bag/sorted/MutableSortedBag.html" title="interface in org.eclipse.collections.api.bag.sorted">MutableSortedBag</a><T></code>, <code><a href="map/sorted/MutableSortedMap.html" title="interface in org.eclipse.collections.api.map.sorted">MutableSortedMap</a><K,​V></code>, <code><a href="set/sorted/MutableSortedSet.html" title="interface in org.eclipse.collections.api.set.sorted">MutableSortedSet</a><T></code>, <code><a href="stack/MutableStack.html" title="interface in org.eclipse.collections.api.stack">MutableStack</a><T></code>, <code><a href="ordered/OrderedIterable.html" title="interface in org.eclipse.collections.api.ordered">OrderedIterable</a><T></code>, <code><a href="map/OrderedMap.html" title="interface in org.eclipse.collections.api.map">OrderedMap</a><K,​V></code>, <code><a href="map/primitive/PrimitiveObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">PrimitiveObjectMap</a><V></code>, <code><a href="ordered/ReversibleIterable.html" title="interface in org.eclipse.collections.api.ordered">ReversibleIterable</a><T></code>, <code><a href="set/SetIterable.html" title="interface in org.eclipse.collections.api.set">SetIterable</a><T></code>, <code><a href="map/primitive/ShortObjectMap.html" title="interface in org.eclipse.collections.api.map.primitive">ShortObjectMap</a><V></code>, <code><a href="bag/sorted/SortedBag.html" title="interface in org.eclipse.collections.api.bag.sorted">SortedBag</a><T></code>, <code><a href="ordered/SortedIterable.html" title="interface in org.eclipse.collections.api.ordered">SortedIterable</a><T></code>, <code><a href="map/sorted/SortedMapIterable.html" title="interface in org.eclipse.collections.api.map.sorted">SortedMapIterable</a><K,​V></code>, <code><a href="set/sorted/SortedSetIterable.html" title="interface in org.eclipse.collections.api.set.sorted">SortedSetIterable</a><T></code>, <code><a href="stack/StackIterable.html" title="interface in org.eclipse.collections.api.stack">StackIterable</a><T></code>, <code><a href="bag/UnsortedBag.html" title="interface in org.eclipse.collections.api.bag">UnsortedBag</a><T></code>, <code><a href="map/UnsortedMapIterable.html" title="interface in org.eclipse.collections.api.map">UnsortedMapIterable</a><K,​V></code>, <code><a href="set/UnsortedSetIterable.html" title="interface in org.eclipse.collections.api.set">UnsortedSetIterable</a><T></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../impl/list/fixed/AbstractArrayAdapter.html" title="class in org.eclipse.collections.impl.list.fixed">AbstractArrayAdapter</a></code>, <code><a href="../impl/bag/AbstractBag.html" title="class in org.eclipse.collections.impl.bag">AbstractBag</a></code>, <code><a href="../impl/bimap/AbstractBiMap.html" title="class in org.eclipse.collections.impl.bimap">AbstractBiMap</a></code>, <code><a href="../impl/collection/mutable/AbstractCollectionAdapter.html" title="class in org.eclipse.collections.impl.collection.mutable">AbstractCollectionAdapter</a></code>, <code><a href="../impl/bag/mutable/AbstractHashBag.html" title="class in org.eclipse.collections.impl.bag.mutable">AbstractHashBag</a></code>, <code><a href="../impl/bag/immutable/AbstractImmutableBag.html" title="class in org.eclipse.collections.impl.bag.immutable">AbstractImmutableBag</a></code>, <code><a href="../impl/bag/immutable/AbstractImmutableBagIterable.html" title="class in org.eclipse.collections.impl.bag.immutable">AbstractImmutableBagIterable</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/map/immutable/primitive/AbstractImmutableByteObjectMap.html" title="class in org.eclipse.collections.impl.map.immutable.primitive">AbstractImmutableByteObjectMap</a></code>, <code><a href="../impl/map/immutable/primitive/AbstractImmutableCharObjectMap.html" title="class in org.eclipse.collections.impl.map.immutable.primitive">AbstractImmutableCharObjectMap</a></code>, <code><a href="../impl/collection/immutable/AbstractImmutableCollection.html" title="class in org.eclipse.collections.impl.collection.immutable">AbstractImmutableCollection</a></code>, <code><a href="../impl/map/immutable/primitive/AbstractImmutableDoubleObjectMap.html" title="class in org.eclipse.collections.impl.map.immutable.primitive">AbstractImmutableDoubleObjectMap</a></code>, <code><a href="../impl/map/immutable/primitive/AbstractImmutableFloatObjectMap.html" title="class in org.eclipse.collections.impl.map.immutable.primitive">AbstractImmutableFloatObjectMap</a></code>, <code><a href="../impl/map/immutable/primitive/AbstractImmutableIntObjectMap.html" title="class in org.eclipse.collections.impl.map.immutable.primitive">AbstractImmutableIntObjectMap</a></code>, <code><a href="../impl/map/immutable/primitive/AbstractImmutableLongObjectMap.html" title="class in org.eclipse.collections.impl.map.immutable.primitive">AbstractImmutableLongObjectMap</a></code>, <code><a href="../impl/map/immutable/AbstractImmutableMap.html" title="class in org.eclipse.collections.impl.map.immutable">AbstractImmutableMap</a></code>, <code><a href="../impl/set/immutable/AbstractImmutableSet.html" title="class in org.eclipse.collections.impl.set.immutable">AbstractImmutableSet</a></code>, <code><a href="../impl/map/immutable/primitive/AbstractImmutableShortObjectMap.html" title="class in org.eclipse.collections.impl.map.immutable.primitive">AbstractImmutableShortObjectMap</a></code>, <code><a href="../impl/map/sorted/immutable/AbstractImmutableSortedMap.html" title="class in org.eclipse.collections.impl.map.sorted.immutable">AbstractImmutableSortedMap</a></code>, <code><a href="../impl/lazy/AbstractLazyIterable.html" title="class in org.eclipse.collections.impl.lazy">AbstractLazyIterable</a></code>, <code><a href="../impl/list/mutable/AbstractListAdapter.html" title="class in org.eclipse.collections.impl.list.mutable">AbstractListAdapter</a></code>, <code><a href="../impl/map/AbstractMapIterable.html" title="class in org.eclipse.collections.impl.map">AbstractMapIterable</a></code>, <code><a href="../impl/list/fixed/AbstractMemoryEfficientMutableList.html" title="class in org.eclipse.collections.impl.list.fixed">AbstractMemoryEfficientMutableList</a></code>, <code><a href="../impl/collection/mutable/AbstractMultiReaderMutableCollection.html" title="class in org.eclipse.collections.impl.collection.mutable">AbstractMultiReaderMutableCollection</a></code>, <code><a href="../impl/bag/mutable/AbstractMutableBag.html" title="class in org.eclipse.collections.impl.bag.mutable">AbstractMutableBag</a></code>, <code><a href="../impl/bag/mutable/AbstractMutableBagIterable.html" title="class in org.eclipse.collections.impl.bag.mutable">AbstractMutableBagIterable</a></code>, <code><a href="../impl/collection/mutable/AbstractMutableCollection.html" title="class in org.eclipse.collections.impl.collection.mutable">AbstractMutableCollection</a></code>, <code><a href="../impl/list/mutable/AbstractMutableList.html" title="class in org.eclipse.collections.impl.list.mutable">AbstractMutableList</a></code>, <code><a href="../impl/map/mutable/AbstractMutableMap.html" title="class in org.eclipse.collections.impl.map.mutable">AbstractMutableMap</a></code>, <code><a href="../impl/map/mutable/AbstractMutableMapIterable.html" title="class in org.eclipse.collections.impl.map.mutable">AbstractMutableMapIterable</a></code>, <code><a href="../impl/set/mutable/AbstractMutableSet.html" title="class in org.eclipse.collections.impl.set.mutable">AbstractMutableSet</a></code>, <code><a href="../impl/bag/sorted/mutable/AbstractMutableSortedBag.html" title="class in org.eclipse.collections.impl.bag.sorted.mutable">AbstractMutableSortedBag</a></code>, <code><a href="../impl/map/sorted/mutable/AbstractMutableSortedMap.html" title="class in org.eclipse.collections.impl.map.sorted.mutable">AbstractMutableSortedMap</a></code>, <code><a href="../impl/AbstractRichIterable.html" title="class in org.eclipse.collections.impl">AbstractRichIterable</a></code>, <code><a href="../impl/map/AbstractSynchronizedMapIterable.html" title="class in org.eclipse.collections.impl.map">AbstractSynchronizedMapIterable</a></code>, <code><a href="../impl/collection/mutable/AbstractSynchronizedMutableCollection.html" title="class in org.eclipse.collections.impl.collection.mutable">AbstractSynchronizedMutableCollection</a></code>, <code><a href="../impl/collection/AbstractSynchronizedRichIterable.html" title="class in org.eclipse.collections.impl.collection">AbstractSynchronizedRichIterable</a></code>, <code><a href="../impl/set/AbstractUnifiedSet.html" title="class in org.eclipse.collections.impl.set">AbstractUnifiedSet</a></code>, <code><a href="../impl/collection/mutable/AbstractUnmodifiableMutableCollection.html" title="class in org.eclipse.collections.impl.collection.mutable">AbstractUnmodifiableMutableCollection</a></code>, <code><a href="../impl/list/fixed/ArrayAdapter.html" title="class in org.eclipse.collections.impl.list.fixed">ArrayAdapter</a></code>, <code><a href="../impl/list/mutable/ArrayListAdapter.html" title="class in org.eclipse.collections.impl.list.mutable">ArrayListAdapter</a></code>, <code><a href="../impl/stack/mutable/ArrayStack.html" title="class in org.eclipse.collections.impl.stack.mutable">ArrayStack</a></code>, <code><a href="../impl/map/mutable/primitive/ByteObjectHashMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">ByteObjectHashMap</a></code>, <code><a href="../impl/map/mutable/primitive/CharObjectHashMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">CharObjectHashMap</a></code>, <code><a href="../impl/lazy/primitive/ChunkBooleanIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">ChunkBooleanIterable</a></code>, <code><a href="../impl/lazy/primitive/ChunkByteIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">ChunkByteIterable</a></code>, <code><a href="../impl/lazy/primitive/ChunkCharIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">ChunkCharIterable</a></code>, <code><a href="../impl/lazy/primitive/ChunkDoubleIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">ChunkDoubleIterable</a></code>, <code><a href="../impl/lazy/primitive/ChunkFloatIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">ChunkFloatIterable</a></code>, <code><a href="../impl/lazy/primitive/ChunkIntIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">ChunkIntIterable</a></code>, <code><a href="../impl/lazy/ChunkIterable.html" title="class in org.eclipse.collections.impl.lazy">ChunkIterable</a></code>, <code><a href="../impl/lazy/primitive/ChunkLongIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">ChunkLongIterable</a></code>, <code><a href="../impl/lazy/primitive/ChunkShortIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">ChunkShortIterable</a></code>, <code><a href="../impl/lazy/primitive/CollectBooleanToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">CollectBooleanToObjectIterable</a></code>, <code><a href="../impl/lazy/primitive/CollectByteToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">CollectByteToObjectIterable</a></code>, <code><a href="../impl/lazy/primitive/CollectCharToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">CollectCharToObjectIterable</a></code>, <code><a href="../impl/lazy/primitive/CollectDoubleToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">CollectDoubleToObjectIterable</a></code>, <code><a href="../impl/lazy/primitive/CollectFloatToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">CollectFloatToObjectIterable</a></code>, <code><a href="../impl/lazy/primitive/CollectIntToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">CollectIntToObjectIterable</a></code>, <code><a href="../impl/collection/mutable/CollectionAdapter.html" title="class in org.eclipse.collections.impl.collection.mutable">CollectionAdapter</a></code>, <code><a href="../impl/lazy/CollectIterable.html" title="class in org.eclipse.collections.impl.lazy">CollectIterable</a></code>, <code><a href="../impl/lazy/primitive/CollectLongToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">CollectLongToObjectIterable</a></code>, <code><a href="../impl/lazy/primitive/CollectShortToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">CollectShortToObjectIterable</a></code>, <code><a href="../impl/list/mutable/CompositeFastList.html" title="class in org.eclipse.collections.impl.list.mutable">CompositeFastList</a></code>, <code><a href="../impl/lazy/CompositeIterable.html" title="class in org.eclipse.collections.impl.lazy">CompositeIterable</a></code>, <code><a href="../impl/map/mutable/ConcurrentHashMap.html" title="class in org.eclipse.collections.impl.map.mutable">ConcurrentHashMap</a></code>, <code><a href="../impl/map/mutable/ConcurrentHashMapUnsafe.html" title="class in org.eclipse.collections.impl.map.mutable">ConcurrentHashMapUnsafe</a></code>, <code><a href="../impl/map/mutable/ConcurrentMutableHashMap.html" title="class in org.eclipse.collections.impl.map.mutable">ConcurrentMutableHashMap</a></code>, <code><a href="../impl/lazy/DistinctIterable.html" title="class in org.eclipse.collections.impl.lazy">DistinctIterable</a></code>, <code><a href="../impl/map/mutable/primitive/DoubleObjectHashMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">DoubleObjectHashMap</a></code>, <code><a href="../impl/lazy/DropIterable.html" title="class in org.eclipse.collections.impl.lazy">DropIterable</a></code>, <code><a href="../impl/lazy/DropWhileIterable.html" title="class in org.eclipse.collections.impl.lazy">DropWhileIterable</a></code>, <code><a href="../impl/list/mutable/FastList.html" title="class in org.eclipse.collections.impl.list.mutable">FastList</a></code>, <code><a href="../impl/lazy/primitive/FlatCollectBooleanToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">FlatCollectBooleanToObjectIterable</a></code>, <code><a href="../impl/lazy/primitive/FlatCollectByteToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">FlatCollectByteToObjectIterable</a></code>, <code><a href="../impl/lazy/primitive/FlatCollectCharToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">FlatCollectCharToObjectIterable</a></code>, <code><a href="../impl/lazy/primitive/FlatCollectDoubleToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">FlatCollectDoubleToObjectIterable</a></code>, <code><a href="../impl/lazy/primitive/FlatCollectFloatToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">FlatCollectFloatToObjectIterable</a></code>, <code><a href="../impl/lazy/primitive/FlatCollectIntToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">FlatCollectIntToObjectIterable</a></code>, <code><a href="../impl/lazy/FlatCollectIterable.html" title="class in org.eclipse.collections.impl.lazy">FlatCollectIterable</a></code>, <code><a href="../impl/lazy/primitive/FlatCollectLongToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">FlatCollectLongToObjectIterable</a></code>, <code><a href="../impl/lazy/primitive/FlatCollectShortToObjectIterable.html" title="class in org.eclipse.collections.impl.lazy.primitive">FlatCollectShortToObjectIterable</a></code>, <code><a href="../impl/map/mutable/primitive/FloatObjectHashMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">FloatObjectHashMap</a></code>, <code><a href="../impl/bag/mutable/HashBag.html" title="class in org.eclipse.collections.impl.bag.mutable">HashBag</a></code>, <code><a href="../impl/bag/strategy/mutable/HashBagWithHashingStrategy.html" title="class in org.eclipse.collections.impl.bag.strategy.mutable">HashBagWithHashingStrategy</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/bag/immutable/ImmutableArrayBag.html" title="class in org.eclipse.collections.impl.bag.immutable">ImmutableArrayBag</a></code>, <code><a href="../impl/bag/immutable/ImmutableHashBag.html" title="class in org.eclipse.collections.impl.bag.immutable">ImmutableHashBag</a></code>, <code><a href="../impl/map/sorted/immutable/ImmutableTreeMap.html" title="class in org.eclipse.collections.impl.map.sorted.immutable">ImmutableTreeMap</a></code>, <code><a href="../impl/map/immutable/ImmutableUnifiedMap.html" title="class in org.eclipse.collections.impl.map.immutable">ImmutableUnifiedMap</a></code>, <code><a href="../impl/map/strategy/immutable/ImmutableUnifiedMapWithHashingStrategy.html" title="class in org.eclipse.collections.impl.map.strategy.immutable">ImmutableUnifiedMapWithHashingStrategy</a></code>, <code><a href="../impl/list/Interval.html" title="class in org.eclipse.collections.impl.list">Interval</a></code>, <code><a href="../impl/map/mutable/primitive/IntObjectHashMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">IntObjectHashMap</a></code>, <code><a href="../impl/lazy/LazyIterableAdapter.html" title="class in org.eclipse.collections.impl.lazy">LazyIterableAdapter</a></code>, <code><a href="../impl/list/mutable/ListAdapter.html" title="class in org.eclipse.collections.impl.list.mutable">ListAdapter</a></code>, <code><a href="../impl/map/mutable/primitive/LongObjectHashMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">LongObjectHashMap</a></code>, <code><a href="../impl/map/mutable/MapAdapter.html" title="class in org.eclipse.collections.impl.map.mutable">MapAdapter</a></code>, <code><a href="../impl/list/mutable/MultiReaderFastList.html" title="class in org.eclipse.collections.impl.list.mutable">MultiReaderFastList</a></code>, <code><a href="../impl/bag/mutable/MultiReaderHashBag.html" title="class in org.eclipse.collections.impl.bag.mutable">MultiReaderHashBag</a></code>, <code><a href="../impl/set/mutable/MultiReaderUnifiedSet.html" title="class in org.eclipse.collections.impl.set.mutable">MultiReaderUnifiedSet</a></code>, <code><a href="../impl/map/ordered/mutable/OrderedMapAdapter.html" title="class in org.eclipse.collections.impl.map.ordered.mutable">OrderedMapAdapter</a></code>, <code><a href="../impl/list/mutable/RandomAccessListAdapter.html" title="class in org.eclipse.collections.impl.list.mutable">RandomAccessListAdapter</a></code>, <code><a href="../impl/lazy/RejectIterable.html" title="class in org.eclipse.collections.impl.lazy">RejectIterable</a></code>, <code><a href="../impl/lazy/ReverseIterable.html" title="class in org.eclipse.collections.impl.lazy">ReverseIterable</a></code>, <code><a href="../impl/lazy/SelectInstancesOfIterable.html" title="class in org.eclipse.collections.impl.lazy">SelectInstancesOfIterable</a></code>, <code><a href="../impl/lazy/SelectIterable.html" title="class in org.eclipse.collections.impl.lazy">SelectIterable</a></code>, <code><a href="../impl/set/mutable/SetAdapter.html" title="class in org.eclipse.collections.impl.set.mutable">SetAdapter</a></code>, <code><a href="../impl/map/mutable/primitive/ShortObjectHashMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">ShortObjectHashMap</a></code>, <code><a href="../impl/map/sorted/mutable/SortedMapAdapter.html" title="class in org.eclipse.collections.impl.map.sorted.mutable">SortedMapAdapter</a></code>, <code><a href="../impl/set/sorted/mutable/SortedSetAdapter.html" title="class in org.eclipse.collections.impl.set.sorted.mutable">SortedSetAdapter</a></code>, <code><a href="../impl/bag/mutable/SynchronizedBag.html" title="class in org.eclipse.collections.impl.bag.mutable">SynchronizedBag</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/map/mutable/primitive/SynchronizedByteObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">SynchronizedByteObjectMap</a></code>, <code><a href="../impl/map/mutable/primitive/SynchronizedCharObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">SynchronizedCharObjectMap</a></code>, <code><a href="../impl/map/mutable/primitive/SynchronizedDoubleObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">SynchronizedDoubleObjectMap</a></code>, <code><a href="../impl/map/mutable/primitive/SynchronizedFloatObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">SynchronizedFloatObjectMap</a></code>, <code><a href="../impl/map/mutable/primitive/SynchronizedIntObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">SynchronizedIntObjectMap</a></code>, <code><a href="../impl/map/mutable/primitive/SynchronizedLongObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">SynchronizedLongObjectMap</a></code>, <code><a href="../impl/collection/mutable/SynchronizedMutableCollection.html" title="class in org.eclipse.collections.impl.collection.mutable">SynchronizedMutableCollection</a></code>, <code><a href="../impl/list/mutable/SynchronizedMutableList.html" title="class in org.eclipse.collections.impl.list.mutable">SynchronizedMutableList</a></code>, <code><a href="../impl/map/mutable/SynchronizedMutableMap.html" title="class in org.eclipse.collections.impl.map.mutable">SynchronizedMutableMap</a></code>, <code><a href="../impl/set/mutable/SynchronizedMutableSet.html" title="class in org.eclipse.collections.impl.set.mutable">SynchronizedMutableSet</a></code>, <code><a href="../impl/SynchronizedRichIterable.html" title="class in org.eclipse.collections.impl">SynchronizedRichIterable</a></code>, <code><a href="../impl/map/mutable/primitive/SynchronizedShortObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">SynchronizedShortObjectMap</a></code>, <code><a href="../impl/bag/sorted/mutable/SynchronizedSortedBag.html" title="class in org.eclipse.collections.impl.bag.sorted.mutable">SynchronizedSortedBag</a></code>, <code><a href="../impl/map/sorted/mutable/SynchronizedSortedMap.html" title="class in org.eclipse.collections.impl.map.sorted.mutable">SynchronizedSortedMap</a></code>, <code><a href="../impl/set/sorted/mutable/SynchronizedSortedSet.html" title="class in org.eclipse.collections.impl.set.sorted.mutable">SynchronizedSortedSet</a></code>, <code><a href="../impl/stack/mutable/SynchronizedStack.html" title="class in org.eclipse.collections.impl.stack.mutable">SynchronizedStack</a></code>, <code><a href="../impl/lazy/TakeIterable.html" title="class in org.eclipse.collections.impl.lazy">TakeIterable</a></code>, <code><a href="../impl/lazy/TakeWhileIterable.html" title="class in org.eclipse.collections.impl.lazy">TakeWhileIterable</a></code>, <code><a href="../impl/lazy/TapIterable.html" title="class in org.eclipse.collections.impl.lazy">TapIterable</a></code>, <code><a href="../impl/bag/sorted/mutable/TreeBag.html" title="class in org.eclipse.collections.impl.bag.sorted.mutable">TreeBag</a></code>, <code><a href="../impl/map/sorted/mutable/TreeSortedMap.html" title="class in org.eclipse.collections.impl.map.sorted.mutable">TreeSortedMap</a></code>, <code><a href="../impl/set/sorted/mutable/TreeSortedSet.html" title="class in org.eclipse.collections.impl.set.sorted.mutable">TreeSortedSet</a></code>, <code><a href="../impl/map/mutable/UnifiedMap.html" title="class in org.eclipse.collections.impl.map.mutable">UnifiedMap</a></code>, <code><a href="../impl/map/strategy/mutable/UnifiedMapWithHashingStrategy.html" title="class in org.eclipse.collections.impl.map.strategy.mutable">UnifiedMapWithHashingStrategy</a></code>, <code><a href="../impl/set/mutable/UnifiedSet.html" title="class in org.eclipse.collections.impl.set.mutable">UnifiedSet</a></code>, <code><a href="../impl/set/strategy/mutable/UnifiedSetWithHashingStrategy.html" title="class in org.eclipse.collections.impl.set.strategy.mutable">UnifiedSetWithHashingStrategy</a></code>, <code><a href="../impl/bag/mutable/UnmodifiableBag.html" title="class in org.eclipse.collections.impl.bag.mutable">UnmodifiableBag</a></code>, <code><a href="../impl/bimap/mutable/UnmodifiableBiMap.html" title="class in org.eclipse.collections.impl.bimap.mutable">UnmodifiableBiMap</a></code>, <code><a href="../impl/map/mutable/primitive/UnmodifiableByteObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">UnmodifiableByteObjectMap</a></code>, <code><a href="../impl/map/mutable/primitive/UnmodifiableCharObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">UnmodifiableCharObjectMap</a></code>, <code><a href="../impl/map/mutable/primitive/UnmodifiableDoubleObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">UnmodifiableDoubleObjectMap</a></code>, <code><a href="../impl/map/mutable/primitive/UnmodifiableFloatObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">UnmodifiableFloatObjectMap</a></code>, <code><a href="../impl/map/mutable/primitive/UnmodifiableIntObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">UnmodifiableIntObjectMap</a></code>, <code><a href="../impl/map/mutable/primitive/UnmodifiableLongObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">UnmodifiableLongObjectMap</a></code>, <code><a href="../impl/collection/mutable/UnmodifiableMutableCollection.html" title="class in org.eclipse.collections.impl.collection.mutable">UnmodifiableMutableCollection</a></code>, <code><a href="../impl/list/mutable/UnmodifiableMutableList.html" title="class in org.eclipse.collections.impl.list.mutable">UnmodifiableMutableList</a></code>, <code><a href="../impl/map/mutable/UnmodifiableMutableMap.html" title="class in org.eclipse.collections.impl.map.mutable">UnmodifiableMutableMap</a></code>, <code><a href="../impl/map/ordered/mutable/UnmodifiableMutableOrderedMap.html" title="class in org.eclipse.collections.impl.map.ordered.mutable">UnmodifiableMutableOrderedMap</a></code>, <code><a href="../impl/set/mutable/UnmodifiableMutableSet.html" title="class in org.eclipse.collections.impl.set.mutable">UnmodifiableMutableSet</a></code>, <code><a href="../impl/UnmodifiableRichIterable.html" title="class in org.eclipse.collections.impl">UnmodifiableRichIterable</a></code>, <code><a href="../impl/map/mutable/primitive/UnmodifiableShortObjectMap.html" title="class in org.eclipse.collections.impl.map.mutable.primitive">UnmodifiableShortObjectMap</a></code>, <code><a href="../impl/bag/sorted/mutable/UnmodifiableSortedBag.html" title="class in org.eclipse.collections.impl.bag.sorted.mutable">UnmodifiableSortedBag</a></code>, <code><a href="../impl/set/sorted/mutable/UnmodifiableSortedSet.html" title="class in org.eclipse.collections.impl.set.sorted.mutable">UnmodifiableSortedSet</a></code>, <code><a href="../impl/stack/mutable/UnmodifiableStack.html" title="class in org.eclipse.collections.impl.stack.mutable">UnmodifiableStack</a></code>, <code><a href="../impl/map/sorted/mutable/UnmodifiableTreeMap.html" title="class in org.eclipse.collections.impl.map.sorted.mutable">UnmodifiableTreeMap</a></code>, <code><a href="../impl/lazy/ZipIterable.html" title="class in org.eclipse.collections.impl.lazy">ZipIterable</a></code>, <code><a href="../impl/lazy/ZipWithIndexIterable.html" title="class in org.eclipse.collections.impl.lazy">ZipWithIndexIterable</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">RichIterable<T></span> |
| extends <a href="InternalIterable.html" title="interface in org.eclipse.collections.api">InternalIterable</a><T></pre> |
| <div class="block">RichIterable is an interface which extends the InternalIterable interface with several internal iterator methods, from |
| the Smalltalk Collection protocol. These include select, reject, detect, collect, injectInto, anySatisfy, |
| allSatisfy. The API also includes converter methods to convert a RichIterable to a List (toList), to a sorted |
| List (toSortedList), to a Set (toSet), and to a Map (toMap).</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</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="t5" class="tableTab" onclick="show(16);">Default 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>default <K,​ |
| V> <a href="map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><K,​V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#aggregateBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function0,org.eclipse.collections.api.block.function.Function2)">aggregateBy</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends K> groupBy, |
| <a href="block/function/Function0.html" title="interface in org.eclipse.collections.api.block.function">Function0</a><? extends V> zeroValueFactory, |
| <a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super V,​? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> nonMutatingAggregator)</code></th> |
| <td class="colLast"> |
| <div class="block">Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>default <K,​ |
| V,​ |
| R extends <a href="map/MutableMapIterable.html" title="interface in org.eclipse.collections.api.map">MutableMapIterable</a><K,​ |
| V>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#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></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends K> groupBy, |
| <a href="block/function/Function0.html" title="interface in org.eclipse.collections.api.block.function">Function0</a><? extends V> zeroValueFactory, |
| <a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super V,​? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> nonMutatingAggregator, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Applies an aggregate function over the iterable grouping results into the target map based on the specific |
| groupBy function.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>default <K,​ |
| V> <a href="map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><K,​V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#aggregateInPlaceBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function0,org.eclipse.collections.api.block.procedure.Procedure2)">aggregateInPlaceBy</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends K> groupBy, |
| <a href="block/function/Function0.html" title="interface in org.eclipse.collections.api.block.function">Function0</a><? extends V> zeroValueFactory, |
| <a href="block/procedure/Procedure2.html" title="interface in org.eclipse.collections.api.block.procedure">Procedure2</a><? super V,​? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> mutatingAggregator)</code></th> |
| <td class="colLast"> |
| <div class="block">Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allSatisfy(org.eclipse.collections.api.block.predicate.Predicate)">allSatisfy</a></span>​(<a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code><P> boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allSatisfyWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">allSatisfyWith</a></span>​(<a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if the predicate evaluates to true for every element of the collection, or returns false.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#anySatisfy(org.eclipse.collections.api.block.predicate.Predicate)">anySatisfy</a></span>​(<a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if the predicate evaluates to true for any element of the iterable.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code><P> boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#anySatisfyWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">anySatisfyWith</a></span>​(<a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if the predicate evaluates to true for any element of the collection, or return false.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#appendString(java.lang.Appendable)">appendString</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a> appendable)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints a string representation of this collection onto the given <code>Appendable</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#appendString(java.lang.Appendable,java.lang.String)">appendString</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a> appendable, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> separator)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints a string representation of this collection onto the given <code>Appendable</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#appendString(java.lang.Appendable,java.lang.String,java.lang.String,java.lang.String)">appendString</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a> appendable, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> start, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> separator, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> end)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints a string representation of this collection onto the given <code>Appendable</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code><a href="LazyIterable.html" title="interface in org.eclipse.collections.api">LazyIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asLazy()">asLazy</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code><a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#chunk(int)">chunk</a></span>​(int size)</code></th> |
| <td class="colLast"> |
| <div class="block">Partitions elements in fixed size chunks.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code><V> <a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collect(org.eclipse.collections.api.block.function.Function)">collect</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new collection with the results of applying the specified function on each element of the source |
| collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code><V,​ |
| R extends <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">Collection</a><V>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collect(org.eclipse.collections.api.block.function.Function,R)">collect</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#collect(org.eclipse.collections.api.block.function.Function)"><code>collect(Function)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code><a href="BooleanIterable.html" title="interface in org.eclipse.collections.api">BooleanIterable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectBoolean(org.eclipse.collections.api.block.function.primitive.BooleanFunction)">collectBoolean</a></span>​(<a href="block/function/primitive/BooleanFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">BooleanFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> booleanFunction)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new primitive <code>boolean</code> iterable with the results of applying the specified function on each element |
| of the source collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <td class="colFirst"><code><R extends <a href="collection/primitive/MutableBooleanCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableBooleanCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectBoolean(org.eclipse.collections.api.block.function.primitive.BooleanFunction,R)">collectBoolean</a></span>​(<a href="block/function/primitive/BooleanFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">BooleanFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> booleanFunction, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#collectBoolean(org.eclipse.collections.api.block.function.primitive.BooleanFunction)"><code>collectBoolean(BooleanFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i16"> |
| <td class="colFirst"><code><a href="ByteIterable.html" title="interface in org.eclipse.collections.api">ByteIterable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectByte(org.eclipse.collections.api.block.function.primitive.ByteFunction)">collectByte</a></span>​(<a href="block/function/primitive/ByteFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">ByteFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> byteFunction)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new primitive <code>byte</code> iterable with the results of applying the specified function on each element |
| of the source collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i17"> |
| <td class="colFirst"><code><R extends <a href="collection/primitive/MutableByteCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableByteCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectByte(org.eclipse.collections.api.block.function.primitive.ByteFunction,R)">collectByte</a></span>​(<a href="block/function/primitive/ByteFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">ByteFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> byteFunction, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#collectByte(org.eclipse.collections.api.block.function.primitive.ByteFunction)"><code>collectByte(ByteFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i18"> |
| <td class="colFirst"><code><a href="CharIterable.html" title="interface in org.eclipse.collections.api">CharIterable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectChar(org.eclipse.collections.api.block.function.primitive.CharFunction)">collectChar</a></span>​(<a href="block/function/primitive/CharFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">CharFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> charFunction)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new primitive <code>char</code> iterable with the results of applying the specified function on each element |
| of the source collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i19"> |
| <td class="colFirst"><code><R extends <a href="collection/primitive/MutableCharCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableCharCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectChar(org.eclipse.collections.api.block.function.primitive.CharFunction,R)">collectChar</a></span>​(<a href="block/function/primitive/CharFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">CharFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> charFunction, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#collectChar(org.eclipse.collections.api.block.function.primitive.CharFunction)"><code>collectChar(CharFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i20"> |
| <td class="colFirst"><code><a href="DoubleIterable.html" title="interface in org.eclipse.collections.api">DoubleIterable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction)">collectDouble</a></span>​(<a href="block/function/primitive/DoubleFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">DoubleFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> doubleFunction)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new primitive <code>double</code> iterable with the results of applying the specified function on each element |
| of the source collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i21"> |
| <td class="colFirst"><code><R extends <a href="collection/primitive/MutableDoubleCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableDoubleCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction,R)">collectDouble</a></span>​(<a href="block/function/primitive/DoubleFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">DoubleFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> doubleFunction, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#collectDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction)"><code>collectDouble(DoubleFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i22"> |
| <td class="colFirst"><code><a href="FloatIterable.html" title="interface in org.eclipse.collections.api">FloatIterable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction)">collectFloat</a></span>​(<a href="block/function/primitive/FloatFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">FloatFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> floatFunction)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new primitive <code>float</code> iterable with the results of applying the specified function on each element |
| of the source collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i23"> |
| <td class="colFirst"><code><R extends <a href="collection/primitive/MutableFloatCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableFloatCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction,R)">collectFloat</a></span>​(<a href="block/function/primitive/FloatFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">FloatFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> floatFunction, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#collectFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction)"><code>collectFloat(FloatFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i24"> |
| <td class="colFirst"><code><V> <a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectIf(org.eclipse.collections.api.block.predicate.Predicate,org.eclipse.collections.api.block.function.Function)">collectIf</a></span>​(<a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new collection with the results of applying the specified function on each element of the source |
| collection, but only for those elements which return true upon evaluation of the predicate.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i25"> |
| <td class="colFirst"><code><V,​ |
| R extends <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">Collection</a><V>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectIf(org.eclipse.collections.api.block.predicate.Predicate,org.eclipse.collections.api.block.function.Function,R)">collectIf</a></span>​(<a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as the collectIf method with two parameters but uses the specified target collection for the results.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i26"> |
| <td class="colFirst"><code><a href="IntIterable.html" title="interface in org.eclipse.collections.api">IntIterable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectInt(org.eclipse.collections.api.block.function.primitive.IntFunction)">collectInt</a></span>​(<a href="block/function/primitive/IntFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">IntFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> intFunction)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new primitive <code>int</code> iterable with the results of applying the specified function on each element |
| of the source collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i27"> |
| <td class="colFirst"><code><R extends <a href="collection/primitive/MutableIntCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableIntCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectInt(org.eclipse.collections.api.block.function.primitive.IntFunction,R)">collectInt</a></span>​(<a href="block/function/primitive/IntFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">IntFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> intFunction, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#collectInt(org.eclipse.collections.api.block.function.primitive.IntFunction)"><code>collectInt(IntFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i28"> |
| <td class="colFirst"><code><a href="LongIterable.html" title="interface in org.eclipse.collections.api">LongIterable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectLong(org.eclipse.collections.api.block.function.primitive.LongFunction)">collectLong</a></span>​(<a href="block/function/primitive/LongFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">LongFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> longFunction)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new primitive <code>long</code> iterable with the results of applying the specified function on each element |
| of the source collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i29"> |
| <td class="colFirst"><code><R extends <a href="collection/primitive/MutableLongCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableLongCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectLong(org.eclipse.collections.api.block.function.primitive.LongFunction,R)">collectLong</a></span>​(<a href="block/function/primitive/LongFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">LongFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> longFunction, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#collectLong(org.eclipse.collections.api.block.function.primitive.LongFunction)"><code>collectLong(LongFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i30"> |
| <td class="colFirst"><code><a href="ShortIterable.html" title="interface in org.eclipse.collections.api">ShortIterable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectShort(org.eclipse.collections.api.block.function.primitive.ShortFunction)">collectShort</a></span>​(<a href="block/function/primitive/ShortFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">ShortFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> shortFunction)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new primitive <code>short</code> iterable with the results of applying the specified function on each element |
| of the source collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i31"> |
| <td class="colFirst"><code><R extends <a href="collection/primitive/MutableShortCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableShortCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectShort(org.eclipse.collections.api.block.function.primitive.ShortFunction,R)">collectShort</a></span>​(<a href="block/function/primitive/ShortFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">ShortFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> shortFunction, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#collectShort(org.eclipse.collections.api.block.function.primitive.ShortFunction)"><code>collectShort(ShortFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i32"> |
| <td class="colFirst"><code><P,​ |
| V> <a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectWith(org.eclipse.collections.api.block.function.Function2,P)">collectWith</a></span>​(<a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P,​? extends V> function, |
| P parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#collect(org.eclipse.collections.api.block.function.Function)"><code>collect(Function)</code></a> with a <code>Function2</code> and specified parameter which is passed to the block.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i33"> |
| <td class="colFirst"><code><P,​ |
| V,​ |
| R extends <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">Collection</a><V>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectWith(org.eclipse.collections.api.block.function.Function2,P,R)">collectWith</a></span>​(<a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P,​? extends V> function, |
| P parameter, |
| R targetCollection)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as collectWith but with a targetCollection parameter to gather the results.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i34"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contains(java.lang.Object)">contains</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if the iterable has an element which responds true to element.equals(object).</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i35"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsAll(java.util.Collection)">containsAll</a></span>​(<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">Collection</a><?> source)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if all elements in source are contained in this collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i36"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsAllArguments(java.lang.Object...)">containsAllArguments</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>... elements)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if all elements in the specified var arg array are contained in this collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i37"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsAllIterable(java.lang.Iterable)">containsAllIterable</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><?> source)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if all elements in source are contained in this collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i38"> |
| <td class="colFirst"><code>default <V> boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#containsBy(org.eclipse.collections.api.block.function.Function,V)">containsBy</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function, |
| V value)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if the iterable has an element which responds true to element.equals(value) |
| after applying the specified function to the element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i39"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#count(org.eclipse.collections.api.block.predicate.Predicate)">count</a></span>​(<a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</code></th> |
| <td class="colLast"> |
| <div class="block">Return the total number of elements that answer true to the specified predicate.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i40"> |
| <td class="colFirst"><code>default <V> <a href="bag/Bag.html" title="interface in org.eclipse.collections.api.bag">Bag</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#countBy(org.eclipse.collections.api.block.function.Function)">countBy</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</code></th> |
| <td class="colLast"> |
| <div class="block">This method will count the number of occurrences of each value calculated by applying the |
| function to each element of the collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i41"> |
| <td class="colFirst"><code>default <V,​ |
| R extends <a href="bag/MutableBagIterable.html" title="interface in org.eclipse.collections.api.bag">MutableBagIterable</a><V>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#countBy(org.eclipse.collections.api.block.function.Function,R)">countBy</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">This method will count the number of occurrences of each value calculated by applying the |
| function to each element of the collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i42"> |
| <td class="colFirst"><code>default <V> <a href="bag/Bag.html" title="interface in org.eclipse.collections.api.bag">Bag</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#countByEach(org.eclipse.collections.api.block.function.Function)">countByEach</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</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><V>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">This method will count the number of occurrences of each value calculated by applying the |
| function to each element of the collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i43"> |
| <td class="colFirst"><code>default <V,​ |
| R extends <a href="bag/MutableBagIterable.html" title="interface in org.eclipse.collections.api.bag">MutableBagIterable</a><V>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#countByEach(org.eclipse.collections.api.block.function.Function,R)">countByEach</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</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><V>> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">This method will count the number of occurrences of each value calculated by applying the |
| function to each element of the collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i44"> |
| <td class="colFirst"><code>default <V,​ |
| P> <a href="bag/Bag.html" title="interface in org.eclipse.collections.api.bag">Bag</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#countByWith(org.eclipse.collections.api.block.function.Function2,P)">countByWith</a></span>​(<a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P,​? extends V> function, |
| P parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">This method will count the number of occurrences of each value calculated by applying the |
| function to each element of the collection with the specified parameter as the second argument.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i45"> |
| <td class="colFirst"><code>default <V,​ |
| P,​ |
| R extends <a href="bag/MutableBagIterable.html" title="interface in org.eclipse.collections.api.bag">MutableBagIterable</a><V>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#countByWith(org.eclipse.collections.api.block.function.Function2,P,R)">countByWith</a></span>​(<a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P,​? extends V> function, |
| P parameter, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">This method will count the number of occurrences of each value calculated by applying the |
| function to each element of the collection with the specified parameter as the second argument.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i46"> |
| <td class="colFirst"><code><P> int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#countWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">countWith</a></span>​(<a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the total number of elements that evaluate to true for the specified predicate.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i47"> |
| <td class="colFirst"><code><a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detect(org.eclipse.collections.api.block.predicate.Predicate)">detect</a></span>​(<a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no |
| element returns true.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i48"> |
| <td class="colFirst"><code>default <a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detectIfNone(org.eclipse.collections.api.block.predicate.Predicate,org.eclipse.collections.api.block.function.Function0)">detectIfNone</a></span>​(<a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate, |
| <a href="block/function/Function0.html" title="interface in org.eclipse.collections.api.block.function">Function0</a><? extends <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the first element of the iterable for which the predicate evaluates to true.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i49"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detectOptional(org.eclipse.collections.api.block.predicate.Predicate)">detectOptional</a></span>​(<a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the first element of the iterable for which the predicate evaluates to true as an Optional.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i50"> |
| <td class="colFirst"><code><P> <a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detectWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">detectWith</a></span>​(<a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none |
| evaluate to true.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i51"> |
| <td class="colFirst"><code><P> <a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detectWithIfNone(org.eclipse.collections.api.block.predicate.Predicate2,P,org.eclipse.collections.api.block.function.Function0)">detectWithIfNone</a></span>​(<a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter, |
| <a href="block/function/Function0.html" title="interface in org.eclipse.collections.api.block.function">Function0</a><? extends <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or |
| returns the value of evaluating the specified function.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i52"> |
| <td class="colFirst"><code><P> <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detectWithOptional(org.eclipse.collections.api.block.predicate.Predicate2,P)">detectWithOptional</a></span>​(<a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i53"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#each(org.eclipse.collections.api.block.procedure.Procedure)">each</a></span>​(<a href="block/procedure/Procedure.html" title="interface in org.eclipse.collections.api.block.procedure">Procedure</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> procedure)</code></th> |
| <td class="colLast"> |
| <div class="block">The procedure is executed for each element in the iterable.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i54"> |
| <td class="colFirst"><code><V> <a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flatCollect(org.eclipse.collections.api.block.function.Function)">flatCollect</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</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><V>> function)</code></th> |
| <td class="colLast"> |
| <div class="block"><code>flatCollect</code> is a special case of <a href="#collect(org.eclipse.collections.api.block.function.Function)"><code>collect(Function)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i55"> |
| <td class="colFirst"><code><V,​ |
| R extends <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">Collection</a><V>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flatCollect(org.eclipse.collections.api.block.function.Function,R)">flatCollect</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</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><V>> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i56"> |
| <td class="colFirst"><code>default <R extends <a href="collection/primitive/MutableBooleanCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableBooleanCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flatCollectBoolean(org.eclipse.collections.api.block.function.Function,R)">flatCollectBoolean</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="BooleanIterable.html" title="interface in org.eclipse.collections.api">BooleanIterable</a>> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i57"> |
| <td class="colFirst"><code>default <R extends <a href="collection/primitive/MutableByteCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableByteCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flatCollectByte(org.eclipse.collections.api.block.function.Function,R)">flatCollectByte</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="ByteIterable.html" title="interface in org.eclipse.collections.api">ByteIterable</a>> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i58"> |
| <td class="colFirst"><code>default <R extends <a href="collection/primitive/MutableCharCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableCharCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flatCollectChar(org.eclipse.collections.api.block.function.Function,R)">flatCollectChar</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="CharIterable.html" title="interface in org.eclipse.collections.api">CharIterable</a>> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i59"> |
| <td class="colFirst"><code>default <R extends <a href="collection/primitive/MutableDoubleCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableDoubleCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flatCollectDouble(org.eclipse.collections.api.block.function.Function,R)">flatCollectDouble</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="DoubleIterable.html" title="interface in org.eclipse.collections.api">DoubleIterable</a>> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i60"> |
| <td class="colFirst"><code>default <R extends <a href="collection/primitive/MutableFloatCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableFloatCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flatCollectFloat(org.eclipse.collections.api.block.function.Function,R)">flatCollectFloat</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="FloatIterable.html" title="interface in org.eclipse.collections.api">FloatIterable</a>> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i61"> |
| <td class="colFirst"><code>default <R extends <a href="collection/primitive/MutableIntCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableIntCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flatCollectInt(org.eclipse.collections.api.block.function.Function,R)">flatCollectInt</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="IntIterable.html" title="interface in org.eclipse.collections.api">IntIterable</a>> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i62"> |
| <td class="colFirst"><code>default <R extends <a href="collection/primitive/MutableLongCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableLongCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flatCollectLong(org.eclipse.collections.api.block.function.Function,R)">flatCollectLong</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="LongIterable.html" title="interface in org.eclipse.collections.api">LongIterable</a>> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i63"> |
| <td class="colFirst"><code>default <R extends <a href="collection/primitive/MutableShortCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableShortCollection</a>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flatCollectShort(org.eclipse.collections.api.block.function.Function,R)">flatCollectShort</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="ShortIterable.html" title="interface in org.eclipse.collections.api">ShortIterable</a>> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i64"> |
| <td class="colFirst"><code>default <P,​ |
| V> <a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flatCollectWith(org.eclipse.collections.api.block.function.Function2,P)">flatCollectWith</a></span>​(<a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P,​? 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><V>> function, |
| P parameter)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i65"> |
| <td class="colFirst"><code>default <P,​ |
| V,​ |
| R extends <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">Collection</a><V>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flatCollectWith(org.eclipse.collections.api.block.function.Function2,P,R)">flatCollectWith</a></span>​(<a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P,​? 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><V>> function, |
| P parameter, |
| R target)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i66"> |
| <td class="colFirst"><code>default void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#forEach(org.eclipse.collections.api.block.procedure.Procedure)">forEach</a></span>​(<a href="block/procedure/Procedure.html" title="interface in org.eclipse.collections.api.block.procedure">Procedure</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> procedure)</code></th> |
| <td class="colLast"> |
| <div class="block">The procedure is executed for each element in the iterable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i67"> |
| <td class="colFirst"><code>default <a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAny()">getAny</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns any element of an iterable.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i68"> |
| <td class="colFirst"><code><a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFirst()">getFirst</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in 6.0.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i69"> |
| <td class="colFirst"><code><a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLast()">getLast</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in 6.0.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i70"> |
| <td class="colFirst"><code>default <a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOnly()">getOnly</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the element if the iterable has exactly one element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i71"> |
| <td class="colFirst"><code><V> <a href="multimap/Multimap.html" title="interface in org.eclipse.collections.api.multimap">Multimap</a><V,​<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> 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="altColor" id="i72"> |
| <td class="colFirst"><code><V,​ |
| R extends <a href="multimap/MutableMultimap.html" title="interface in org.eclipse.collections.api.multimap">MutableMultimap</a><V,​ |
| <a href="RichIterable.html" title="type parameter in RichIterable">T</a>>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupBy(org.eclipse.collections.api.block.function.Function,R)">groupBy</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#groupBy(org.eclipse.collections.api.block.function.Function)"><code>groupBy(Function)</code></a>, except that the results are gathered into the specified <code>target</code> |
| multimap.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i73"> |
| <td class="colFirst"><code>default <K,​ |
| V,​ |
| R extends <a href="multimap/MutableMultimap.html" title="interface in org.eclipse.collections.api.multimap">MutableMultimap</a><K,​ |
| V>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupByAndCollect(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function,R)">groupByAndCollect</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends K> groupByFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> collectFunction, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Applies a groupBy function over the iterable, followed by a collect function.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i74"> |
| <td class="colFirst"><code><V> <a href="multimap/Multimap.html" title="interface in org.eclipse.collections.api.multimap">Multimap</a><V,​<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</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><V>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Similar to <a href="#groupBy(org.eclipse.collections.api.block.function.Function)"><code>groupBy(Function)</code></a>, except the result of evaluating function will return a collection of keys |
| for each value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i75"> |
| <td class="colFirst"><code><V,​ |
| R extends <a href="multimap/MutableMultimap.html" title="interface in org.eclipse.collections.api.multimap">MutableMultimap</a><V,​ |
| <a href="RichIterable.html" title="type parameter in RichIterable">T</a>>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupByEach(org.eclipse.collections.api.block.function.Function,R)">groupByEach</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</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><V>> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#groupByEach(org.eclipse.collections.api.block.function.Function)"><code>groupByEach(Function)</code></a>, except that the results are gathered into the specified <code>target</code> |
| multimap.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i76"> |
| <td class="colFirst"><code><V> <a href="map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><V,​<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> 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="i77"> |
| <td class="colFirst"><code><V,​ |
| R extends <a href="map/MutableMapIterable.html" title="interface in org.eclipse.collections.api.map">MutableMapIterable</a><V,​ |
| <a href="RichIterable.html" title="type parameter in RichIterable">T</a>>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#groupByUniqueKey(org.eclipse.collections.api.block.function.Function,R)">groupByUniqueKey</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#groupByUniqueKey(org.eclipse.collections.api.block.function.Function)"><code>groupByUniqueKey(Function)</code></a>, except that the results are gathered into the specified <code>target</code> |
| map.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i78"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#injectInto(double,org.eclipse.collections.api.block.function.primitive.DoubleObjectToDoubleFunction)">injectInto</a></span>​(double injectedValue, |
| <a href="block/function/primitive/DoubleObjectToDoubleFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">DoubleObjectToDoubleFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the final double result of evaluating function using each element of the iterable and the previous evaluation |
| result as the parameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i79"> |
| <td class="colFirst"><code>float</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#injectInto(float,org.eclipse.collections.api.block.function.primitive.FloatObjectToFloatFunction)">injectInto</a></span>​(float injectedValue, |
| <a href="block/function/primitive/FloatObjectToFloatFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">FloatObjectToFloatFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the final float result of evaluating function using each element of the iterable and the previous evaluation |
| result as the parameters.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i80"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#injectInto(int,org.eclipse.collections.api.block.function.primitive.IntObjectToIntFunction)">injectInto</a></span>​(int injectedValue, |
| <a href="block/function/primitive/IntObjectToIntFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">IntObjectToIntFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the final int result of evaluating function using each element of the iterable and the previous evaluation |
| result as the parameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i81"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#injectInto(long,org.eclipse.collections.api.block.function.primitive.LongObjectToLongFunction)">injectInto</a></span>​(long injectedValue, |
| <a href="block/function/primitive/LongObjectToLongFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">LongObjectToLongFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the final long result of evaluating function using each element of the iterable and the previous evaluation |
| result as the parameters.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i82"> |
| <td class="colFirst"><code><IV> IV</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#injectInto(IV,org.eclipse.collections.api.block.function.Function2)">injectInto</a></span>​(IV injectedValue, |
| <a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super IV,​? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends IV> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the final result of evaluating function using each element of the iterable and the previous evaluation |
| result as the parameters.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i83"> |
| <td class="colFirst"><code><R extends <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">Collection</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#into(R)">into</a></span>​(R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Adds all the elements in this iterable to the specific target Collection.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i84"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmpty()">isEmpty</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this iterable has zero items.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i85"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#makeString()">makeString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a string representation of this collection by delegating to <a href="#makeString(java.lang.String)"><code>makeString(String)</code></a> and defaulting |
| the separator parameter to the characters <code>", "</code> (comma and space).</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i86"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#makeString(java.lang.String)">makeString</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> separator)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a string representation of this collection by delegating to <a href="#makeString(java.lang.String,java.lang.String,java.lang.String)"><code>makeString(String, String, String)</code></a> |
| and defaulting the start and end parameters to <code>""</code> (the empty String).</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i87"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#makeString(java.lang.String,java.lang.String,java.lang.String)">makeString</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> start, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> separator, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> end)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a string representation of this collection with the elements separated by the specified |
| separator and enclosed between the start and end strings.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i88"> |
| <td class="colFirst"><code><a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#max()">max</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum element out of this container based on the natural order.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i89"> |
| <td class="colFirst"><code><a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#max(java.util.Comparator)">max</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum element out of this container based on the comparator.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i90"> |
| <td class="colFirst"><code><V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>><br><a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxBy(org.eclipse.collections.api.block.function.Function)">maxBy</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i91"> |
| <td class="colFirst"><code>default <V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxByOptional(org.eclipse.collections.api.block.function.Function)">maxByOptional</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum elements out of this container based on the natural order of the attribute returned by Function as an Optional.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i92"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxOptional()">maxOptional</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum element out of this container based on the natural order as an Optional.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i93"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxOptional(java.util.Comparator)">maxOptional</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum element out of this container based on the comparator as an Optional.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i94"> |
| <td class="colFirst"><code><a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#min()">min</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the minimum element out of this container based on the natural order.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i95"> |
| <td class="colFirst"><code><a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#min(java.util.Comparator)">min</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the minimum element out of this container based on the comparator.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i96"> |
| <td class="colFirst"><code><V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>><br><a href="RichIterable.html" title="type parameter in RichIterable">T</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#minBy(org.eclipse.collections.api.block.function.Function)">minBy</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i97"> |
| <td class="colFirst"><code>default <V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>><br><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#minByOptional(org.eclipse.collections.api.block.function.Function)">minByOptional</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the minimum elements out of this container based on the natural order of the attribute returned by Function as an Optional.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i98"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#minOptional()">minOptional</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the minimum element out of this container based on the natural order as an Optional.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i99"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#minOptional(java.util.Comparator)">minOptional</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the minimum element out of this container based on the comparator as an Optional.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i100"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#noneSatisfy(org.eclipse.collections.api.block.predicate.Predicate)">noneSatisfy</a></span>​(<a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i101"> |
| <td class="colFirst"><code><P> boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#noneSatisfyWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">noneSatisfyWith</a></span>​(<a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if the predicate evaluates to false for every element of the collection, or return false.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i102"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#notEmpty()">notEmpty</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">The English equivalent of !this.isEmpty()</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i103"> |
| <td class="colFirst"><code><a href="partition/PartitionIterable.html" title="interface in org.eclipse.collections.api.partition">PartitionIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</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="altColor" id="i104"> |
| <td class="colFirst"><code><P> <a href="partition/PartitionIterable.html" title="interface in org.eclipse.collections.api.partition">PartitionIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</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="rowColor" id="i105"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reduce(java.util.function.BinaryOperator)">reduce</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/BinaryOperator.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BinaryOperator</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>> accumulator)</code></th> |
| <td class="colLast"> |
| <div class="block">This method produces the equivalent result as <a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true#reduce(java.util.function.BinaryOperator)" title="class or interface in java.util.stream" class="externalLink"><code>Stream.reduce(BinaryOperator)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i106"> |
| <td class="colFirst"><code>default <R> R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reduceInPlace(java.util.function.Supplier,java.util.function.BiConsumer)">reduceInPlace</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Supplier</a><R> supplier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a><R,​? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> accumulator)</code></th> |
| <td class="colLast"> |
| <div class="block">This method produces the equivalent result as <a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true#collect(java.util.function.Supplier,java.util.function.BiConsumer,java.util.function.BiConsumer)" title="class or interface in java.util.stream" class="externalLink"><code>Stream.collect(Supplier, BiConsumer, BiConsumer)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i107"> |
| <td class="colFirst"><code>default <R,​ |
| A> R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reduceInPlace(java.util.stream.Collector)">reduceInPlace</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Collector.html?is-external=true" title="class or interface in java.util.stream" class="externalLink">Collector</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​A,​R> collector)</code></th> |
| <td class="colLast"> |
| <div class="block">This method produces the equivalent result as <a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true#collect(java.util.stream.Collector)" title="class or interface in java.util.stream" class="externalLink"><code>Stream.collect(Collector)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i108"> |
| <td class="colFirst"><code><a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</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="i109"> |
| <td class="colFirst"><code><R extends <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">Collection</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reject(org.eclipse.collections.api.block.predicate.Predicate,R)">reject</a></span>​(<a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as the reject method with one parameter but uses the specified target collection for the results.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i110"> |
| <td class="colFirst"><code><P> <a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Similar to <a href="#reject(org.eclipse.collections.api.block.predicate.Predicate)"><code>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="i111"> |
| <td class="colFirst"><code><P,​ |
| R extends <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">Collection</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rejectWith(org.eclipse.collections.api.block.predicate.Predicate2,P,R)">rejectWith</a></span>​(<a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter, |
| R targetCollection)</code></th> |
| <td class="colLast"> |
| <div class="block">Similar to <a href="#reject(org.eclipse.collections.api.block.predicate.Predicate,R)"><code>reject(Predicate, Collection)</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="altColor" id="i112"> |
| <td class="colFirst"><code><a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</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="rowColor" id="i113"> |
| <td class="colFirst"><code><R extends <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">Collection</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#select(org.eclipse.collections.api.block.predicate.Predicate,R)">select</a></span>​(<a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as the select method with one parameter but uses the specified target collection for the results.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i114"> |
| <td class="colFirst"><code><S> <a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</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="rowColor" id="i115"> |
| <td class="colFirst"><code><P> <a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</code></th> |
| <td class="colLast"> |
| <div class="block">Similar to <a href="#select(org.eclipse.collections.api.block.predicate.Predicate)"><code>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="altColor" id="i116"> |
| <td class="colFirst"><code><P,​ |
| R extends <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">Collection</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectWith(org.eclipse.collections.api.block.predicate.Predicate2,P,R)">selectWith</a></span>​(<a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter, |
| R targetCollection)</code></th> |
| <td class="colLast"> |
| <div class="block">Similar to <a href="#select(org.eclipse.collections.api.block.predicate.Predicate,R)"><code>select(Predicate, Collection)</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="i117"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#size()">size</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the number of items in this iterable.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i118"> |
| <td class="colFirst"><code><V> <a href="map/primitive/ObjectDoubleMap.html" title="interface in org.eclipse.collections.api.map.primitive">ObjectDoubleMap</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sumByDouble(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.primitive.DoubleFunction)">sumByDouble</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> groupBy, |
| <a href="block/function/primitive/DoubleFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">DoubleFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Groups and sums the values using the two specified functions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i119"> |
| <td class="colFirst"><code><V> <a href="map/primitive/ObjectDoubleMap.html" title="interface in org.eclipse.collections.api.map.primitive">ObjectDoubleMap</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sumByFloat(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.primitive.FloatFunction)">sumByFloat</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> groupBy, |
| <a href="block/function/primitive/FloatFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">FloatFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Groups and sums the values using the two specified functions.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i120"> |
| <td class="colFirst"><code><V> <a href="map/primitive/ObjectLongMap.html" title="interface in org.eclipse.collections.api.map.primitive">ObjectLongMap</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sumByInt(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.primitive.IntFunction)">sumByInt</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> groupBy, |
| <a href="block/function/primitive/IntFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">IntFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Groups and sums the values using the two specified functions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i121"> |
| <td class="colFirst"><code><V> <a href="map/primitive/ObjectLongMap.html" title="interface in org.eclipse.collections.api.map.primitive">ObjectLongMap</a><V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sumByLong(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.primitive.LongFunction)">sumByLong</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> groupBy, |
| <a href="block/function/primitive/LongFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">LongFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Groups and sums the values using the two specified functions.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i122"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/DoubleSummaryStatistics.html?is-external=true" title="class or interface in java.util" class="externalLink">DoubleSummaryStatistics</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#summarizeDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction)">summarizeDouble</a></span>​(<a href="block/function/primitive/DoubleFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">DoubleFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the result of summarizing the value returned from applying the DoubleFunction to |
| each element of the iterable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i123"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/DoubleSummaryStatistics.html?is-external=true" title="class or interface in java.util" class="externalLink">DoubleSummaryStatistics</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#summarizeFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction)">summarizeFloat</a></span>​(<a href="block/function/primitive/FloatFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">FloatFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the result of summarizing the value returned from applying the FloatFunction to |
| each element of the iterable.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i124"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/IntSummaryStatistics.html?is-external=true" title="class or interface in java.util" class="externalLink">IntSummaryStatistics</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#summarizeInt(org.eclipse.collections.api.block.function.primitive.IntFunction)">summarizeInt</a></span>​(<a href="block/function/primitive/IntFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">IntFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the result of summarizing the value returned from applying the IntFunction to |
| each element of the iterable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i125"> |
| <td class="colFirst"><code>default <a href="https://docs.oracle.com/javase/8/docs/api/java/util/LongSummaryStatistics.html?is-external=true" title="class or interface in java.util" class="externalLink">LongSummaryStatistics</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#summarizeLong(org.eclipse.collections.api.block.function.primitive.LongFunction)">summarizeLong</a></span>​(<a href="block/function/primitive/LongFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">LongFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the result of summarizing the value returned from applying the LongFunction to |
| each element of the iterable.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i126"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sumOfDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction)">sumOfDouble</a></span>​(<a href="block/function/primitive/DoubleFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">DoubleFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the final double result of evaluating function for each element of the iterable and adding the results |
| together.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i127"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sumOfFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction)">sumOfFloat</a></span>​(<a href="block/function/primitive/FloatFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">FloatFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the final double result of evaluating function for each element of the iterable and adding the results |
| together.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i128"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sumOfInt(org.eclipse.collections.api.block.function.primitive.IntFunction)">sumOfInt</a></span>​(<a href="block/function/primitive/IntFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">IntFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the final long result of evaluating function for each element of the iterable and adding the results |
| together.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i129"> |
| <td class="colFirst"><code>long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sumOfLong(org.eclipse.collections.api.block.function.primitive.LongFunction)">sumOfLong</a></span>​(<a href="block/function/primitive/LongFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">LongFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the final long result of evaluating function for each element of the iterable and adding the results |
| together.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i130"> |
| <td class="colFirst"><code><a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>> procedure)</code></th> |
| <td class="colLast"> |
| <div class="block">Executes the Procedure for each element in the iterable and returns <code>this</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i131"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toArray()">toArray</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts this iterable to an array.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i132"> |
| <td class="colFirst"><code><E> E[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toArray(E%5B%5D)">toArray</a></span>​(E[] array)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts this iterable to an array using the specified target array, assuming the target array is as long |
| or longer than the iterable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i133"> |
| <td class="colFirst"><code><a href="bag/MutableBag.html" title="interface in org.eclipse.collections.api.bag">MutableBag</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toBag()">toBag</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to the default MutableBag implementation.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i134"> |
| <td class="colFirst"><code><NK,​ |
| NV> <a href="bimap/MutableBiMap.html" title="interface in org.eclipse.collections.api.bimap">MutableBiMap</a><NK,​NV></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toBiMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toBiMap</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NK> keyFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NV> valueFunction)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a BiMap implementation using the specified key and value functions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i135"> |
| <td class="colFirst"><code><a href="list/MutableList.html" title="interface in org.eclipse.collections.api.list">MutableList</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toList()">toList</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableList implementation.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i136"> |
| <td class="colFirst"><code><NK,​ |
| NV> <a href="map/MutableMap.html" title="interface in org.eclipse.collections.api.map">MutableMap</a><NK,​NV></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toMap</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NK> keyFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NV> valueFunction)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableMap implementation using the specified key and value functions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i137"> |
| <td class="colFirst"><code>default <NK,​ |
| NV,​ |
| R extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><NK,​ |
| NV>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function,R)">toMap</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NK> keyFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NV> valueFunction, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block">Same as <a href="#toMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)"><code>toMap(Function, Function)</code></a>, except that the results are gathered into the specified <code>target</code> |
| map.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i138"> |
| <td class="colFirst"><code><a href="set/MutableSet.html" title="interface in org.eclipse.collections.api.set">MutableSet</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSet()">toSet</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableSet implementation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i139"> |
| <td class="colFirst"><code><a href="bag/sorted/MutableSortedBag.html" title="interface in org.eclipse.collections.api.bag.sorted">MutableSortedBag</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSortedBag()">toSortedBag</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableSortedBag implementation and sorts it using the natural order of the |
| elements.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i140"> |
| <td class="colFirst"><code><a href="bag/sorted/MutableSortedBag.html" title="interface in org.eclipse.collections.api.bag.sorted">MutableSortedBag</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSortedBag(java.util.Comparator)">toSortedBag</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i141"> |
| <td class="colFirst"><code>default <V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>><br><a href="bag/sorted/MutableSortedBag.html" title="interface in org.eclipse.collections.api.bag.sorted">MutableSortedBag</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSortedBagBy(org.eclipse.collections.api.block.function.Function)">toSortedBagBy</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableSortedBag implementation and sorts it based on the natural order of the |
| attribute returned by <code>function</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i142"> |
| <td class="colFirst"><code>default <a href="list/MutableList.html" title="interface in org.eclipse.collections.api.list">MutableList</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSortedList()">toSortedList</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i143"> |
| <td class="colFirst"><code>default <a href="list/MutableList.html" title="interface in org.eclipse.collections.api.list">MutableList</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSortedList(java.util.Comparator)">toSortedList</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableList implementation and sorts it using the specified comparator.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i144"> |
| <td class="colFirst"><code>default <V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>><br><a href="list/MutableList.html" title="interface in org.eclipse.collections.api.list">MutableList</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSortedListBy(org.eclipse.collections.api.block.function.Function)">toSortedListBy</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableList implementation and sorts it based on the natural order of the |
| attribute returned by <code>function</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i145"> |
| <td class="colFirst"><code><NK,​ |
| NV> <a href="map/sorted/MutableSortedMap.html" title="interface in org.eclipse.collections.api.map.sorted">MutableSortedMap</a><NK,​NV></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSortedMap(java.util.Comparator,org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toSortedMap</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super NK> comparator, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NK> keyFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NV> valueFunction)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableSortedMap implementation using the specified key and value functions |
| sorted by the given comparator.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i146"> |
| <td class="colFirst"><code><NK,​ |
| NV> <a href="map/sorted/MutableSortedMap.html" title="interface in org.eclipse.collections.api.map.sorted">MutableSortedMap</a><NK,​NV></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSortedMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toSortedMap</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NK> keyFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NV> valueFunction)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableSortedMap implementation using the specified key and value functions |
| sorted by the key elements' natural ordering.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i147"> |
| <td class="colFirst"><code>default <KK extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super KK>,​ |
| NK,​ |
| NV><br><a href="map/sorted/MutableSortedMap.html" title="interface in org.eclipse.collections.api.map.sorted">MutableSortedMap</a><NK,​NV></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSortedMapBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toSortedMapBy</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super NK,​KK> sortBy, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NK> keyFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NV> valueFunction)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableSortedMap implementation using the specified key and value functions |
| and sorts it based on the natural order of the attribute returned by <code>sortBy</code> function.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i148"> |
| <td class="colFirst"><code><a href="set/sorted/MutableSortedSet.html" title="interface in org.eclipse.collections.api.set.sorted">MutableSortedSet</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSortedSet()">toSortedSet</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the |
| elements.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i149"> |
| <td class="colFirst"><code><a href="set/sorted/MutableSortedSet.html" title="interface in org.eclipse.collections.api.set.sorted">MutableSortedSet</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSortedSet(java.util.Comparator)">toSortedSet</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i150"> |
| <td class="colFirst"><code>default <V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>><br><a href="set/sorted/MutableSortedSet.html" title="interface in org.eclipse.collections.api.set.sorted">MutableSortedSet</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSortedSetBy(org.eclipse.collections.api.block.function.Function)">toSortedSetBy</a></span>​(<a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the |
| attribute returned by <code>function</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i151"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a string with the elements of this iterable separated by commas with spaces and |
| enclosed in square brackets.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i152"> |
| <td class="colFirst"><code><S> <a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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 6.0.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i153"> |
| <td class="colFirst"><code><S,​ |
| R extends <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">Collection</a><<a href="tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​ |
| S>>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#zip(java.lang.Iterable,R)">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, |
| R target)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in 6.0.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i154"> |
| <td class="colFirst"><code><a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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 6.0.</div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i155"> |
| <td class="colFirst"><code><R extends <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">Collection</a><<a href="tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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>>>><br>R</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#zipWithIndex(R)">zipWithIndex</a></span>​(R target)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in 6.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>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#spliterator()" title="class or interface in java.lang" class="externalLink">spliterator</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="forEach(org.eclipse.collections.api.block.procedure.Procedure)">forEach</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType">void</span> <span class="memberName">forEach</span>​(<span class="arguments"><a href="block/procedure/Procedure.html" title="interface in org.eclipse.collections.api.block.procedure">Procedure</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> procedure)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="InternalIterable.html#forEach(org.eclipse.collections.api.block.procedure.Procedure)">InternalIterable</a></code></span></div> |
| <div class="block">The procedure is executed for each element in the iterable. |
| <p> |
| Example using a Java 8 lambda: |
| <pre> |
| people.forEach(Procedures.cast(person -> LOGGER.info(person.getName()))); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| people.forEach(new Procedure<Person>() |
| { |
| public void value(Person person) |
| { |
| LOGGER.info(person.getName()); |
| } |
| }); |
| </pre> |
| NOTE: This method started to conflict with <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="externalLink"><code>Iterable.forEach(java.util.function.Consumer)</code></a> |
| since Java 1.8. It is recommended to use <a href="#each(org.eclipse.collections.api.block.procedure.Procedure)"><code>each(Procedure)</code></a> instead to avoid casting to Procedure.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="InternalIterable.html#forEach(org.eclipse.collections.api.block.procedure.Procedure)">forEach</a></code> in interface <code><a href="InternalIterable.html" title="interface in org.eclipse.collections.api">InternalIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#each(org.eclipse.collections.api.block.procedure.Procedure)"><code>each(Procedure)</code></a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="externalLink"><code>Iterable.forEach(java.util.function.Consumer)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="size()">size</a></h3> |
| <div class="memberSignature"><span class="returnType">int</span> <span class="memberName">size</span>()</div> |
| <div class="block">Returns the number of items in this iterable.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isEmpty()">isEmpty</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">isEmpty</span>()</div> |
| <div class="block">Returns true if this iterable has zero items.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="notEmpty()">notEmpty</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType">boolean</span> <span class="memberName">notEmpty</span>()</div> |
| <div class="block">The English equivalent of !this.isEmpty()</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getAny()">getAny</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">getAny</span>()</div> |
| <div class="block">Returns any element of an iterable.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an element of an iterable.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>10.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getFirst()">getFirst</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="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">getFirst</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in 6.0. Use <a href="ordered/OrderedIterable.html#getFirst()"><code>OrderedIterable.getFirst()</code></a> instead.</div> |
| </div> |
| <div class="block">Returns the first element of an iterable. In the case of a List it is the element at the first index. In the |
| case of any other Collection, it is the first element that would be returned during an iteration. If the |
| iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to |
| check to see if the iterable is empty to validate that a null result was not due to the container being empty. |
| <p> |
| The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use |
| this method, the first element could be any element from the Set.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getLast()">getLast</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="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">getLast</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in 6.0. Use <a href="ordered/OrderedIterable.html#getLast()"><code>OrderedIterable.getLast()</code></a> instead.</div> |
| </div> |
| <div class="block">Returns the last element of an iterable. In the case of a List it is the element at the last index. In the case |
| of any other Collection, it is the last element that would be returned during an iteration. If the iterable is |
| empty, null is returned. If null is a valid element of the container, then a developer would need to check to |
| see if the iterable is empty to validate that a null result was not due to the container being empty. |
| <p> |
| The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use |
| this method, the last element could be any element from the Set.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getOnly()">getOnly</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">getOnly</span>()</div> |
| <div class="block">Returns the element if the iterable has exactly one element. Otherwise, throw <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>IllegalStateException</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an element of an iterable.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if iterable is empty or has multiple elements.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="contains(java.lang.Object)">contains</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">contains</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object)</span></div> |
| <div class="block">Returns true if the iterable has an element which responds true to element.equals(object).</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="containsBy(org.eclipse.collections.api.block.function.Function,java.lang.Object)"> |
| <!-- --> |
| </a><a id="containsBy(org.eclipse.collections.api.block.function.Function,V)">containsBy</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><V></span> <span class="returnType">boolean</span> <span class="memberName">containsBy</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function, |
| V value)</span></div> |
| <div class="block">Returns true if the iterable has an element which responds true to element.equals(value) |
| after applying the specified function to the element.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>10.3</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="containsAllIterable(java.lang.Iterable)">containsAllIterable</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">containsAllIterable</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><?> source)</span></div> |
| <div class="block">Returns true if all elements in source are contained in this collection.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="containsAll(java.util.Collection)">containsAll</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">containsAll</span>​(<span class="arguments"><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">Collection</a><?> source)</span></div> |
| <div class="block">Returns true if all elements in source are contained in this collection.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true#containsAll(java.util.Collection)" title="class or interface in java.util" class="externalLink"><code>Collection.containsAll(Collection)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="containsAllArguments(java.lang.Object...)">containsAllArguments</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">containsAllArguments</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>... elements)</span></div> |
| <div class="block">Returns true if all elements in the specified var arg array are contained in this collection.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</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="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>> procedure)</span></div> |
| <div class="block">Executes the Procedure for each element in the iterable and returns <code>this</code>. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| RichIterable<Person> tapped = |
| people.<b>tap</b>(person -> LOGGER.info(person.getName())); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| RichIterable<Person> tapped = |
| people.<b>tap</b>(new Procedure<Person>() |
| { |
| public void value(Person person) |
| { |
| LOGGER.info(person.getName()); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>6.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#each(org.eclipse.collections.api.block.procedure.Procedure)"><code>each(Procedure)</code></a>, |
| <a href="#forEach(org.eclipse.collections.api.block.procedure.Procedure)"><code>forEach(Procedure)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="each(org.eclipse.collections.api.block.procedure.Procedure)">each</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">each</span>​(<span class="arguments"><a href="block/procedure/Procedure.html" title="interface in org.eclipse.collections.api.block.procedure">Procedure</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> procedure)</span></div> |
| <div class="block">The procedure is executed for each element in the iterable. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| people.each(person -> LOGGER.info(person.getName())); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| people.each(new Procedure<Person>() |
| { |
| public void value(Person person) |
| { |
| LOGGER.info(person.getName()); |
| } |
| }); |
| </pre> |
| This method is a variant of <a href="InternalIterable.html#forEach(org.eclipse.collections.api.block.procedure.Procedure)"><code>InternalIterable.forEach(Procedure)</code></a> |
| that has a signature conflict with <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="externalLink"><code>Iterable.forEach(java.util.function.Consumer)</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>6.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="InternalIterable.html#forEach(org.eclipse.collections.api.block.procedure.Procedure)"><code>InternalIterable.forEach(Procedure)</code></a>, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="externalLink"><code>Iterable.forEach(java.util.function.Consumer)</code></a></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="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</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="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="select(org.eclipse.collections.api.block.predicate.Predicate,java.util.Collection)"> |
| <!-- --> |
| </a><a id="select(org.eclipse.collections.api.block.predicate.Predicate,R)">select</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><R extends <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">Collection</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>>></span> <span class="returnType">R</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="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate, |
| R target)</span></div> |
| <div class="block">Same as the select method with one parameter but uses the specified target collection for the results. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| MutableList<Person> selected = |
| people.select(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| MutableList<Person> selected = |
| people.select(new Predicate<Person>() |
| { |
| public boolean accept(Person person) |
| { |
| return person.person.getLastName().equals("Smith"); |
| } |
| }, Lists.mutable.empty()); |
| </pre> |
| <p></div> |
| <dl> |
| <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 select criteria</dd> |
| <dd><code>target</code> - the Collection to append to for all elements in this <code>RichIterable</code> that meet select criteria <code>predicate</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which contains appended elements as a result of the select criteria</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#select(org.eclipse.collections.api.block.predicate.Predicate)"><code>select(Predicate)</code></a></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="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</span></div> |
| <div class="block">Similar to <a href="#select(org.eclipse.collections.api.block.predicate.Predicate)"><code>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="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="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#select(org.eclipse.collections.api.block.predicate.Predicate)"><code>select(Predicate)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="selectWith(org.eclipse.collections.api.block.predicate.Predicate2,java.lang.Object,java.util.Collection)"> |
| <!-- --> |
| </a><a id="selectWith(org.eclipse.collections.api.block.predicate.Predicate2,P,R)">selectWith</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P,​ |
| R extends <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">Collection</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>>></span> <span class="returnType">R</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="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter, |
| R targetCollection)</span></div> |
| <div class="block">Similar to <a href="#select(org.eclipse.collections.api.block.predicate.Predicate,R)"><code>select(Predicate, Collection)</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> |
| MutableList<Person> selected = |
| people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18), Lists.mutable.empty()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| MutableList<Person> selected = |
| people.selectWith(new Predicate2<Person, Integer>() |
| { |
| public boolean accept(Person person, Integer age) |
| { |
| return person.getAge()>= age; |
| } |
| }, Integer.valueOf(18), Lists.mutable.empty()); |
| </pre></div> |
| <dl> |
| <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> |
| <dd><code>targetCollection</code> - the Collection to append to for all elements in this <code>RichIterable</code> that meet select criteria <code>predicate</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>targetCollection</code>, which contains appended elements as a result of the select criteria</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#select(org.eclipse.collections.api.block.predicate.Predicate)"><code>select(Predicate)</code></a>, |
| <a href="#select(org.eclipse.collections.api.block.predicate.Predicate,R)"><code>select(Predicate, Collection)</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="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</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="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> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</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="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</span></div> |
| <div class="block">Similar to <a href="#reject(org.eclipse.collections.api.block.predicate.Predicate)"><code>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="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="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#select(org.eclipse.collections.api.block.predicate.Predicate)"><code>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,java.util.Collection)"> |
| <!-- --> |
| </a><a id="reject(org.eclipse.collections.api.block.predicate.Predicate,R)">reject</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><R extends <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">Collection</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>>></span> <span class="returnType">R</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="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate, |
| R target)</span></div> |
| <div class="block">Same as the reject method with one parameter but uses the specified target collection for the results. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| MutableList<Person> rejected = |
| people.reject(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| MutableList<Person> rejected = |
| people.reject(new Predicate<Person>() |
| { |
| public boolean accept(Person person) |
| { |
| return person.person.getLastName().equals("Smith"); |
| } |
| }, Lists.mutable.empty()); |
| </pre></div> |
| <dl> |
| <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> |
| <dd><code>target</code> - the Collection to append to for all elements in this <code>RichIterable</code> that cause <code>Predicate#accept(Object)</code> method to evaluate to false</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which contains appended elements as a result of the reject criteria</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="rejectWith(org.eclipse.collections.api.block.predicate.Predicate2,java.lang.Object,java.util.Collection)"> |
| <!-- --> |
| </a><a id="rejectWith(org.eclipse.collections.api.block.predicate.Predicate2,P,R)">rejectWith</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P,​ |
| R extends <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">Collection</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>>></span> <span class="returnType">R</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="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter, |
| R targetCollection)</span></div> |
| <div class="block">Similar to <a href="#reject(org.eclipse.collections.api.block.predicate.Predicate,R)"><code>reject(Predicate, Collection)</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> |
| MutableList<Person> rejected = |
| people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18), Lists.mutable.empty()); |
| </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), Lists.mutable.empty()); |
| </pre></div> |
| <dl> |
| <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 reject 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> |
| <dd><code>targetCollection</code> - the Collection to append to for all elements in this <code>RichIterable</code> that cause <code>Predicate#accept(Object)</code> method to evaluate to false</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>targetCollection</code>, which contains appended elements as a result of the reject criteria</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#reject(org.eclipse.collections.api.block.predicate.Predicate)"><code>reject(Predicate)</code></a>, |
| <a href="#reject(org.eclipse.collections.api.block.predicate.Predicate,R)"><code>reject(Predicate, Collection)</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/PartitionIterable.html" title="interface in org.eclipse.collections.api.partition">PartitionIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</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="simpleTagLabel">Since:</span></dt> |
| <dd>1.0.</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/PartitionIterable.html" title="interface in org.eclipse.collections.api.partition">PartitionIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</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="simpleTagLabel">Since:</span></dt> |
| <dd>5.0.</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="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</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">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="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collect(org.eclipse.collections.api.block.function.Function)">collect</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V></span> <span class="returnType"><a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><V></span> <span class="memberName">collect</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</span></div> |
| <div class="block">Returns a new collection with the results of applying the specified function on each element of the source |
| collection. This method is also commonly called transform or map. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| RichIterable<String> names = |
| people.collect(person -> person.getFirstName() + " " + person.getLastName()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| RichIterable<String> names = |
| people.collect(new Function<Person, String>() |
| { |
| public String valueOf(Person person) |
| { |
| return person.getFirstName() + " " + person.getLastName(); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collect(org.eclipse.collections.api.block.function.Function,java.util.Collection)"> |
| <!-- --> |
| </a><a id="collect(org.eclipse.collections.api.block.function.Function,R)">collect</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V,​ |
| R extends <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">Collection</a><V>></span> <span class="returnType">R</span> <span class="memberName">collect</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function, |
| R target)</span></div> |
| <div class="block">Same as <a href="#collect(org.eclipse.collections.api.block.function.Function)"><code>collect(Function)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| MutableList<String> names = |
| people.collect(person -> person.getFirstName() + " " + person.getLastName(), Lists.mutable.empty()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| MutableList<String> names = |
| people.collect(new Function<Person, String>() |
| { |
| public String valueOf(Person person) |
| { |
| return person.getFirstName() + " " + person.getLastName(); |
| } |
| }, Lists.mutable.empty()); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - a <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to use as the collect transformation function</dd> |
| <dd><code>target</code> - the Collection to append to for all elements in this <code>RichIterable</code> that meet select criteria <code>function</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which contains appended elements as a result of the collect transformation</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#collect(org.eclipse.collections.api.block.function.Function)"><code>collect(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectBoolean(org.eclipse.collections.api.block.function.primitive.BooleanFunction)">collectBoolean</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="BooleanIterable.html" title="interface in org.eclipse.collections.api">BooleanIterable</a></span> <span class="memberName">collectBoolean</span>​(<span class="arguments"><a href="block/function/primitive/BooleanFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">BooleanFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> booleanFunction)</span></div> |
| <div class="block">Returns a new primitive <code>boolean</code> iterable with the results of applying the specified function on each element |
| of the source collection. This method is also commonly called transform or map. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| BooleanIterable licenses = |
| people.collectBoolean(person -> person.hasDrivingLicense()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| BooleanIterable licenses = |
| people.collectBoolean(new BooleanFunction<Person>() |
| { |
| public boolean booleanValueOf(Person person) |
| { |
| return person.hasDrivingLicense(); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectBoolean(org.eclipse.collections.api.block.function.primitive.BooleanFunction,org.eclipse.collections.api.collection.primitive.MutableBooleanCollection)"> |
| <!-- --> |
| </a><a id="collectBoolean(org.eclipse.collections.api.block.function.primitive.BooleanFunction,R)">collectBoolean</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><R extends <a href="collection/primitive/MutableBooleanCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableBooleanCollection</a>></span> <span class="returnType">R</span> <span class="memberName">collectBoolean</span>​(<span class="arguments"><a href="block/function/primitive/BooleanFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">BooleanFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> booleanFunction, |
| R target)</span></div> |
| <div class="block">Same as <a href="#collectBoolean(org.eclipse.collections.api.block.function.primitive.BooleanFunction)"><code>collectBoolean(BooleanFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| BooleanArrayList licenses = |
| people.collectBoolean(person -> person.hasDrivingLicense(), new BooleanArrayList()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| BooleanArrayList licenses = |
| people.collectBoolean(new BooleanFunction<Person>() |
| { |
| public boolean booleanValueOf(Person person) |
| { |
| return person.hasDrivingLicense(); |
| } |
| }, new BooleanArrayList()); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>booleanFunction</code> - a <a href="block/function/primitive/BooleanFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive"><code>BooleanFunction</code></a> to use as the collect transformation function</dd> |
| <dd><code>target</code> - the MutableBooleanCollection to append to for all elements in this <code>RichIterable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which contains appended elements as a result of the collect transformation</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectByte(org.eclipse.collections.api.block.function.primitive.ByteFunction)">collectByte</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="ByteIterable.html" title="interface in org.eclipse.collections.api">ByteIterable</a></span> <span class="memberName">collectByte</span>​(<span class="arguments"><a href="block/function/primitive/ByteFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">ByteFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> byteFunction)</span></div> |
| <div class="block">Returns a new primitive <code>byte</code> iterable with the results of applying the specified function on each element |
| of the source collection. This method is also commonly called transform or map. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| ByteIterable bytes = |
| people.collectByte(person -> person.getCode()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| ByteIterable bytes = |
| people.collectByte(new ByteFunction<Person>() |
| { |
| public byte byteValueOf(Person person) |
| { |
| return person.getCode(); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectByte(org.eclipse.collections.api.block.function.primitive.ByteFunction,org.eclipse.collections.api.collection.primitive.MutableByteCollection)"> |
| <!-- --> |
| </a><a id="collectByte(org.eclipse.collections.api.block.function.primitive.ByteFunction,R)">collectByte</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><R extends <a href="collection/primitive/MutableByteCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableByteCollection</a>></span> <span class="returnType">R</span> <span class="memberName">collectByte</span>​(<span class="arguments"><a href="block/function/primitive/ByteFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">ByteFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> byteFunction, |
| R target)</span></div> |
| <div class="block">Same as <a href="#collectByte(org.eclipse.collections.api.block.function.primitive.ByteFunction)"><code>collectByte(ByteFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| ByteArrayList bytes = |
| people.collectByte(person -> person.getCode(), new ByteArrayList()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| ByteArrayList bytes = |
| people.collectByte(new ByteFunction<Person>() |
| { |
| public byte byteValueOf(Person person) |
| { |
| return person.getCode(); |
| } |
| }, new ByteArrayList()); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>byteFunction</code> - a <a href="block/function/primitive/ByteFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive"><code>ByteFunction</code></a> to use as the collect transformation function</dd> |
| <dd><code>target</code> - the MutableByteCollection to append to for all elements in this <code>RichIterable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which contains appended elements as a result of the collect transformation</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectChar(org.eclipse.collections.api.block.function.primitive.CharFunction)">collectChar</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="CharIterable.html" title="interface in org.eclipse.collections.api">CharIterable</a></span> <span class="memberName">collectChar</span>​(<span class="arguments"><a href="block/function/primitive/CharFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">CharFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> charFunction)</span></div> |
| <div class="block">Returns a new primitive <code>char</code> iterable with the results of applying the specified function on each element |
| of the source collection. This method is also commonly called transform or map. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| CharIterable chars = |
| people.collectChar(person -> person.getMiddleInitial()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| CharIterable chars = |
| people.collectChar(new CharFunction<Person>() |
| { |
| public char charValueOf(Person person) |
| { |
| return person.getMiddleInitial(); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectChar(org.eclipse.collections.api.block.function.primitive.CharFunction,org.eclipse.collections.api.collection.primitive.MutableCharCollection)"> |
| <!-- --> |
| </a><a id="collectChar(org.eclipse.collections.api.block.function.primitive.CharFunction,R)">collectChar</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><R extends <a href="collection/primitive/MutableCharCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableCharCollection</a>></span> <span class="returnType">R</span> <span class="memberName">collectChar</span>​(<span class="arguments"><a href="block/function/primitive/CharFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">CharFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> charFunction, |
| R target)</span></div> |
| <div class="block">Same as <a href="#collectChar(org.eclipse.collections.api.block.function.primitive.CharFunction)"><code>collectChar(CharFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| CharArrayList chars = |
| people.collectChar(person -> person.getMiddleInitial(), new CharArrayList()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| CharArrayList chars = |
| people.collectChar(new CharFunction<Person>() |
| { |
| public char charValueOf(Person person) |
| { |
| return person.getMiddleInitial(); |
| } |
| }, new CharArrayList()); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>charFunction</code> - a <a href="block/function/primitive/CharFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive"><code>CharFunction</code></a> to use as the collect transformation function</dd> |
| <dd><code>target</code> - the MutableCharCollection to append to for all elements in this <code>RichIterable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which contains appended elements as a result of the collect transformation</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction)">collectDouble</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="DoubleIterable.html" title="interface in org.eclipse.collections.api">DoubleIterable</a></span> <span class="memberName">collectDouble</span>​(<span class="arguments"><a href="block/function/primitive/DoubleFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">DoubleFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> doubleFunction)</span></div> |
| <div class="block">Returns a new primitive <code>double</code> iterable with the results of applying the specified function on each element |
| of the source collection. This method is also commonly called transform or map. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| DoubleIterable doubles = |
| people.collectDouble(person -> person.getMilesFromNorthPole()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| DoubleIterable doubles = |
| people.collectDouble(new DoubleFunction<Person>() |
| { |
| public double doubleValueOf(Person person) |
| { |
| return person.getMilesFromNorthPole(); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction,org.eclipse.collections.api.collection.primitive.MutableDoubleCollection)"> |
| <!-- --> |
| </a><a id="collectDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction,R)">collectDouble</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><R extends <a href="collection/primitive/MutableDoubleCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableDoubleCollection</a>></span> <span class="returnType">R</span> <span class="memberName">collectDouble</span>​(<span class="arguments"><a href="block/function/primitive/DoubleFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">DoubleFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> doubleFunction, |
| R target)</span></div> |
| <div class="block">Same as <a href="#collectDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction)"><code>collectDouble(DoubleFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| DoubleArrayList doubles = |
| people.collectDouble(person -> person.getMilesFromNorthPole(), new DoubleArrayList()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| DoubleArrayList doubles = |
| people.collectDouble(new DoubleFunction<Person>() |
| { |
| public double doubleValueOf(Person person) |
| { |
| return person.getMilesFromNorthPole(); |
| } |
| }, new DoubleArrayList()); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>doubleFunction</code> - a <a href="block/function/primitive/DoubleFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive"><code>DoubleFunction</code></a> to use as the collect transformation function</dd> |
| <dd><code>target</code> - the MutableDoubleCollection to append to for all elements in this <code>RichIterable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which contains appended elements as a result of the collect transformation</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction)">collectFloat</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="FloatIterable.html" title="interface in org.eclipse.collections.api">FloatIterable</a></span> <span class="memberName">collectFloat</span>​(<span class="arguments"><a href="block/function/primitive/FloatFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">FloatFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> floatFunction)</span></div> |
| <div class="block">Returns a new primitive <code>float</code> iterable with the results of applying the specified function on each element |
| of the source collection. This method is also commonly called transform or map. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| FloatIterable floats = |
| people.collectFloat(person -> person.getHeightInInches()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| FloatIterable floats = |
| people.collectFloat(new FloatFunction<Person>() |
| { |
| public float floatValueOf(Person person) |
| { |
| return person.getHeightInInches(); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction,org.eclipse.collections.api.collection.primitive.MutableFloatCollection)"> |
| <!-- --> |
| </a><a id="collectFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction,R)">collectFloat</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><R extends <a href="collection/primitive/MutableFloatCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableFloatCollection</a>></span> <span class="returnType">R</span> <span class="memberName">collectFloat</span>​(<span class="arguments"><a href="block/function/primitive/FloatFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">FloatFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> floatFunction, |
| R target)</span></div> |
| <div class="block">Same as <a href="#collectFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction)"><code>collectFloat(FloatFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| FloatArrayList floats = |
| people.collectFloat(person -> person.getHeightInInches(), new FloatArrayList()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| FloatArrayList floats = |
| people.collectFloat(new FloatFunction<Person>() |
| { |
| public float floatValueOf(Person person) |
| { |
| return person.getHeightInInches(); |
| } |
| }, new FloatArrayList()); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>floatFunction</code> - a <a href="block/function/primitive/FloatFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive"><code>FloatFunction</code></a> to use as the collect transformation function</dd> |
| <dd><code>target</code> - the MutableFloatCollection to append to for all elements in this <code>RichIterable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which contains appended elements as a result of the collect transformation</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectInt(org.eclipse.collections.api.block.function.primitive.IntFunction)">collectInt</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="IntIterable.html" title="interface in org.eclipse.collections.api">IntIterable</a></span> <span class="memberName">collectInt</span>​(<span class="arguments"><a href="block/function/primitive/IntFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">IntFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> intFunction)</span></div> |
| <div class="block">Returns a new primitive <code>int</code> iterable with the results of applying the specified function on each element |
| of the source collection. This method is also commonly called transform or map. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| IntIterable ints = |
| people.collectInt(person -> person.getAge()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| IntIterable ints = |
| people.collectInt(new IntFunction<Person>() |
| { |
| public int intValueOf(Person person) |
| { |
| return person.getAge(); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectInt(org.eclipse.collections.api.block.function.primitive.IntFunction,org.eclipse.collections.api.collection.primitive.MutableIntCollection)"> |
| <!-- --> |
| </a><a id="collectInt(org.eclipse.collections.api.block.function.primitive.IntFunction,R)">collectInt</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><R extends <a href="collection/primitive/MutableIntCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableIntCollection</a>></span> <span class="returnType">R</span> <span class="memberName">collectInt</span>​(<span class="arguments"><a href="block/function/primitive/IntFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">IntFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> intFunction, |
| R target)</span></div> |
| <div class="block">Same as <a href="#collectInt(org.eclipse.collections.api.block.function.primitive.IntFunction)"><code>collectInt(IntFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| IntArrayList ints = |
| people.collectInt(person -> person.getAge(), new IntArrayList()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| IntArrayList ints = |
| people.collectInt(new IntFunction<Person>() |
| { |
| public int intValueOf(Person person) |
| { |
| return person.getAge(); |
| } |
| }, new IntArrayList()); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>intFunction</code> - a <a href="block/function/primitive/IntFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive"><code>IntFunction</code></a> to use as the collect transformation function</dd> |
| <dd><code>target</code> - the MutableIntCollection to append to for all elements in this <code>RichIterable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which contains appended elements as a result of the collect transformation</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectLong(org.eclipse.collections.api.block.function.primitive.LongFunction)">collectLong</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="LongIterable.html" title="interface in org.eclipse.collections.api">LongIterable</a></span> <span class="memberName">collectLong</span>​(<span class="arguments"><a href="block/function/primitive/LongFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">LongFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> longFunction)</span></div> |
| <div class="block">Returns a new primitive <code>long</code> iterable with the results of applying the specified function on each element |
| of the source collection. This method is also commonly called transform or map. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| LongIterable longs = |
| people.collectLong(person -> person.getGuid()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| LongIterable longs = |
| people.collectLong(new LongFunction<Person>() |
| { |
| public long longValueOf(Person person) |
| { |
| return person.getGuid(); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectLong(org.eclipse.collections.api.block.function.primitive.LongFunction,org.eclipse.collections.api.collection.primitive.MutableLongCollection)"> |
| <!-- --> |
| </a><a id="collectLong(org.eclipse.collections.api.block.function.primitive.LongFunction,R)">collectLong</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><R extends <a href="collection/primitive/MutableLongCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableLongCollection</a>></span> <span class="returnType">R</span> <span class="memberName">collectLong</span>​(<span class="arguments"><a href="block/function/primitive/LongFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">LongFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> longFunction, |
| R target)</span></div> |
| <div class="block">Same as <a href="#collectLong(org.eclipse.collections.api.block.function.primitive.LongFunction)"><code>collectLong(LongFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| LongArrayList longs = |
| people.collectLong(person -> person.getGuid(), new LongArrayList()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| LongArrayList longs = |
| people.collectLong(new LongFunction<Person>() |
| { |
| public long longValueOf(Person person) |
| { |
| return person.getGuid(); |
| } |
| }, new LongArrayList()); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>longFunction</code> - a <a href="block/function/primitive/LongFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive"><code>LongFunction</code></a> to use as the collect transformation function</dd> |
| <dd><code>target</code> - the MutableLongCollection to append to for all elements in this <code>RichIterable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which contains appended elements as a result of the collect transformation</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectShort(org.eclipse.collections.api.block.function.primitive.ShortFunction)">collectShort</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="ShortIterable.html" title="interface in org.eclipse.collections.api">ShortIterable</a></span> <span class="memberName">collectShort</span>​(<span class="arguments"><a href="block/function/primitive/ShortFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">ShortFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> shortFunction)</span></div> |
| <div class="block">Returns a new primitive <code>short</code> iterable with the results of applying the specified function on each element |
| of the source collection. This method is also commonly called transform or map. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| ShortIterable shorts = |
| people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| ShortIterable shorts = |
| people.collectShort(new ShortFunction<Person>() |
| { |
| public short shortValueOf(Person person) |
| { |
| return person.getNumberOfJunkMailItemsReceivedPerMonth(); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectShort(org.eclipse.collections.api.block.function.primitive.ShortFunction,org.eclipse.collections.api.collection.primitive.MutableShortCollection)"> |
| <!-- --> |
| </a><a id="collectShort(org.eclipse.collections.api.block.function.primitive.ShortFunction,R)">collectShort</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><R extends <a href="collection/primitive/MutableShortCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableShortCollection</a>></span> <span class="returnType">R</span> <span class="memberName">collectShort</span>​(<span class="arguments"><a href="block/function/primitive/ShortFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">ShortFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> shortFunction, |
| R target)</span></div> |
| <div class="block">Same as <a href="#collectShort(org.eclipse.collections.api.block.function.primitive.ShortFunction)"><code>collectShort(ShortFunction)</code></a>, except that the results are gathered into the specified <code>target</code> |
| collection. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| ShortArrayList shorts = |
| people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth, new ShortArrayList()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| ShortArrayList shorts = |
| people.collectShort(new ShortFunction<Person>() |
| { |
| public short shortValueOf(Person person) |
| { |
| return person.getNumberOfJunkMailItemsReceivedPerMonth; |
| } |
| }, new ShortArrayList()); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shortFunction</code> - a <a href="block/function/primitive/ShortFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive"><code>ShortFunction</code></a> to use as the collect transformation function</dd> |
| <dd><code>target</code> - the MutableShortCollection to append to for all elements in this <code>RichIterable</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which contains appended elements as a result of the collect transformation</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectWith(org.eclipse.collections.api.block.function.Function2,java.lang.Object)"> |
| <!-- --> |
| </a><a id="collectWith(org.eclipse.collections.api.block.function.Function2,P)">collectWith</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P,​ |
| V></span> <span class="returnType"><a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><V></span> <span class="memberName">collectWith</span>​(<span class="arguments"><a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P,​? extends V> function, |
| P parameter)</span></div> |
| <div class="block">Same as <a href="#collect(org.eclipse.collections.api.block.function.Function)"><code>collect(Function)</code></a> with a <code>Function2</code> and specified parameter which is passed to the block. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| RichIterable<Integer> integers = |
| Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1)); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| Function2<Integer, Integer, Integer> addParameterFunction = |
| new Function2<Integer, Integer, Integer>() |
| { |
| public Integer value(Integer each, Integer parameter) |
| { |
| return each + parameter; |
| } |
| }; |
| RichIterable<Integer> integers = |
| Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1)); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - A <a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function"><code>Function2</code></a> to use as the collect transformation function</dd> |
| <dd><code>parameter</code> - A parameter to pass in for evaluation of the second argument <code>P</code> in <code>function</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A new <code>RichIterable</code> that contains the transformed elements returned by <a href="block/function/Function2.html#value(T1,T2)"><code>Function2.value(Object, Object)</code></a></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#collect(org.eclipse.collections.api.block.function.Function)"><code>collect(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectWith(org.eclipse.collections.api.block.function.Function2,java.lang.Object,java.util.Collection)"> |
| <!-- --> |
| </a><a id="collectWith(org.eclipse.collections.api.block.function.Function2,P,R)">collectWith</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P,​ |
| V,​ |
| R extends <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">Collection</a><V>></span> <span class="returnType">R</span> <span class="memberName">collectWith</span>​(<span class="arguments"><a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P,​? extends V> function, |
| P parameter, |
| R targetCollection)</span></div> |
| <div class="block">Same as collectWith but with a targetCollection parameter to gather the results. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| MutableSet<Integer> integers = |
| Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1), Sets.mutable.empty()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| Function2<Integer, Integer, Integer> addParameterFunction = |
| new Function2<Integer, Integer, Integer>() |
| { |
| public Integer value(final Integer each, final Integer parameter) |
| { |
| return each + parameter; |
| } |
| }; |
| MutableSet<Integer> integers = |
| Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1), Sets.mutable.empty()); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - a <a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function"><code>Function2</code></a> to use as the collect transformation function</dd> |
| <dd><code>parameter</code> - a parameter to pass in for evaluation of the second argument <code>P</code> in <code>function</code></dd> |
| <dd><code>targetCollection</code> - the Collection to append to for all elements in this <code>RichIterable</code> that meet select criteria <code>function</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>targetCollection</code>, which contains appended elements as a result of the collect transformation</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectIf(org.eclipse.collections.api.block.predicate.Predicate,org.eclipse.collections.api.block.function.Function)">collectIf</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V></span> <span class="returnType"><a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><V></span> <span class="memberName">collectIf</span>​(<span class="arguments"><a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</span></div> |
| <div class="block">Returns a new collection with the results of applying the specified function on each element of the source |
| collection, but only for those elements which return true upon evaluation of the predicate. This is the |
| the optimized equivalent of calling iterable.select(predicate).collect(function). |
| <p> |
| Example using a Java 8 lambda and method reference: |
| <pre> |
| RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString); |
| </pre> |
| <p> |
| Example using Predicates factory: |
| <pre> |
| RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString()); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="collectIf(org.eclipse.collections.api.block.predicate.Predicate,org.eclipse.collections.api.block.function.Function,java.util.Collection)"> |
| <!-- --> |
| </a><a id="collectIf(org.eclipse.collections.api.block.predicate.Predicate,org.eclipse.collections.api.block.function.Function,R)">collectIf</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V,​ |
| R extends <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">Collection</a><V>></span> <span class="returnType">R</span> <span class="memberName">collectIf</span>​(<span class="arguments"><a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function, |
| R target)</span></div> |
| <div class="block">Same as the collectIf method with two parameters but uses the specified target collection for the results.</div> |
| <dl> |
| <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 select criteria</dd> |
| <dd><code>function</code> - a <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to use as the collect transformation function</dd> |
| <dd><code>target</code> - the Collection to append to for all elements in this <code>RichIterable</code> that meet the collect criteria <code>predicate</code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>targetCollection</code>, which contains appended elements as a result of the collect criteria and transformation</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#collectIf(org.eclipse.collections.api.block.predicate.Predicate,org.eclipse.collections.api.block.function.Function)"><code>collectIf(Predicate, Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flatCollect(org.eclipse.collections.api.block.function.Function)">flatCollect</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V></span> <span class="returnType"><a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><V></span> <span class="memberName">flatCollect</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</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><V>> function)</span></div> |
| <div class="block"><code>flatCollect</code> is a special case of <a href="#collect(org.eclipse.collections.api.block.function.Function)"><code>collect(Function)</code></a>. With <code>collect</code>, when the <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> returns |
| a collection, the result is a collection of collections. <code>flatCollect</code> outputs a single "flattened" collection |
| instead. This method is commonly called flatMap. |
| <p> |
| Consider the following example where we have a <code>Person</code> class, and each <code>Person</code> has a list of <code>Address</code> objects. Take the following <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a>: |
| <pre> |
| Function<Person, List<Address>> addressFunction = Person::getAddresses; |
| RichIterable<Person> people = ...; |
| </pre> |
| Using <code>collect</code> returns a collection of collections of addresses. |
| <pre> |
| RichIterable<List<Address>> addresses = people.collect(addressFunction); |
| </pre> |
| Using <code>flatCollect</code> returns a single flattened list of addresses. |
| <pre> |
| RichIterable<Address> addresses = people.flatCollect(addressFunction); |
| </pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - The <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to apply</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new flattened collection produced by applying the given <code>function</code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flatCollectByte(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.collection.primitive.MutableByteCollection)"> |
| <!-- --> |
| </a><a id="flatCollectByte(org.eclipse.collections.api.block.function.Function,R)">flatCollectByte</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><R extends <a href="collection/primitive/MutableByteCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableByteCollection</a>></span> <span class="returnType">R</span> <span class="memberName">flatCollectByte</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="ByteIterable.html" title="interface in org.eclipse.collections.api">ByteIterable</a>> function, |
| R target)</span></div> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - The <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to apply</dd> |
| <dd><code>target</code> - The collection into which results should be added.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which will contain a flattened collection of results produced by applying the given <code>function</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#flatCollect(org.eclipse.collections.api.block.function.Function)"><code>flatCollect(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flatCollectChar(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.collection.primitive.MutableCharCollection)"> |
| <!-- --> |
| </a><a id="flatCollectChar(org.eclipse.collections.api.block.function.Function,R)">flatCollectChar</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><R extends <a href="collection/primitive/MutableCharCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableCharCollection</a>></span> <span class="returnType">R</span> <span class="memberName">flatCollectChar</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="CharIterable.html" title="interface in org.eclipse.collections.api">CharIterable</a>> function, |
| R target)</span></div> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - The <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to apply</dd> |
| <dd><code>target</code> - The collection into which results should be added.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which will contain a flattened collection of results produced by applying the given <code>function</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#flatCollect(org.eclipse.collections.api.block.function.Function)"><code>flatCollect(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flatCollectInt(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.collection.primitive.MutableIntCollection)"> |
| <!-- --> |
| </a><a id="flatCollectInt(org.eclipse.collections.api.block.function.Function,R)">flatCollectInt</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><R extends <a href="collection/primitive/MutableIntCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableIntCollection</a>></span> <span class="returnType">R</span> <span class="memberName">flatCollectInt</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="IntIterable.html" title="interface in org.eclipse.collections.api">IntIterable</a>> function, |
| R target)</span></div> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - The <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to apply</dd> |
| <dd><code>target</code> - The collection into which results should be added.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which will contain a flattened collection of results produced by applying the given <code>function</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#flatCollect(org.eclipse.collections.api.block.function.Function)"><code>flatCollect(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flatCollectShort(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.collection.primitive.MutableShortCollection)"> |
| <!-- --> |
| </a><a id="flatCollectShort(org.eclipse.collections.api.block.function.Function,R)">flatCollectShort</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><R extends <a href="collection/primitive/MutableShortCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableShortCollection</a>></span> <span class="returnType">R</span> <span class="memberName">flatCollectShort</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="ShortIterable.html" title="interface in org.eclipse.collections.api">ShortIterable</a>> function, |
| R target)</span></div> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - The <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to apply</dd> |
| <dd><code>target</code> - The collection into which results should be added.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which will contain a flattened collection of results produced by applying the given <code>function</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#flatCollect(org.eclipse.collections.api.block.function.Function)"><code>flatCollect(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flatCollectDouble(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.collection.primitive.MutableDoubleCollection)"> |
| <!-- --> |
| </a><a id="flatCollectDouble(org.eclipse.collections.api.block.function.Function,R)">flatCollectDouble</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><R extends <a href="collection/primitive/MutableDoubleCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableDoubleCollection</a>></span> <span class="returnType">R</span> <span class="memberName">flatCollectDouble</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="DoubleIterable.html" title="interface in org.eclipse.collections.api">DoubleIterable</a>> function, |
| R target)</span></div> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - The <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to apply</dd> |
| <dd><code>target</code> - The collection into which results should be added.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which will contain a flattened collection of results produced by applying the given <code>function</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#flatCollect(org.eclipse.collections.api.block.function.Function)"><code>flatCollect(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flatCollectFloat(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.collection.primitive.MutableFloatCollection)"> |
| <!-- --> |
| </a><a id="flatCollectFloat(org.eclipse.collections.api.block.function.Function,R)">flatCollectFloat</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><R extends <a href="collection/primitive/MutableFloatCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableFloatCollection</a>></span> <span class="returnType">R</span> <span class="memberName">flatCollectFloat</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="FloatIterable.html" title="interface in org.eclipse.collections.api">FloatIterable</a>> function, |
| R target)</span></div> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - The <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to apply</dd> |
| <dd><code>target</code> - The collection into which results should be added.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which will contain a flattened collection of results produced by applying the given <code>function</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#flatCollect(org.eclipse.collections.api.block.function.Function)"><code>flatCollect(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flatCollectLong(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.collection.primitive.MutableLongCollection)"> |
| <!-- --> |
| </a><a id="flatCollectLong(org.eclipse.collections.api.block.function.Function,R)">flatCollectLong</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><R extends <a href="collection/primitive/MutableLongCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableLongCollection</a>></span> <span class="returnType">R</span> <span class="memberName">flatCollectLong</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="LongIterable.html" title="interface in org.eclipse.collections.api">LongIterable</a>> function, |
| R target)</span></div> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - The <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to apply</dd> |
| <dd><code>target</code> - The collection into which results should be added.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which will contain a flattened collection of results produced by applying the given <code>function</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#flatCollect(org.eclipse.collections.api.block.function.Function)"><code>flatCollect(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flatCollectBoolean(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.collection.primitive.MutableBooleanCollection)"> |
| <!-- --> |
| </a><a id="flatCollectBoolean(org.eclipse.collections.api.block.function.Function,R)">flatCollectBoolean</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><R extends <a href="collection/primitive/MutableBooleanCollection.html" title="interface in org.eclipse.collections.api.collection.primitive">MutableBooleanCollection</a>></span> <span class="returnType">R</span> <span class="memberName">flatCollectBoolean</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends <a href="BooleanIterable.html" title="interface in org.eclipse.collections.api">BooleanIterable</a>> function, |
| R target)</span></div> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - The <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to apply</dd> |
| <dd><code>target</code> - The collection into which results should be added.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which will contain a flattened collection of results produced by applying the given <code>function</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#flatCollect(org.eclipse.collections.api.block.function.Function)"><code>flatCollect(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flatCollectWith(org.eclipse.collections.api.block.function.Function2,java.lang.Object)"> |
| <!-- --> |
| </a><a id="flatCollectWith(org.eclipse.collections.api.block.function.Function2,P)">flatCollectWith</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><P,​ |
| V></span> <span class="returnType"><a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><V></span> <span class="memberName">flatCollectWith</span>​(<span class="arguments"><a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P,​? 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><V>> function, |
| P parameter)</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>9.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flatCollect(org.eclipse.collections.api.block.function.Function,java.util.Collection)"> |
| <!-- --> |
| </a><a id="flatCollect(org.eclipse.collections.api.block.function.Function,R)">flatCollect</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V,​ |
| R extends <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">Collection</a><V>></span> <span class="returnType">R</span> <span class="memberName">flatCollect</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</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><V>> function, |
| R target)</span></div> |
| <div class="block">Same as flatCollect, only the results are collected into the target collection.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - The <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to apply</dd> |
| <dd><code>target</code> - The collection into which results should be added.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>target</code>, which will contain a flattened collection of results produced by applying the given <code>function</code></dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#flatCollect(org.eclipse.collections.api.block.function.Function)"><code>flatCollect(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="flatCollectWith(org.eclipse.collections.api.block.function.Function2,java.lang.Object,java.util.Collection)"> |
| <!-- --> |
| </a><a id="flatCollectWith(org.eclipse.collections.api.block.function.Function2,P,R)">flatCollectWith</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><P,​ |
| V,​ |
| R extends <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">Collection</a><V>></span> <span class="returnType">R</span> <span class="memberName">flatCollectWith</span>​(<span class="arguments"><a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P,​? 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><V>> function, |
| P parameter, |
| R target)</span></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>9.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="detect(org.eclipse.collections.api.block.predicate.Predicate)">detect</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">detect</span>​(<span class="arguments"><a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</span></div> |
| <div class="block">Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no |
| element returns true. This method is commonly called find. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| Person person = |
| people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith")); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| Person person = |
| people.detect(new Predicate<Person>() |
| { |
| public boolean accept(Person person) |
| { |
| return person.getFirstName().equals("John") && person.getLastName().equals("Smith"); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="detectWith(org.eclipse.collections.api.block.predicate.Predicate2,java.lang.Object)"> |
| <!-- --> |
| </a><a id="detectWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">detectWith</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P></span> <span class="returnType"><a href="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">detectWith</span>​(<span class="arguments"><a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</span></div> |
| <div class="block">Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none |
| evaluate to true. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| Person person = |
| people.detectWith((person, fullName) -> person.getFullName().equals(fullName), "John Smith"); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| Person person = |
| people.detectWith(new Predicate2<Person, String>() |
| { |
| public boolean accept(Person person, String fullName) |
| { |
| return person.getFullName().equals(fullName); |
| } |
| }, "John Smith"); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="detectOptional(org.eclipse.collections.api.block.predicate.Predicate)">detectOptional</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">detectOptional</span>​(<span class="arguments"><a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</span></div> |
| <div class="block">Returns the first element of the iterable for which the predicate evaluates to true as an Optional. This method is commonly called find. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| Person person = |
| people.detectOptional(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith")); |
| </pre> |
| <p></div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the element selected is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="detectWithOptional(org.eclipse.collections.api.block.predicate.Predicate2,java.lang.Object)"> |
| <!-- --> |
| </a><a id="detectWithOptional(org.eclipse.collections.api.block.predicate.Predicate2,P)">detectWithOptional</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P></span> <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">detectWithOptional</span>​(<span class="arguments"><a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</span></div> |
| <div class="block">Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| Optional<Person> person = |
| people.detectWithOptional((person, fullName) -> person.getFullName().equals(fullName), "John Smith"); |
| </pre> |
| <p></div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the element selected is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="detectIfNone(org.eclipse.collections.api.block.predicate.Predicate,org.eclipse.collections.api.block.function.Function0)">detectIfNone</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">detectIfNone</span>​(<span class="arguments"><a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate, |
| <a href="block/function/Function0.html" title="interface in org.eclipse.collections.api.block.function">Function0</a><? extends <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the first element of the iterable for which the predicate evaluates to true. If no element matches |
| the predicate, then returns the value of applying the specified function.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="detectWithIfNone(org.eclipse.collections.api.block.predicate.Predicate2,java.lang.Object,org.eclipse.collections.api.block.function.Function0)"> |
| <!-- --> |
| </a><a id="detectWithIfNone(org.eclipse.collections.api.block.predicate.Predicate2,P,org.eclipse.collections.api.block.function.Function0)">detectWithIfNone</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P></span> <span class="returnType"><a href="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">detectWithIfNone</span>​(<span class="arguments"><a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter, |
| <a href="block/function/Function0.html" title="interface in org.eclipse.collections.api.block.function">Function0</a><? extends <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or |
| returns the value of evaluating the specified function.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="count(org.eclipse.collections.api.block.predicate.Predicate)">count</a></h3> |
| <div class="memberSignature"><span class="returnType">int</span> <span class="memberName">count</span>​(<span class="arguments"><a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</span></div> |
| <div class="block">Return the total number of elements that answer true to the specified predicate. |
| <p> |
| Example using a Java 8 lambda expression: |
| <pre> |
| int count = |
| people.<b>count</b>(person -> person.getAddress().getState().getName().equals("New York")); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| int count = |
| people.<b>count</b>(new Predicate<Person>() |
| { |
| public boolean accept(Person person) |
| { |
| return person.getAddress().getState().getName().equals("New York"); |
| } |
| }); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="countWith(org.eclipse.collections.api.block.predicate.Predicate2,java.lang.Object)"> |
| <!-- --> |
| </a><a id="countWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">countWith</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P></span> <span class="returnType">int</span> <span class="memberName">countWith</span>​(<span class="arguments"><a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</span></div> |
| <div class="block">Returns the total number of elements that evaluate to true for the specified predicate. |
| |
| <pre>e.g. |
| return lastNames.<b>countWith</b>(Predicates2.equal(), "Smith"); |
| </pre></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="anySatisfy(org.eclipse.collections.api.block.predicate.Predicate)">anySatisfy</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">anySatisfy</span>​(<span class="arguments"><a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</span></div> |
| <div class="block">Returns true if the predicate evaluates to true for any element of the iterable. |
| Returns false if the iterable is empty, or if no element returned true when evaluating the predicate.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="anySatisfyWith(org.eclipse.collections.api.block.predicate.Predicate2,java.lang.Object)"> |
| <!-- --> |
| </a><a id="anySatisfyWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">anySatisfyWith</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P></span> <span class="returnType">boolean</span> <span class="memberName">anySatisfyWith</span>​(<span class="arguments"><a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</span></div> |
| <div class="block">Returns true if the predicate evaluates to true for any element of the collection, or return false. |
| Returns false if the collection is empty.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="allSatisfy(org.eclipse.collections.api.block.predicate.Predicate)">allSatisfy</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">allSatisfy</span>​(<span class="arguments"><a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</span></div> |
| <div class="block">Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty. |
| Otherwise, returns false.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="allSatisfyWith(org.eclipse.collections.api.block.predicate.Predicate2,java.lang.Object)"> |
| <!-- --> |
| </a><a id="allSatisfyWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">allSatisfyWith</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P></span> <span class="returnType">boolean</span> <span class="memberName">allSatisfyWith</span>​(<span class="arguments"><a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</span></div> |
| <div class="block">Returns true if the predicate evaluates to true for every element of the collection, or returns false.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="noneSatisfy(org.eclipse.collections.api.block.predicate.Predicate)">noneSatisfy</a></h3> |
| <div class="memberSignature"><span class="returnType">boolean</span> <span class="memberName">noneSatisfy</span>​(<span class="arguments"><a href="block/predicate/Predicate.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> predicate)</span></div> |
| <div class="block">Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. |
| Otherwise, returns false.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="noneSatisfyWith(org.eclipse.collections.api.block.predicate.Predicate2,java.lang.Object)"> |
| <!-- --> |
| </a><a id="noneSatisfyWith(org.eclipse.collections.api.block.predicate.Predicate2,P)">noneSatisfyWith</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><P></span> <span class="returnType">boolean</span> <span class="memberName">noneSatisfyWith</span>​(<span class="arguments"><a href="block/predicate/Predicate2.html" title="interface in org.eclipse.collections.api.block.predicate">Predicate2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P> predicate, |
| P parameter)</span></div> |
| <div class="block">Returns true if the predicate evaluates to false for every element of the collection, or return false. |
| Returns true if the collection is empty.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="injectInto(java.lang.Object,org.eclipse.collections.api.block.function.Function2)"> |
| <!-- --> |
| </a><a id="injectInto(IV,org.eclipse.collections.api.block.function.Function2)">injectInto</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><IV></span> <span class="returnType">IV</span> <span class="memberName">injectInto</span>​(<span class="arguments">IV injectedValue, |
| <a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super IV,​? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends IV> function)</span></div> |
| <div class="block">Returns the final result of evaluating function using each element of the iterable and the previous evaluation |
| result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current |
| item in the iterable is used as the second parameter. This method is commonly called fold or sometimes reduce.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="injectInto(int,org.eclipse.collections.api.block.function.primitive.IntObjectToIntFunction)">injectInto</a></h3> |
| <div class="memberSignature"><span class="returnType">int</span> <span class="memberName">injectInto</span>​(<span class="arguments">int injectedValue, |
| <a href="block/function/primitive/IntObjectToIntFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">IntObjectToIntFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the final int result of evaluating function using each element of the iterable and the previous evaluation |
| result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current |
| item in the iterable is used as the second parameter.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="injectInto(long,org.eclipse.collections.api.block.function.primitive.LongObjectToLongFunction)">injectInto</a></h3> |
| <div class="memberSignature"><span class="returnType">long</span> <span class="memberName">injectInto</span>​(<span class="arguments">long injectedValue, |
| <a href="block/function/primitive/LongObjectToLongFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">LongObjectToLongFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the final long result of evaluating function using each element of the iterable and the previous evaluation |
| result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current |
| item in the iterable is used as the second parameter.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="injectInto(float,org.eclipse.collections.api.block.function.primitive.FloatObjectToFloatFunction)">injectInto</a></h3> |
| <div class="memberSignature"><span class="returnType">float</span> <span class="memberName">injectInto</span>​(<span class="arguments">float injectedValue, |
| <a href="block/function/primitive/FloatObjectToFloatFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">FloatObjectToFloatFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the final float result of evaluating function using each element of the iterable and the previous evaluation |
| result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current |
| item in the iterable is used as the second parameter.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="injectInto(double,org.eclipse.collections.api.block.function.primitive.DoubleObjectToDoubleFunction)">injectInto</a></h3> |
| <div class="memberSignature"><span class="returnType">double</span> <span class="memberName">injectInto</span>​(<span class="arguments">double injectedValue, |
| <a href="block/function/primitive/DoubleObjectToDoubleFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">DoubleObjectToDoubleFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the final double result of evaluating function using each element of the iterable and the previous evaluation |
| result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current |
| item in the iterable is used as the second parameter.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="into(java.util.Collection)"> |
| <!-- --> |
| </a><a id="into(R)">into</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><R extends <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">Collection</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>>></span> <span class="returnType">R</span> <span class="memberName">into</span>​(<span class="arguments">R target)</span></div> |
| <div class="block">Adds all the elements in this iterable to the specific target Collection.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toList()">toList</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="list/MutableList.html" title="interface in org.eclipse.collections.api.list">MutableList</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">toList</span>()</div> |
| <div class="block">Converts the collection to a MutableList implementation.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSortedList()">toSortedList</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="list/MutableList.html" title="interface in org.eclipse.collections.api.list">MutableList</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">toSortedList</span>()</div> |
| <div class="block">Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSortedList(java.util.Comparator)">toSortedList</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="list/MutableList.html" title="interface in org.eclipse.collections.api.list">MutableList</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">toSortedList</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</span></div> |
| <div class="block">Converts the collection to a MutableList implementation and sorts it using the specified comparator.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSortedListBy(org.eclipse.collections.api.block.function.Function)">toSortedListBy</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>></span> |
| <span class="returnType"><a href="list/MutableList.html" title="interface in org.eclipse.collections.api.list">MutableList</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">toSortedListBy</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</span></div> |
| <div class="block">Converts the collection to a MutableList implementation and sorts it based on the natural order of the |
| attribute returned by <code>function</code>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSet()">toSet</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="set/MutableSet.html" title="interface in org.eclipse.collections.api.set">MutableSet</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">toSet</span>()</div> |
| <div class="block">Converts the collection to a MutableSet implementation.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSortedSet()">toSortedSet</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="set/sorted/MutableSortedSet.html" title="interface in org.eclipse.collections.api.set.sorted">MutableSortedSet</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">toSortedSet</span>()</div> |
| <div class="block">Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the |
| elements.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSortedSet(java.util.Comparator)">toSortedSet</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="set/sorted/MutableSortedSet.html" title="interface in org.eclipse.collections.api.set.sorted">MutableSortedSet</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">toSortedSet</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</span></div> |
| <div class="block">Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSortedSetBy(org.eclipse.collections.api.block.function.Function)">toSortedSetBy</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>></span> |
| <span class="returnType"><a href="set/sorted/MutableSortedSet.html" title="interface in org.eclipse.collections.api.set.sorted">MutableSortedSet</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">toSortedSetBy</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</span></div> |
| <div class="block">Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the |
| attribute returned by <code>function</code>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toBag()">toBag</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="bag/MutableBag.html" title="interface in org.eclipse.collections.api.bag">MutableBag</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">toBag</span>()</div> |
| <div class="block">Converts the collection to the default MutableBag implementation.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSortedBag()">toSortedBag</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="bag/sorted/MutableSortedBag.html" title="interface in org.eclipse.collections.api.bag.sorted">MutableSortedBag</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">toSortedBag</span>()</div> |
| <div class="block">Converts the collection to a MutableSortedBag implementation and sorts it using the natural order of the |
| elements.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>6.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSortedBag(java.util.Comparator)">toSortedBag</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="bag/sorted/MutableSortedBag.html" title="interface in org.eclipse.collections.api.bag.sorted">MutableSortedBag</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">toSortedBag</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</span></div> |
| <div class="block">Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>6.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSortedBagBy(org.eclipse.collections.api.block.function.Function)">toSortedBagBy</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>></span> |
| <span class="returnType"><a href="bag/sorted/MutableSortedBag.html" title="interface in org.eclipse.collections.api.bag.sorted">MutableSortedBag</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">toSortedBagBy</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</span></div> |
| <div class="block">Converts the collection to a MutableSortedBag implementation and sorts it based on the natural order of the |
| attribute returned by <code>function</code>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>6.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toMap</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><NK,​ |
| NV></span> <span class="returnType"><a href="map/MutableMap.html" title="interface in org.eclipse.collections.api.map">MutableMap</a><NK,​NV></span> <span class="memberName">toMap</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NK> keyFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NV> valueFunction)</span></div> |
| <div class="block">Converts the collection to a MutableMap implementation using the specified key and value functions.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function,java.util.Map)"> |
| <!-- --> |
| </a><a id="toMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function,R)">toMap</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><NK,​ |
| NV,​ |
| R extends <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><NK,​ |
| NV>></span> <span class="returnType">R</span> <span class="memberName">toMap</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NK> keyFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NV> valueFunction, |
| R target)</span></div> |
| <div class="block">Same as <a href="#toMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)"><code>toMap(Function, Function)</code></a>, except that the results are gathered into the specified <code>target</code> |
| map.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>10.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSortedMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toSortedMap</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><NK,​ |
| NV></span> <span class="returnType"><a href="map/sorted/MutableSortedMap.html" title="interface in org.eclipse.collections.api.map.sorted">MutableSortedMap</a><NK,​NV></span> <span class="memberName">toSortedMap</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NK> keyFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NV> valueFunction)</span></div> |
| <div class="block">Converts the collection to a MutableSortedMap implementation using the specified key and value functions |
| sorted by the key elements' natural ordering.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSortedMap(java.util.Comparator,org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toSortedMap</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><NK,​ |
| NV></span> <span class="returnType"><a href="map/sorted/MutableSortedMap.html" title="interface in org.eclipse.collections.api.map.sorted">MutableSortedMap</a><NK,​NV></span> <span class="memberName">toSortedMap</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super NK> comparator, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NK> keyFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NV> valueFunction)</span></div> |
| <div class="block">Converts the collection to a MutableSortedMap implementation using the specified key and value functions |
| sorted by the given comparator.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSortedMapBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toSortedMapBy</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><KK extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super KK>,​ |
| NK,​ |
| NV></span> |
| <span class="returnType"><a href="map/sorted/MutableSortedMap.html" title="interface in org.eclipse.collections.api.map.sorted">MutableSortedMap</a><NK,​NV></span> <span class="memberName">toSortedMapBy</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super NK,​KK> sortBy, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NK> keyFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NV> valueFunction)</span></div> |
| <div class="block">Converts the collection to a MutableSortedMap implementation using the specified key and value functions |
| and sorts it based on the natural order of the attribute returned by <code>sortBy</code> function.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toBiMap(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function)">toBiMap</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><NK,​ |
| NV></span> <span class="returnType"><a href="bimap/MutableBiMap.html" title="interface in org.eclipse.collections.api.bimap">MutableBiMap</a><NK,​NV></span> <span class="memberName">toBiMap</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NK> keyFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends NV> valueFunction)</span></div> |
| <div class="block">Converts the collection to a BiMap implementation using the specified key and value functions.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>10.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="asLazy()">asLazy</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="LazyIterable.html" title="interface in org.eclipse.collections.api">LazyIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">asLazy</span>()</div> |
| <div class="block">Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toArray()">toArray</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>[]</span> <span class="memberName">toArray</span>()</div> |
| <div class="block">Converts this iterable to an array.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true#toArray()" title="class or interface in java.util" class="externalLink"><code>Collection.toArray()</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toArray(java.lang.Object[])"> |
| <!-- --> |
| </a><a id="toArray(E[])">toArray</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><E></span> <span class="returnType">E[]</span> <span class="memberName">toArray</span>​(<span class="arguments">E[] array)</span></div> |
| <div class="block">Converts this iterable to an array using the specified target array, assuming the target array is as long |
| or longer than the iterable.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true#toArray(T%5B%5D)" title="class or interface in java.util" class="externalLink"><code>Collection.toArray(Object[])</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="min(java.util.Comparator)">min</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">min</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</span></div> |
| <div class="block">Returns the minimum element out of this container based on the comparator.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util" class="externalLink">NoSuchElementException</a></code> - if the RichIterable is empty</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="max(java.util.Comparator)">max</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">max</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</span></div> |
| <div class="block">Returns the maximum element out of this container based on the comparator.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util" class="externalLink">NoSuchElementException</a></code> - if the RichIterable is empty</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="minOptional(java.util.Comparator)">minOptional</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">minOptional</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</span></div> |
| <div class="block">Returns the minimum element out of this container based on the comparator as an Optional. |
| If the container is empty <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true#empty()" title="class or interface in java.util" class="externalLink"><code>Optional.empty()</code></a> is returned.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the minimum element is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="maxOptional(java.util.Comparator)">maxOptional</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">maxOptional</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> comparator)</span></div> |
| <div class="block">Returns the maximum element out of this container based on the comparator as an Optional. |
| If the container is empty <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true#empty()" title="class or interface in java.util" class="externalLink"><code>Optional.empty()</code></a> is returned.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the maximum element is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="min()">min</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">min</span>()</div> |
| <div class="block">Returns the minimum element out of this container based on the natural order.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the elements are not <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Comparable</code></a></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util" class="externalLink">NoSuchElementException</a></code> - if the RichIterable is empty</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="max()">max</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">max</span>()</div> |
| <div class="block">Returns the maximum element out of this container based on the natural order.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the elements are not <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Comparable</code></a></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util" class="externalLink">NoSuchElementException</a></code> - if the RichIterable is empty</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="minOptional()">minOptional</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">minOptional</span>()</div> |
| <div class="block">Returns the minimum element out of this container based on the natural order as an Optional. |
| If the container is empty <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true#empty()" title="class or interface in java.util" class="externalLink"><code>Optional.empty()</code></a> is returned.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the elements are not <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Comparable</code></a></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the minimum element is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="maxOptional()">maxOptional</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">maxOptional</span>()</div> |
| <div class="block">Returns the maximum element out of this container based on the natural order as an Optional. |
| If the container is empty <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true#empty()" title="class or interface in java.util" class="externalLink"><code>Optional.empty()</code></a> is returned.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the elements are not <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Comparable</code></a></dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the maximum element is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="minBy(org.eclipse.collections.api.block.function.Function)">minBy</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>></span> <span class="returnType"><a href="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">minBy</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</span></div> |
| <div class="block">Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util" class="externalLink">NoSuchElementException</a></code> - if the RichIterable is empty</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="maxBy(org.eclipse.collections.api.block.function.Function)">maxBy</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>></span> <span class="returnType"><a href="RichIterable.html" title="type parameter in RichIterable">T</a></span> <span class="memberName">maxBy</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</span></div> |
| <div class="block">Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util" class="externalLink">NoSuchElementException</a></code> - if the RichIterable is empty</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="minByOptional(org.eclipse.collections.api.block.function.Function)">minByOptional</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>></span> |
| <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">minByOptional</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</span></div> |
| <div class="block">Returns the minimum elements out of this container based on the natural order of the attribute returned by Function as an Optional. |
| If the container is empty <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true#empty()" title="class or interface in java.util" class="externalLink"><code>Optional.empty()</code></a> is returned.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the minimum element is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="maxByOptional(org.eclipse.collections.api.block.function.Function)">maxByOptional</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><V extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><? super V>></span> |
| <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">maxByOptional</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</span></div> |
| <div class="block">Returns the maximum elements out of this container based on the natural order of the attribute returned by Function as an Optional. |
| If the container is empty <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true#empty()" title="class or interface in java.util" class="externalLink"><code>Optional.empty()</code></a> is returned.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the maximum element is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.2</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sumOfInt(org.eclipse.collections.api.block.function.primitive.IntFunction)">sumOfInt</a></h3> |
| <div class="memberSignature"><span class="returnType">long</span> <span class="memberName">sumOfInt</span>​(<span class="arguments"><a href="block/function/primitive/IntFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">IntFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the final long result of evaluating function for each element of the iterable and adding the results |
| together.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sumOfFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction)">sumOfFloat</a></h3> |
| <div class="memberSignature"><span class="returnType">double</span> <span class="memberName">sumOfFloat</span>​(<span class="arguments"><a href="block/function/primitive/FloatFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">FloatFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the final double result of evaluating function for each element of the iterable and adding the results |
| together. It uses Kahan summation algorithm to reduce numerical error.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sumOfLong(org.eclipse.collections.api.block.function.primitive.LongFunction)">sumOfLong</a></h3> |
| <div class="memberSignature"><span class="returnType">long</span> <span class="memberName">sumOfLong</span>​(<span class="arguments"><a href="block/function/primitive/LongFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">LongFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the final long result of evaluating function for each element of the iterable and adding the results |
| together.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sumOfDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction)">sumOfDouble</a></h3> |
| <div class="memberSignature"><span class="returnType">double</span> <span class="memberName">sumOfDouble</span>​(<span class="arguments"><a href="block/function/primitive/DoubleFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">DoubleFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the final double result of evaluating function for each element of the iterable and adding the results |
| together. It uses Kahan summation algorithm to reduce numerical error.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="summarizeInt(org.eclipse.collections.api.block.function.primitive.IntFunction)">summarizeInt</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/IntSummaryStatistics.html?is-external=true" title="class or interface in java.util" class="externalLink">IntSummaryStatistics</a></span> <span class="memberName">summarizeInt</span>​(<span class="arguments"><a href="block/function/primitive/IntFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">IntFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the result of summarizing the value returned from applying the IntFunction to |
| each element of the iterable. |
| |
| <pre> |
| IntSummaryStatistics stats = |
| Lists.mutable.with(1, 2, 3).summarizeInt(Integer::intValue); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="summarizeFloat(org.eclipse.collections.api.block.function.primitive.FloatFunction)">summarizeFloat</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/DoubleSummaryStatistics.html?is-external=true" title="class or interface in java.util" class="externalLink">DoubleSummaryStatistics</a></span> <span class="memberName">summarizeFloat</span>​(<span class="arguments"><a href="block/function/primitive/FloatFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">FloatFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the result of summarizing the value returned from applying the FloatFunction to |
| each element of the iterable. |
| |
| <pre> |
| DoubleSummaryStatistics stats = |
| Lists.mutable.with(1, 2, 3).summarizeFloat(Integer::floatValue); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="summarizeLong(org.eclipse.collections.api.block.function.primitive.LongFunction)">summarizeLong</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/LongSummaryStatistics.html?is-external=true" title="class or interface in java.util" class="externalLink">LongSummaryStatistics</a></span> <span class="memberName">summarizeLong</span>​(<span class="arguments"><a href="block/function/primitive/LongFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">LongFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the result of summarizing the value returned from applying the LongFunction to |
| each element of the iterable. |
| |
| <pre> |
| LongSummaryStatistics stats = |
| Lists.mutable.with(1, 2, 3).summarizeLong(Integer::longValue); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="summarizeDouble(org.eclipse.collections.api.block.function.primitive.DoubleFunction)">summarizeDouble</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/DoubleSummaryStatistics.html?is-external=true" title="class or interface in java.util" class="externalLink">DoubleSummaryStatistics</a></span> <span class="memberName">summarizeDouble</span>​(<span class="arguments"><a href="block/function/primitive/DoubleFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">DoubleFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Returns the result of summarizing the value returned from applying the DoubleFunction to |
| each element of the iterable. |
| |
| <pre> |
| DoubleSummaryStatistics stats = |
| Lists.mutable.with(1, 2, 3).summarizeDouble(Integer::doubleValue); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="reduceInPlace(java.util.stream.Collector)">reduceInPlace</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><R,​ |
| A></span> <span class="returnType">R</span> <span class="memberName">reduceInPlace</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Collector.html?is-external=true" title="class or interface in java.util.stream" class="externalLink">Collector</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​A,​R> collector)</span></div> |
| <div class="block">This method produces the equivalent result as <a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true#collect(java.util.stream.Collector)" title="class or interface in java.util.stream" class="externalLink"><code>Stream.collect(Collector)</code></a>. |
| |
| <pre> |
| MutableObjectLongMap<Integer> map2 = |
| Lists.mutable.with(1, 2, 3, 4, 5).reduceInPlace(Collectors2.sumByInt(i -> Integer.valueOf(i % 2), Integer::intValue)); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="reduceInPlace(java.util.function.Supplier,java.util.function.BiConsumer)">reduceInPlace</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><R></span> <span class="returnType">R</span> <span class="memberName">reduceInPlace</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Supplier</a><R> supplier, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/BiConsumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BiConsumer</a><R,​? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> accumulator)</span></div> |
| <div class="block">This method produces the equivalent result as <a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true#collect(java.util.function.Supplier,java.util.function.BiConsumer,java.util.function.BiConsumer)" title="class or interface in java.util.stream" class="externalLink"><code>Stream.collect(Supplier, BiConsumer, BiConsumer)</code></a>. |
| The combiner used in collect is unnecessary in the serial case, so is not included in the API.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="reduce(java.util.function.BinaryOperator)">reduce</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util" class="externalLink">Optional</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>></span> <span class="memberName">reduce</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/BinaryOperator.html?is-external=true" title="class or interface in java.util.function" class="externalLink">BinaryOperator</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>> accumulator)</span></div> |
| <div class="block">This method produces the equivalent result as <a href="https://docs.oracle.com/javase/8/docs/api/java/util/stream/Stream.html?is-external=true#reduce(java.util.function.BinaryOperator)" title="class or interface in java.util.stream" class="externalLink"><code>Stream.reduce(BinaryOperator)</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>8.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sumByInt(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.primitive.IntFunction)">sumByInt</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V></span> <span class="returnType"><a href="map/primitive/ObjectLongMap.html" title="interface in org.eclipse.collections.api.map.primitive">ObjectLongMap</a><V></span> <span class="memberName">sumByInt</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> groupBy, |
| <a href="block/function/primitive/IntFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">IntFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Groups and sums the values using the two specified functions.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>6.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sumByFloat(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.primitive.FloatFunction)">sumByFloat</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V></span> <span class="returnType"><a href="map/primitive/ObjectDoubleMap.html" title="interface in org.eclipse.collections.api.map.primitive">ObjectDoubleMap</a><V></span> <span class="memberName">sumByFloat</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> groupBy, |
| <a href="block/function/primitive/FloatFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">FloatFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Groups and sums the values using the two specified functions.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>6.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sumByLong(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.primitive.LongFunction)">sumByLong</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V></span> <span class="returnType"><a href="map/primitive/ObjectLongMap.html" title="interface in org.eclipse.collections.api.map.primitive">ObjectLongMap</a><V></span> <span class="memberName">sumByLong</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> groupBy, |
| <a href="block/function/primitive/LongFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">LongFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Groups and sums the values using the two specified functions.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>6.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sumByDouble(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.primitive.DoubleFunction)">sumByDouble</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V></span> <span class="returnType"><a href="map/primitive/ObjectDoubleMap.html" title="interface in org.eclipse.collections.api.map.primitive">ObjectDoubleMap</a><V></span> <span class="memberName">sumByDouble</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> groupBy, |
| <a href="block/function/primitive/DoubleFunction.html" title="interface in org.eclipse.collections.api.block.function.primitive">DoubleFunction</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> function)</span></div> |
| <div class="block">Groups and sums the values using the two specified functions.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>6.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="makeString()">makeString</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">makeString</span>()</div> |
| <div class="block">Returns a string representation of this collection by delegating to <a href="#makeString(java.lang.String)"><code>makeString(String)</code></a> and defaulting |
| the separator parameter to the characters <code>", "</code> (comma and space).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string representation of this collection.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="makeString(java.lang.String)">makeString</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">makeString</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> separator)</span></div> |
| <div class="block">Returns a string representation of this collection by delegating to <a href="#makeString(java.lang.String,java.lang.String,java.lang.String)"><code>makeString(String, String, String)</code></a> |
| and defaulting the start and end parameters to <code>""</code> (the empty String).</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string representation of this collection.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="makeString(java.lang.String,java.lang.String,java.lang.String)">makeString</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">makeString</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> start, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> separator, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> end)</span></div> |
| <div class="block">Returns a string representation of this collection with the elements separated by the specified |
| separator and enclosed between the start and end strings.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string representation of this collection.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="appendString(java.lang.Appendable)">appendString</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType">void</span> <span class="memberName">appendString</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a> appendable)</span></div> |
| <div class="block">Prints a string representation of this collection onto the given <code>Appendable</code>. Prints the string returned |
| by <a href="#makeString()"><code>makeString()</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="appendString(java.lang.Appendable,java.lang.String)">appendString</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="returnType">void</span> <span class="memberName">appendString</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a> appendable, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> separator)</span></div> |
| <div class="block">Prints a string representation of this collection onto the given <code>Appendable</code>. Prints the string returned |
| by <a href="#makeString(java.lang.String)"><code>makeString(String)</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="appendString(java.lang.Appendable,java.lang.String,java.lang.String,java.lang.String)">appendString</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">appendString</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Appendable</a> appendable, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> start, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> separator, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> end)</span></div> |
| <div class="block">Prints a string representation of this collection onto the given <code>Appendable</code>. Prints the string returned |
| by <a href="#makeString(java.lang.String,java.lang.String,java.lang.String)"><code>makeString(String, String, String)</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</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"><V></span> <span class="returnType"><a href="multimap/Multimap.html" title="interface in org.eclipse.collections.api.multimap">Multimap</a><V,​<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</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="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="countBy(org.eclipse.collections.api.block.function.Function)">countBy</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><V></span> <span class="returnType"><a href="bag/Bag.html" title="interface in org.eclipse.collections.api.bag">Bag</a><V></span> <span class="memberName">countBy</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</span></div> |
| <div class="block">This method will count the number of occurrences of each value calculated by applying the |
| function to each element of the collection.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>9.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="countBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.bag.MutableBagIterable)"> |
| <!-- --> |
| </a><a id="countBy(org.eclipse.collections.api.block.function.Function,R)">countBy</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><V,​ |
| R extends <a href="bag/MutableBagIterable.html" title="interface in org.eclipse.collections.api.bag">MutableBagIterable</a><V>></span> <span class="returnType">R</span> <span class="memberName">countBy</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function, |
| R target)</span></div> |
| <div class="block">This method will count the number of occurrences of each value calculated by applying the |
| function to each element of the collection.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>9.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="countByWith(org.eclipse.collections.api.block.function.Function2,java.lang.Object)"> |
| <!-- --> |
| </a><a id="countByWith(org.eclipse.collections.api.block.function.Function2,P)">countByWith</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><V,​ |
| P></span> <span class="returnType"><a href="bag/Bag.html" title="interface in org.eclipse.collections.api.bag">Bag</a><V></span> <span class="memberName">countByWith</span>​(<span class="arguments"><a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P,​? extends V> function, |
| P parameter)</span></div> |
| <div class="block">This method will count the number of occurrences of each value calculated by applying the |
| function to each element of the collection with the specified parameter as the second argument.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>9.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="countByWith(org.eclipse.collections.api.block.function.Function2,java.lang.Object,org.eclipse.collections.api.bag.MutableBagIterable)"> |
| <!-- --> |
| </a><a id="countByWith(org.eclipse.collections.api.block.function.Function2,P,R)">countByWith</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><V,​ |
| P,​ |
| R extends <a href="bag/MutableBagIterable.html" title="interface in org.eclipse.collections.api.bag">MutableBagIterable</a><V>></span> <span class="returnType">R</span> <span class="memberName">countByWith</span>​(<span class="arguments"><a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? super P,​? extends V> function, |
| P parameter, |
| R target)</span></div> |
| <div class="block">This method will count the number of occurrences of each value calculated by applying the |
| function to each element of the collection with the specified parameter as the second argument.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>9.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="countByEach(org.eclipse.collections.api.block.function.Function)">countByEach</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><V></span> <span class="returnType"><a href="bag/Bag.html" title="interface in org.eclipse.collections.api.bag">Bag</a><V></span> <span class="memberName">countByEach</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</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><V>> function)</span></div> |
| <div class="block">This method will count the number of occurrences of each value calculated by applying the |
| function to each element of the collection.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>10.0.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="countByEach(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.bag.MutableBagIterable)"> |
| <!-- --> |
| </a><a id="countByEach(org.eclipse.collections.api.block.function.Function,R)">countByEach</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><V,​ |
| R extends <a href="bag/MutableBagIterable.html" title="interface in org.eclipse.collections.api.bag">MutableBagIterable</a><V>></span> <span class="returnType">R</span> <span class="memberName">countByEach</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</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><V>> function, |
| R target)</span></div> |
| <div class="block">This method will count the number of occurrences of each value calculated by applying the |
| function to each element of the collection.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>10.0.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="groupBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.multimap.MutableMultimap)"> |
| <!-- --> |
| </a><a id="groupBy(org.eclipse.collections.api.block.function.Function,R)">groupBy</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V,​ |
| R extends <a href="multimap/MutableMultimap.html" title="interface in org.eclipse.collections.api.multimap">MutableMultimap</a><V,​ |
| <a href="RichIterable.html" title="type parameter in RichIterable">T</a>>></span> <span class="returnType">R</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="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function, |
| R target)</span></div> |
| <div class="block">Same as <a href="#groupBy(org.eclipse.collections.api.block.function.Function)"><code>groupBy(Function)</code></a>, except that the results are gathered into the specified <code>target</code> |
| multimap. |
| <p> |
| Example using a Java 8 method reference: |
| <pre> |
| FastListMultimap<String, Person> peopleByLastName = |
| people.groupBy(Person::getLastName, new FastListMultimap<String, Person>()); |
| </pre> |
| <p> |
| Example using an anonymous inner class: |
| <pre> |
| FastListMultimap<String, Person> peopleByLastName = |
| people.groupBy(new Function<Person, String>() |
| { |
| public String valueOf(Person person) |
| { |
| return person.getLastName(); |
| } |
| }, new FastListMultimap<String, Person>()); |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</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"><V></span> <span class="returnType"><a href="multimap/Multimap.html" title="interface in org.eclipse.collections.api.multimap">Multimap</a><V,​<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</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><V>> function)</span></div> |
| <div class="block">Similar to <a href="#groupBy(org.eclipse.collections.api.block.function.Function)"><code>groupBy(Function)</code></a>, except the result of evaluating function will return a collection of keys |
| for each value.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="groupByEach(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.multimap.MutableMultimap)"> |
| <!-- --> |
| </a><a id="groupByEach(org.eclipse.collections.api.block.function.Function,R)">groupByEach</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V,​ |
| R extends <a href="multimap/MutableMultimap.html" title="interface in org.eclipse.collections.api.multimap">MutableMultimap</a><V,​ |
| <a href="RichIterable.html" title="type parameter in RichIterable">T</a>>></span> <span class="returnType">R</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="RichIterable.html" title="type parameter in RichIterable">T</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><V>> function, |
| R target)</span></div> |
| <div class="block">Same as <a href="#groupByEach(org.eclipse.collections.api.block.function.Function)"><code>groupByEach(Function)</code></a>, except that the results are gathered into the specified <code>target</code> |
| multimap.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</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"><V></span> <span class="returnType"><a href="map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><V,​<a href="RichIterable.html" title="type parameter in RichIterable">T</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="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function)</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="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the keys returned by the function are not unique</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>5.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#groupBy(org.eclipse.collections.api.block.function.Function)"><code>groupBy(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="groupByUniqueKey(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.map.MutableMapIterable)"> |
| <!-- --> |
| </a><a id="groupByUniqueKey(org.eclipse.collections.api.block.function.Function,R)">groupByUniqueKey</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><V,​ |
| R extends <a href="map/MutableMapIterable.html" title="interface in org.eclipse.collections.api.map">MutableMapIterable</a><V,​ |
| <a href="RichIterable.html" title="type parameter in RichIterable">T</a>>></span> <span class="returnType">R</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="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> function, |
| R target)</span></div> |
| <div class="block">Same as <a href="#groupByUniqueKey(org.eclipse.collections.api.block.function.Function)"><code>groupByUniqueKey(Function)</code></a>, except that the results are gathered into the specified <code>target</code> |
| map.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></code> - if the keys returned by the function are not unique</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>6.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#groupByUniqueKey(org.eclipse.collections.api.block.function.Function)"><code>groupByUniqueKey(Function)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toString()">toString</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">toString</span>()</div> |
| <div class="block">Returns a string with the elements of this iterable separated by commas with spaces and |
| enclosed in square brackets. |
| |
| <pre> |
| Assert.assertEquals("[]", Lists.mutable.empty().toString()); |
| Assert.assertEquals("[1]", Lists.mutable.with(1).toString()); |
| Assert.assertEquals("[1, 2, 3]", Lists.mutable.with(1, 2, 3).toString()); |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string representation of this RichIterable</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/AbstractCollection.html?is-external=true#toString()" title="class or interface in java.util" class="externalLink"><code>AbstractCollection.toString()</code></a></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="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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 6.0. Use <a href="ordered/OrderedIterable.html#zip(java.lang.Iterable)"><code>OrderedIterable.zip(Iterable)</code></a> instead.</div> |
| </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="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> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="zip(java.lang.Iterable,java.util.Collection)"> |
| <!-- --> |
| </a><a id="zip(java.lang.Iterable,R)">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,​ |
| R extends <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">Collection</a><<a href="tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​ |
| S>>></span> <span class="returnType">R</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, |
| R target)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in 6.0. Use <a href="ordered/OrderedIterable.html#zip(java.lang.Iterable,R)"><code>OrderedIterable.zip(Iterable, Collection)</code></a> instead;</div> |
| </div> |
| <div class="block">Same as <a href="#zip(java.lang.Iterable)"><code>zip(Iterable)</code></a> but uses <code>target</code> for output.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</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="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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 6.0. Use <a href="ordered/OrderedIterable.html#zipWithIndex()"><code>OrderedIterable.zipWithIndex()</code></a> instead.</div> |
| </div> |
| <div class="block">Zips this <code>RichIterable</code> with its indices.</div> |
| <dl> |
| <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="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#zip(java.lang.Iterable)"><code>zip(Iterable)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="zipWithIndex(java.util.Collection)"> |
| <!-- --> |
| </a><a id="zipWithIndex(R)">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="typeParameters"><R extends <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">Collection</a><<a href="tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</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="returnType">R</span> <span class="memberName">zipWithIndex</span>​(<span class="arguments">R target)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="deprecationComment">in 6.0. Use <a href="ordered/OrderedIterable.html#zipWithIndex(R)"><code>OrderedIterable.zipWithIndex(Collection)</code></a> instead.</div> |
| </div> |
| <div class="block">Same as <a href="#zipWithIndex()"><code>zipWithIndex()</code></a> but uses <code>target</code> for output.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="chunk(int)">chunk</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="interface in org.eclipse.collections.api">RichIterable</a><<a href="RichIterable.html" title="type parameter in RichIterable">T</a>>></span> <span class="memberName">chunk</span>​(<span class="arguments">int size)</span></div> |
| <div class="block">Partitions elements in fixed size chunks.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>size</code> - the number of elements per chunk</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>RichIterable</code> containing <code>RichIterable</code>s of size <code>size</code>, except the last will be |
| truncated if the elements don't divide evenly.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="aggregateInPlaceBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function0,org.eclipse.collections.api.block.procedure.Procedure2)">aggregateInPlaceBy</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><K,​ |
| V></span> <span class="returnType"><a href="map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><K,​V></span> <span class="memberName">aggregateInPlaceBy</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends K> groupBy, |
| <a href="block/function/Function0.html" title="interface in org.eclipse.collections.api.block.function">Function0</a><? extends V> zeroValueFactory, |
| <a href="block/procedure/Procedure2.html" title="interface in org.eclipse.collections.api.block.procedure">Procedure2</a><? super V,​? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>> mutatingAggregator)</span></div> |
| <div class="block">Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. |
| Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function |
| specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="aggregateBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function0,org.eclipse.collections.api.block.function.Function2)">aggregateBy</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><K,​ |
| V></span> <span class="returnType"><a href="map/MapIterable.html" title="interface in org.eclipse.collections.api.map">MapIterable</a><K,​V></span> <span class="memberName">aggregateBy</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends K> groupBy, |
| <a href="block/function/Function0.html" title="interface in org.eclipse.collections.api.block.function">Function0</a><? extends V> zeroValueFactory, |
| <a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super V,​? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> nonMutatingAggregator)</span></div> |
| <div class="block">Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. |
| Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function |
| specifies the initial "zero" aggregate value to work with (i.e. Integer.valueOf(0)).</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="aggregateBy(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function0,org.eclipse.collections.api.block.function.Function2,org.eclipse.collections.api.map.MutableMapIterable)"> |
| <!-- --> |
| </a><a id="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></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><K,​ |
| V,​ |
| R extends <a href="map/MutableMapIterable.html" title="interface in org.eclipse.collections.api.map">MutableMapIterable</a><K,​ |
| V>></span> <span class="returnType">R</span> <span class="memberName">aggregateBy</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends K> groupBy, |
| <a href="block/function/Function0.html" title="interface in org.eclipse.collections.api.block.function">Function0</a><? extends V> zeroValueFactory, |
| <a href="block/function/Function2.html" title="interface in org.eclipse.collections.api.block.function">Function2</a><? super V,​? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> nonMutatingAggregator, |
| R target)</span></div> |
| <div class="block">Applies an aggregate function over the iterable grouping results into the target map based on the specific |
| groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A |
| second function specifies the initial "zero" aggregate value to work with (i.e. Integer.valueOf(0)).</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>10.3</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="groupByAndCollect(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.multimap.MutableMultimap)"> |
| <!-- --> |
| </a><a id="groupByAndCollect(org.eclipse.collections.api.block.function.Function,org.eclipse.collections.api.block.function.Function,R)">groupByAndCollect</a></h3> |
| <div class="memberSignature"><span class="modifiers">default</span> <span class="typeParameters"><K,​ |
| V,​ |
| R extends <a href="multimap/MutableMultimap.html" title="interface in org.eclipse.collections.api.multimap">MutableMultimap</a><K,​ |
| V>></span> <span class="returnType">R</span> <span class="memberName">groupByAndCollect</span>​(<span class="arguments"><a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends K> groupByFunction, |
| <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function">Function</a><? super <a href="RichIterable.html" title="type parameter in RichIterable">T</a>,​? extends V> collectFunction, |
| R target)</span></div> |
| <div class="block">Applies a groupBy function over the iterable, followed by a collect function.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>groupByFunction</code> - a <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to use as the groupBy transformation function</dd> |
| <dd><code>collectFunction</code> - a <a href="block/function/Function.html" title="interface in org.eclipse.collections.api.block.function"><code>Function</code></a> to use as the collect transformation function</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <code>target</code> collection where the key is the transformed result from applying the groupBy function |
| and the value is the transformed result from applying the collect function.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>10.1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#groupBy(org.eclipse.collections.api.block.function.Function)"><code>groupBy(Function)</code></a>, |
| <a href="multimap/Multimap.html#collectValues(org.eclipse.collections.api.block.function.Function)"><code>Multimap.collectValues(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/RichIterable.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> |
