blob: bfd47fe5c177d616fc7beb7c89a4da0ca055e7b8 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Linq4j (Apache Calcite calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.calcite.linq4j, class: Linq4j">
<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,"i7":9,"i8":9,"i9":9,"i10":41,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":41,"i17":9,"i18":9,"i19":9,"i20":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="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 class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.linq4j</a></div>
<h1 title="Class Linq4j" class="title">Class Linq4j</h1>
</div>
<div class="contentContainer">
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/9/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.apache.calcite.linq4j.Linq4j</div>
</div>
<section class="description">
<hr>
<pre>public abstract class <span class="typeNameLabel">Linq4j</span>
extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
<div class="block">Utility and factory methods for Linq4j.</div>
</section>
<section class="summary">
<ul class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<li class="blockList">
<section class="fieldSummary"><a id="field.summary">
<!-- -->
</a>
<h2>Field Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="QueryProvider.html" title="interface in org.apache.calcite.linq4j">QueryProvider</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT_PROVIDER">DEFAULT_PROVIDER</a></span></code></th>
<td class="colLast">
<div class="block">Query provider that simply executes a <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> by calling its
enumerator method; does not attempt optimization.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;?&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#EMPTY_ENUMERABLE">EMPTY_ENUMERABLE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ========== 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><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>static &lt;T&gt;&nbsp;<a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asEnumerable(java.lang.Iterable)">asEnumerable</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;T&gt;&nbsp;iterable)</code></th>
<td class="colLast">
<div class="block">Adapter that converts an <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Iterable</code></a> into an <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>.</div>
</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asEnumerable(java.util.Collection)">asEnumerable</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;T&gt;&nbsp;collection)</code></th>
<td class="colLast">
<div class="block">Adapter that converts an <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Collection</code></a> into an <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>.</div>
</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asEnumerable(java.util.List)">asEnumerable</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;T&gt;&nbsp;list)</code></th>
<td class="colLast">
<div class="block">Adapter that converts an <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>List</code></a> into an <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>.</div>
</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asEnumerable(T%5B%5D)">asEnumerable</a></span>&#8203;(T[]&nbsp;ts)</code></th>
<td class="colLast">
<div class="block">Adapter that converts an array into an enumerable.</div>
</td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>static &lt;TSource,&#8203;
TResult&gt;<br><a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;TResult&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cast(java.lang.Iterable,java.lang.Class)">cast</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;TSource&gt;&nbsp;source,
<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;TResult&gt;&nbsp;clazz)</code></th>
<td class="colLast">
<div class="block">Converts the elements of a given Iterable to the specified type.</div>
</td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>static &lt;E&gt;&nbsp;<a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;E&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#concat(java.util.List)">concat</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;E&gt;&gt;&nbsp;enumerableList)</code></th>
<td class="colLast">
<div class="block">Concatenates two or more <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>s to form a composite
enumerable that contains the union of their elements.</div>
</td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emptyEnumerable()">emptyEnumerable</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a> that has no elements.</div>
</td>
</tr>
<tr class="rowColor" id="i7">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#emptyEnumerator()">emptyEnumerator</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an <a href="Enumerator.html" title="interface in org.apache.calcite.linq4j"><code>Enumerator</code></a> that has no elements.</div>
</td>
</tr>
<tr class="altColor" id="i8">
<td class="colFirst"><code>static &lt;V&gt;&nbsp;<a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;V&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enumerator(java.util.Collection)">enumerator</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;? extends V&gt;&nbsp;values)</code></th>
<td class="colLast">
<div class="block">Adapter that converts a collection into an enumerator.</div>
</td>
</tr>
<tr class="rowColor" id="i9">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enumeratorIterator(org.apache.calcite.linq4j.Enumerator)">enumeratorIterator</a></span>&#8203;(<a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;T&gt;&nbsp;enumerator)</code></th>
<td class="colLast">
<div class="block">Adapter that converts an enumerator into an iterator.</div>
</td>
</tr>
<tr class="altColor" id="i10">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(T,T)">equals</a></span>&#8203;(T&nbsp;t0,
T&nbsp;t1)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr class="rowColor" id="i11">
<td class="colFirst"><code>static @Nullable <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">Method</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMethod(java.lang.String,java.lang.String,java.lang.Class...)">getMethod</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;className,
<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;methodName,
<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>...&nbsp;parameterTypes)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i12">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterableEnumerator(java.lang.Iterable)">iterableEnumerator</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;? extends T&gt;&nbsp;iterable)</code></th>
<td class="colLast">
<div class="block">Adapter that converts an iterable into an enumerator.</div>
</td>
</tr>
<tr class="rowColor" id="i13">
<td class="colFirst"><code>static &lt;TSource,&#8203;
TResult&gt;<br><a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;TResult&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ofType(java.lang.Iterable,java.lang.Class)">ofType</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;TSource&gt;&nbsp;source,
<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;TResult&gt;&nbsp;clazz)</code></th>
<td class="colLast">
<div class="block">Returns elements of a given <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Iterable</code></a> that are of the specified
type.</div>
</td>
</tr>
<tr class="altColor" id="i14">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;T&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#product(java.lang.Iterable)">product</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;? extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;T&gt;&gt;&nbsp;iterables)</code></th>
<td class="colLast">
<div class="block">Returns the cartesian product of an iterable of iterables.</div>
</td>
</tr>
<tr class="rowColor" id="i15">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;T&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#product(java.util.List)">product</a></span>&#8203;(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;T&gt;&gt;&nbsp;enumerators)</code></th>
<td class="colLast">
<div class="block">Returns an enumerator that is the cartesian product of the given
enumerators.</div>
</td>
</tr>
<tr class="altColor" id="i16">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;T</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requireNonNull(T)">requireNonNull</a></span>&#8203;(T&nbsp;o)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
</td>
</tr>
<tr class="rowColor" id="i17">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#singletonEnumerable(T)">singletonEnumerable</a></span>&#8203;(T&nbsp;element)</code></th>
<td class="colLast">
<div class="block">Returns an <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a> that has one element.</div>
</td>
</tr>
<tr class="altColor" id="i18">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#singletonEnumerator(T)">singletonEnumerator</a></span>&#8203;(T&nbsp;element)</code></th>
<td class="colLast">
<div class="block">Returns an <a href="Enumerator.html" title="interface in org.apache.calcite.linq4j"><code>Enumerator</code></a> that has one element.</div>
</td>
</tr>
<tr class="rowColor" id="i19">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;<a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;T&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#singletonNullEnumerator()">singletonNullEnumerator</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an <a href="Enumerator.html" title="interface in org.apache.calcite.linq4j"><code>Enumerator</code></a> that has one null element.</div>
</td>
</tr>
<tr class="altColor" id="i20">
<td class="colFirst"><code>static &lt;F,&#8203;
E&gt;&nbsp;<a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;E&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transform(org.apache.calcite.linq4j.Enumerator,org.apache.calcite.linq4j.function.Function1)">transform</a></span>&#8203;(<a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;? extends F&gt;&nbsp;enumerator,
<a href="function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;? super F,&#8203;? extends E&gt;&nbsp;func)</code></th>
<td class="colLast">
<div class="block">Applies a function to each element of an Enumerator.</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="inheritedList">
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/9/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/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/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/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/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/9/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/9/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/9/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/9/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/9/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/9/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/9/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">
<!-- ============ FIELD DETAIL =========== -->
<li class="blockList">
<section class="fieldDetails"><a id="field.detail">
<!-- -->
</a>
<h2>Field Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="DEFAULT_PROVIDER">DEFAULT_PROVIDER</a></h3>
<div class="memberSignature"><span class="modifiers">public static final</span>&nbsp;<span class="returnType"><a href="QueryProvider.html" title="interface in org.apache.calcite.linq4j">QueryProvider</a></span>&nbsp;<span class="memberName">DEFAULT_PROVIDER</span></div>
<div class="block">Query provider that simply executes a <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> by calling its
enumerator method; does not attempt optimization.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="EMPTY_ENUMERABLE">EMPTY_ENUMERABLE</a></h3>
<div class="memberSignature"><span class="modifiers">public static final</span>&nbsp;<span class="returnType"><a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;?&gt;</span>&nbsp;<span class="memberName">EMPTY_ENUMERABLE</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ 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="getMethod(java.lang.String,java.lang.String,java.lang.Class...)">getMethod</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="returnType">@Nullable <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">Method</a></span>&nbsp;<span class="memberName">getMethod</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;className,
<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;methodName,
<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>...&nbsp;parameterTypes)</span></div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="enumeratorIterator(org.apache.calcite.linq4j.Enumerator)">enumeratorIterator</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a>&lt;T&gt;</span>&nbsp;<span class="memberName">enumeratorIterator</span>&#8203;(<span class="arguments"><a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;T&gt;&nbsp;enumerator)</span></div>
<div class="block">Adapter that converts an enumerator into an iterator.
<p><b>WARNING</b>: The iterator returned by this method does not call
<a href="Enumerator.html#close()"><code>Enumerator.close()</code></a>, so it is not safe to
use with an enumerator that allocates resources.</p></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Element type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enumerator</code> - Enumerator</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Iterator</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="iterableEnumerator(java.lang.Iterable)">iterableEnumerator</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType"><a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;T&gt;</span>&nbsp;<span class="memberName">iterableEnumerator</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;? extends T&gt;&nbsp;iterable)</span></div>
<div class="block">Adapter that converts an iterable into an enumerator.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Element type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>iterable</code> - Iterable</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>enumerator</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="asEnumerable(java.util.List)">asEnumerable</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType"><a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;T&gt;</span>&nbsp;<span class="memberName">asEnumerable</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;T&gt;&nbsp;list)</span></div>
<div class="block">Adapter that converts an <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>List</code></a> into an <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Element type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>list</code> - List</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>enumerable</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="asEnumerable(java.util.Collection)">asEnumerable</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType"><a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;T&gt;</span>&nbsp;<span class="memberName">asEnumerable</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;T&gt;&nbsp;collection)</span></div>
<div class="block">Adapter that converts an <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Collection</code></a> into an <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>.
<p>It uses more efficient implementations if the iterable happens to
be a <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>List</code></a>.</p></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Element type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>collection</code> - Collection</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>enumerable</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="asEnumerable(java.lang.Iterable)">asEnumerable</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType"><a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;T&gt;</span>&nbsp;<span class="memberName">asEnumerable</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;T&gt;&nbsp;iterable)</span></div>
<div class="block">Adapter that converts an <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Iterable</code></a> into an <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>.
<p>It uses more efficient implementations if the iterable happens to
be a <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Collection</code></a> or a <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>List</code></a>.</p></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Element type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>iterable</code> - Iterable</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>enumerable</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="asEnumerable(java.lang.Object[])">
<!-- -->
</a><a id="asEnumerable(T[])">asEnumerable</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType"><a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;T&gt;</span>&nbsp;<span class="memberName">asEnumerable</span>&#8203;(<span class="arguments">T[]&nbsp;ts)</span></div>
<div class="block">Adapter that converts an array into an enumerable.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Element type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ts</code> - Array</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>enumerable</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="enumerator(java.util.Collection)">enumerator</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;V&gt;</span>&nbsp;<span class="returnType"><a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;V&gt;</span>&nbsp;<span class="memberName">enumerator</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a>&lt;? extends V&gt;&nbsp;values)</span></div>
<div class="block">Adapter that converts a collection into an enumerator.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>V</code> - Element type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - Collection</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Enumerator over the collection</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="transform(org.apache.calcite.linq4j.Enumerator,org.apache.calcite.linq4j.function.Function1)">transform</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;F,&#8203;
E&gt;</span>&nbsp;<span class="returnType"><a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;E&gt;</span>&nbsp;<span class="memberName">transform</span>&#8203;(<span class="arguments"><a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;? extends F&gt;&nbsp;enumerator,
<a href="function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;? super F,&#8203;? extends E&gt;&nbsp;func)</span></div>
<div class="block">Applies a function to each element of an Enumerator.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>F</code> - Backing element type</dd>
<dd><code>E</code> - Element type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enumerator</code> - Backing enumerator</dd>
<dd><code>func</code> - Transform function</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Enumerator</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="cast(java.lang.Iterable,java.lang.Class)">cast</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;TSource,&#8203;
TResult&gt;</span>&nbsp;<span class="returnType"><a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;TResult&gt;</span>&nbsp;<span class="memberName">cast</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;TSource&gt;&nbsp;source,
<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;TResult&gt;&nbsp;clazz)</span></div>
<div class="block">Converts the elements of a given Iterable to the specified type.
<p>This method is implemented by using deferred execution. The immediate
return value is an object that stores all the information that is
required to perform the action. The query represented by this method is
not executed until the object is enumerated either by calling its
<a href="RawEnumerable.html#enumerator()"><code>RawEnumerable.enumerator()</code></a> method directly or by using
<code>for (... in ...)</code>.
<p>Since standard Java <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Collection</code></a> objects implement the
<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Iterable</code></a> interface, the <code>cast</code> method enables the standard
query operators to be invoked on collections
(including <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>List</code></a> and <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Set</code></a>) by supplying
the necessary type information. For example, <a href="https://docs.oracle.com/javase/9/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>ArrayList</code></a> does not
implement <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>&lt;F&gt;, but you can invoke
<blockquote><code>Linq4j.cast(list, Integer.class)</code></blockquote>
<p>to convert the list of an enumerable that can be queried using the
standard query operators.
<p>If an element cannot be cast to type &lt;TResult&gt;, this method will
throw a <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>ClassCastException</code></a>. To obtain only those elements that
can be cast to type TResult, use the <a href="#ofType(java.lang.Iterable,java.lang.Class)"><code>ofType(java.lang.Iterable&lt;TSource&gt;, java.lang.Class&lt;TResult&gt;)</code></a> method instead.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="ExtendedEnumerable.html#cast(java.lang.Class)"><code>ExtendedEnumerable.cast(Class)</code></a>,
<a href="#ofType(java.lang.Iterable,java.lang.Class)"><code>ofType(java.lang.Iterable&lt;TSource&gt;, java.lang.Class&lt;TResult&gt;)</code></a>,
<a href="#asEnumerable(java.lang.Iterable)"><code>asEnumerable(Iterable)</code></a></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="ofType(java.lang.Iterable,java.lang.Class)">ofType</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;TSource,&#8203;
TResult&gt;</span>&nbsp;<span class="returnType"><a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;TResult&gt;</span>&nbsp;<span class="memberName">ofType</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;TSource&gt;&nbsp;source,
<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;TResult&gt;&nbsp;clazz)</span></div>
<div class="block">Returns elements of a given <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Iterable</code></a> that are of the specified
type.
<p>This method is implemented by using deferred execution. The immediate
return value is an object that stores all the information that is
required to perform the action. The query represented by this method is
not executed until the object is enumerated either by calling its
<a href="RawEnumerable.html#enumerator()"><code>RawEnumerable.enumerator()</code></a> method directly or by using
<code>for (... in ...)</code>.
<p>The <code>ofType</code> method returns only those elements in source that
can be cast to type TResult. To instead receive an exception if an
element cannot be cast to type TResult, use
<a href="#cast(java.lang.Iterable,java.lang.Class)"><code>cast(Iterable, Class)</code></a>.</p>
<p>Since standard Java <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Collection</code></a> objects implement the
<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>Iterable</code></a> interface, the <code>cast</code> method enables the standard
query operators to be invoked on collections
(including <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>List</code></a> and <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Set</code></a>) by supplying
the necessary type information. For example, <a href="https://docs.oracle.com/javase/9/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>ArrayList</code></a> does not
implement <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>&lt;F&gt;, but you can invoke
<blockquote><code>Linq4j.ofType(list, Integer.class)</code></blockquote>
<p>to convert the list of an enumerable that can be queried using the
standard query operators.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="ExtendedEnumerable.html#cast(java.lang.Class)"><code>ExtendedEnumerable.cast(Class)</code></a>,
<a href="#cast(java.lang.Iterable,java.lang.Class)"><code>cast(java.lang.Iterable&lt;TSource&gt;, java.lang.Class&lt;TResult&gt;)</code></a></dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="singletonEnumerable(java.lang.Object)">
<!-- -->
</a><a id="singletonEnumerable(T)">singletonEnumerable</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType"><a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;T&gt;</span>&nbsp;<span class="memberName">singletonEnumerable</span>&#8203;(<span class="arguments">T&nbsp;element)</span></div>
<div class="block">Returns an <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a> that has one element.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Element type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Singleton enumerable</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="singletonEnumerator(java.lang.Object)">
<!-- -->
</a><a id="singletonEnumerator(T)">singletonEnumerator</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType"><a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;T&gt;</span>&nbsp;<span class="memberName">singletonEnumerator</span>&#8203;(<span class="arguments">T&nbsp;element)</span></div>
<div class="block">Returns an <a href="Enumerator.html" title="interface in org.apache.calcite.linq4j"><code>Enumerator</code></a> that has one element.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Element type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Singleton enumerator</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="singletonNullEnumerator()">singletonNullEnumerator</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType"><a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;T&gt;</span>&nbsp;<span class="memberName">singletonNullEnumerator</span>()</div>
<div class="block">Returns an <a href="Enumerator.html" title="interface in org.apache.calcite.linq4j"><code>Enumerator</code></a> that has one null element.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Element type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Singleton enumerator</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="emptyEnumerable()">emptyEnumerable</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType"><a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;T&gt;</span>&nbsp;<span class="memberName">emptyEnumerable</span>()</div>
<div class="block">Returns an <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a> that has no elements.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Element type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Empty enumerable</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="emptyEnumerator()">emptyEnumerator</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType"><a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;T&gt;</span>&nbsp;<span class="memberName">emptyEnumerator</span>()</div>
<div class="block">Returns an <a href="Enumerator.html" title="interface in org.apache.calcite.linq4j"><code>Enumerator</code></a> that has no elements.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Element type</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Empty enumerator</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="concat(java.util.List)">concat</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;E&gt;</span>&nbsp;<span class="returnType"><a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;E&gt;</span>&nbsp;<span class="memberName">concat</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="Enumerable.html" title="interface in org.apache.calcite.linq4j">Enumerable</a>&lt;E&gt;&gt;&nbsp;enumerableList)</span></div>
<div class="block">Concatenates two or more <a href="Enumerable.html" title="interface in org.apache.calcite.linq4j"><code>Enumerable</code></a>s to form a composite
enumerable that contains the union of their elements.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>E</code> - Element type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enumerableList</code> - List of enumerable objects</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Composite enumerator</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="product(java.util.List)">product</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType"><a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;T&gt;&gt;</span>&nbsp;<span class="memberName">product</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a>&lt;T&gt;&gt;&nbsp;enumerators)</span></div>
<div class="block">Returns an enumerator that is the cartesian product of the given
enumerators.
<p>For example, given enumerator A that returns {"a", "b", "c"} and
enumerator B that returns {"x", "y"}, product(List(A, B)) will return
{List("a", "x"), List("a", "y"),
List("b", "x"), List("b", "y"),
List("c", "x"), List("c", "y")}.</p>
<p>Notice that the cardinality of the result is the product of the
cardinality of the inputs. The enumerators A and B have 3 and 2
elements respectively, and the result has 3 * 2 = 6 elements.
This is always the case. In
particular, if any of the enumerators is empty, the result is empty.</p></div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Element type</dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enumerators</code> - List of enumerators</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Enumerator over the cartesian product</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="product(java.lang.Iterable)">product</a></h3>
<div class="memberSignature"><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;<a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;T&gt;&gt;</span>&nbsp;<span class="memberName">product</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;? extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a>&lt;T&gt;&gt;&nbsp;iterables)</span></div>
<div class="block">Returns the cartesian product of an iterable of iterables.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="equals(java.lang.Object,java.lang.Object)">
<!-- -->
</a><a id="equals(T,T)">equals</a></h3>
<div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
</span><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType">boolean</span>&nbsp;<span class="memberName">equals</span>&#8203;(<span class="arguments">T&nbsp;t0,
T&nbsp;t1)</span></div>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Returns whether the arguments are equal to each other.
<p>Equivalent to <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Objects.html?is-external=true#equals(java.lang.Object,java.lang.Object)" title="class or interface in java.util" class="externalLink"><code>Objects.equals(java.lang.Object, java.lang.Object)</code></a> in JDK 1.7 and above.</div>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="requireNonNull(java.lang.Object)">
<!-- -->
</a><a id="requireNonNull(T)">requireNonNull</a></h3>
<div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
</span><span class="modifiers">public static</span>&nbsp;<span class="typeParameters">&lt;T&gt;</span>&nbsp;<span class="returnType">T</span>&nbsp;<span class="memberName">requireNonNull</span>&#8203;(<span class="arguments">T&nbsp;o)</span></div>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Throws <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>NullPointerException</code></a> if argument is null, otherwise
returns argument.
<p>Equivalent to <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Objects.html?is-external=true#requireNonNull(T)" title="class or interface in java.util" class="externalLink"><code>Objects.requireNonNull(T)</code></a> in JDK 1.7 and
above.</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="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 class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &copy; 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>