| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.2) on Sat Aug 08 22:45:01 CDT 2020 --> |
| <title>Tuples (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.impl.tuple, class: Tuples"> |
| <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":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/Tuples.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.impl.tuple</a></div> |
| <h1 title="Class Tuples" class="title">Class Tuples</h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a> |
| <div class="inheritance">org.eclipse.collections.impl.tuple.Tuples</div> |
| </div> |
| <section class="description"> |
| <hr> |
| <pre>public final class <span class="typeNameLabel">Tuples</span> |
| extends <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></pre> |
| <div class="block">A Pair is a container that holds two related objects. It is the equivalent of an Association in Smalltalk, or an |
| implementation of Map.Entry in the JDK. A Twin is a Pair with the same types. This class is a factory class |
| for Pairs and Twins. |
| |
| A Triple is a container that holds three related objects. Similar to Haskell a Tuple is container that can contain 2 or more objects. |
| The Triple is the implementation of the 3-tuple. A Triplet is a Triple with the same types. This class holds factory methods for Triples and Triplets |
| |
| The equivalent class for primitive and object combinations is <a href="primitive/PrimitiveTuples.html" title="class in org.eclipse.collections.impl.tuple.primitive"><code>PrimitiveTuples</code></a></div> |
| </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="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete 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>static <T> <a href="../../api/tuple/Triplet.html" title="interface in org.eclipse.collections.api.tuple">Triplet</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#identicalTriplet(T)">identicalTriplet</a></span>​(T each)</code></th> |
| <td class="colLast"> |
| <div class="block">This method returns a <a href="../../api/tuple/Triplet.html" title="interface in org.eclipse.collections.api.tuple"><code>Triplet</code></a> where the three elements in the <a href="../../api/tuple/Triplet.html" title="interface in org.eclipse.collections.api.tuple"><code>Triplet</code></a> are the same as the input element.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>static <T> <a href="../../api/tuple/Twin.html" title="interface in org.eclipse.collections.api.tuple">Twin</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#identicalTwin(T)">identicalTwin</a></span>​(T each)</code></th> |
| <td class="colLast"> |
| <div class="block">This method returns a <a href="../../api/tuple/Twin.html" title="interface in org.eclipse.collections.api.tuple"><code>Twin</code></a> where both elements in the <a href="../../api/tuple/Twin.html" title="interface in org.eclipse.collections.api.tuple"><code>Twin</code></a> are the same as the input element.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>static <T1,​ |
| T2> <a href="../../api/tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><T1,​T2></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pair(T1,T2)">pair</a></span>​(T1 one, |
| T2 two)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>static <K,​ |
| V> <a href="../../api/tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><K,​V></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pairFrom(java.util.Map.Entry)">pairFrom</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util" class="externalLink">Map.Entry</a><K,​V> entry)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>static <T1,​ |
| T2,​ |
| T3> <a href="../../api/tuple/Triple.html" title="interface in org.eclipse.collections.api.tuple">Triple</a><T1,​T2,​T3></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#triple(T1,T2,T3)">triple</a></span>​(T1 one, |
| T2 two, |
| T3 three)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>static <T> <a href="../../api/tuple/Triplet.html" title="interface in org.eclipse.collections.api.tuple">Triplet</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#triplet(T,T,T)">triplet</a></span>​(T one, |
| T two, |
| T three)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>static <T> <a href="../../api/tuple/Twin.html" title="interface in org.eclipse.collections.api.tuple">Twin</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#twin(T,T)">twin</a></span>​(T one, |
| T two)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<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></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <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>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</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="pairFrom(java.util.Map.Entry)">pairFrom</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="typeParameters"><K,​ |
| V></span> <span class="returnType"><a href="../../api/tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><K,​V></span> <span class="memberName">pairFrom</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util" class="externalLink">Map.Entry</a><K,​V> entry)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="pair(java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a><a id="pair(T1,T2)">pair</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="typeParameters"><T1,​ |
| T2></span> <span class="returnType"><a href="../../api/tuple/Pair.html" title="interface in org.eclipse.collections.api.tuple">Pair</a><T1,​T2></span> <span class="memberName">pair</span>​(<span class="arguments">T1 one, |
| T2 two)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="twin(java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a><a id="twin(T,T)">twin</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="typeParameters"><T></span> <span class="returnType"><a href="../../api/tuple/Twin.html" title="interface in org.eclipse.collections.api.tuple">Twin</a><T></span> <span class="memberName">twin</span>​(<span class="arguments">T one, |
| T two)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="identicalTwin(java.lang.Object)"> |
| <!-- --> |
| </a><a id="identicalTwin(T)">identicalTwin</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="typeParameters"><T></span> <span class="returnType"><a href="../../api/tuple/Twin.html" title="interface in org.eclipse.collections.api.tuple">Twin</a><T></span> <span class="memberName">identicalTwin</span>​(<span class="arguments">T each)</span></div> |
| <div class="block">This method returns a <a href="../../api/tuple/Twin.html" title="interface in org.eclipse.collections.api.tuple"><code>Twin</code></a> where both elements in the <a href="../../api/tuple/Twin.html" title="interface in org.eclipse.collections.api.tuple"><code>Twin</code></a> are the same as the input element.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="triple(java.lang.Object,java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a><a id="triple(T1,T2,T3)">triple</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="typeParameters"><T1,​ |
| T2,​ |
| T3></span> <span class="returnType"><a href="../../api/tuple/Triple.html" title="interface in org.eclipse.collections.api.tuple">Triple</a><T1,​T2,​T3></span> <span class="memberName">triple</span>​(<span class="arguments">T1 one, |
| T2 two, |
| T3 three)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="triplet(java.lang.Object,java.lang.Object,java.lang.Object)"> |
| <!-- --> |
| </a><a id="triplet(T,T,T)">triplet</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="typeParameters"><T></span> <span class="returnType"><a href="../../api/tuple/Triplet.html" title="interface in org.eclipse.collections.api.tuple">Triplet</a><T></span> <span class="memberName">triplet</span>​(<span class="arguments">T one, |
| T two, |
| T three)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="identicalTriplet(java.lang.Object)"> |
| <!-- --> |
| </a><a id="identicalTriplet(T)">identicalTriplet</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="typeParameters"><T></span> <span class="returnType"><a href="../../api/tuple/Triplet.html" title="interface in org.eclipse.collections.api.tuple">Triplet</a><T></span> <span class="memberName">identicalTriplet</span>​(<span class="arguments">T each)</span></div> |
| <div class="block">This method returns a <a href="../../api/tuple/Triplet.html" title="interface in org.eclipse.collections.api.tuple"><code>Triplet</code></a> where the three elements in the <a href="../../api/tuple/Triplet.html" title="interface in org.eclipse.collections.api.tuple"><code>Triplet</code></a> are the same as the input element.</div> |
| </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/Tuples.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> |