|
| 1 | +<!DOCTYPE HTML> |
| 2 | +<html lang="en"> |
| 3 | +<head> |
| 4 | +<!-- Generated by javadoc (25) --> |
| 5 | +<title>Streamer (RxJava Javadoc 4.0.0-SNAPSHOT)</title> |
| 6 | +<meta name="viewport" content="width=device-width, initial-scale=1"> |
| 7 | +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
| 8 | +<meta name="description" content="declaration: package: io.reactivex.rxjava4.core, interface: Streamer"> |
| 9 | +<meta name="generator" content="javadoc/ClassWriter"> |
| 10 | +<link rel="stylesheet" type="text/css" href="../../../../resource-files/jquery-ui.min.css"> |
| 11 | +<link rel="stylesheet" type="text/css" href="../../../../resource-files/stylesheet.css"> |
| 12 | +<script type="text/javascript" src="../../../../script-files/script.js"></script> |
| 13 | +<script type="text/javascript" src="../../../../script-files/jquery-3.7.1.min.js"></script> |
| 14 | +<script type="text/javascript" src="../../../../script-files/jquery-ui.min.js"></script> |
| 15 | +</head> |
| 16 | +<body class="class-declaration-page"> |
| 17 | +<script type="text/javascript">const pathtoroot = "../../../../"; |
| 18 | +loadScripts(document, 'script');</script> |
| 19 | +<noscript> |
| 20 | +<div>JavaScript is disabled on your browser.</div> |
| 21 | +</noscript> |
| 22 | +<header role="banner"> |
| 23 | +<nav role="navigation"> |
| 24 | +<!-- ========= START OF TOP NAVBAR ======= --> |
| 25 | +<div class="top-nav" id="navbar-top"> |
| 26 | +<div class="nav-content"> |
| 27 | +<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button></div> |
| 28 | +<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| 29 | +<ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| 30 | +<li><a href="../../../../index.html">Overview</a></li> |
| 31 | +<li class="nav-bar-cell1-rev">Class</li> |
| 32 | +<li><a href="package-tree.html">Tree</a></li> |
| 33 | +<li><a href="../../../../index-all.html">Index</a></li> |
| 34 | +<li><a href="../../../../search.html">Search</a></li> |
| 35 | +<li><a href="../../../../help-doc.html#class">Help</a></li> |
| 36 | +</ul> |
| 37 | +</div> |
| 38 | +</div> |
| 39 | +<div class="sub-nav"> |
| 40 | +<div class="nav-content"> |
| 41 | +<ol class="sub-nav-list"> |
| 42 | +<li><a href="package-summary.html">io.reactivex.rxjava4.core</a></li> |
| 43 | +<li><a href="Streamer.html" class="current-selection">Streamer</a></li> |
| 44 | +</ol> |
| 45 | +<div class="nav-list-search"><input type="text" id="search-input" disabled placeholder="Search documentation (type /)" aria-label="Search in documentation" autocomplete="off" spellcheck="false"><input type="reset" id="reset-search" disabled value="Reset"></div> |
| 46 | +</div> |
| 47 | +</div> |
| 48 | +<!-- ========= END OF TOP NAVBAR ========= --> |
| 49 | +<span class="skip-nav" id="skip-navbar-top"></span></nav> |
| 50 | +</header> |
| 51 | +<div class="main-grid"> |
| 52 | +<nav role="navigation" class="toc" aria-label="Table of contents"> |
| 53 | +<div class="toc-header">Contents <input type="text" class="filter-input" disabled placeholder="Filter contents (type .)" aria-label="Filter table of contents" autocomplete="off" spellcheck="false"><input type="reset" class="reset-filter" disabled tabindex="-1" value="Reset"></div> |
| 54 | +<ol class="toc-list" tabindex="-1"> |
| 55 | +<li><a href="#" tabindex="0">Description</a></li> |
| 56 | +<li><a href="#method-summary" tabindex="0">Method Summary</a></li> |
| 57 | +<li><a href="#method-detail" tabindex="0">Method Details</a> |
| 58 | +<ol class="toc-list"> |
| 59 | +<li><a href="#next()" tabindex="0">next()</a></li> |
| 60 | +<li><a href="#current()" tabindex="0">current()</a></li> |
| 61 | +<li><a href="#cancel()" tabindex="0">cancel()</a></li> |
| 62 | +<li><a href="#close()" tabindex="0">close()</a></li> |
| 63 | +</ol> |
| 64 | +</li> |
| 65 | +</ol> |
| 66 | +<button class="hide-sidebar"><span>Hide sidebar </span><img src="../../../../resource-files/left.svg" alt="Hide sidebar"></button><button class="show-sidebar"><img src="../../../../resource-files/right.svg" alt="Show sidebar"><span> Show sidebar</span></button></nav> |
| 67 | +<main role="main"> |
| 68 | +<!-- ======== START OF CLASS DATA ======== --> |
| 69 | +<div class="header"> |
| 70 | +<h1 title="Interface Streamer" class="title">Interface Streamer<T></h1> |
| 71 | +</div> |
| 72 | +<section class="class-description" id="class-description"> |
| 73 | +<dl class="notes"> |
| 74 | +<dt>Type Parameters:</dt> |
| 75 | +<dd><span id="type-param-T"><code>T</code> - the element type. |
| 76 | +TODO proper docs</span></dd> |
| 77 | +</dl> |
| 78 | +<dl class="notes"> |
| 79 | +<dt>All Superinterfaces:</dt> |
| 80 | +<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| 81 | +</dl> |
| 82 | +<hr> |
| 83 | +<div class="horizontal-scroll"> |
| 84 | +<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Streamer<<a href="../annotations/NonNull.html" title="annotation interface in io.reactivex.rxjava4.annotations">@NonNull</a> T></span><span class="extends-implements"> |
| 85 | +extends <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></span></div> |
| 86 | +<div class="block">A realized stream which can then be consumed asynchronously in steps. |
| 87 | +Think of it as the of the Java world. Runs best on Virtual Threads.</div> |
| 88 | +<dl class="notes"> |
| 89 | +<dt>Since:</dt> |
| 90 | +<dd>4.0.0</dd> |
| 91 | +</dl> |
| 92 | +</div> |
| 93 | +</section> |
| 94 | +<section class="summary"> |
| 95 | +<ul class="summary-list"> |
| 96 | +<!-- ========== METHOD SUMMARY =========== --> |
| 97 | +<li> |
| 98 | +<section class="method-summary" id="method-summary"> |
| 99 | +<h2>Method Summary</h2> |
| 100 | +<div id="method-summary-table"> |
| 101 | +<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> |
| 102 | +<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> |
| 103 | +<div class="summary-table three-column-summary"> |
| 104 | +<div class="table-header col-first">Modifier and Type</div> |
| 105 | +<div class="table-header col-second">Method</div> |
| 106 | +<div class="table-header col-last">Description</div> |
| 107 | +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../annotations/NonNull.html" title="annotation interface in io.reactivex.rxjava4.annotations">@NonNull</a> <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/concurrent/CompletionStage.html" title="class or interface in java.util.concurrent" class="external-link">CompletionStage</a><wbr><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></code></div> |
| 108 | +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#cancel()" class="member-name-link">cancel</a>()</code></div> |
| 109 | +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| 110 | +<div class="block">Called when the stream ends or gets cancelled.</div> |
| 111 | +</div> |
| 112 | +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div> |
| 113 | +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| 114 | +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| 115 | +<div class="block">Make this Streamer a resource and a Closeable.</div> |
| 116 | +</div> |
| 117 | +<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#type-param-T" title="type parameter in Streamer">T</a></code></div> |
| 118 | +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#current()" class="member-name-link">current</a>()</code></div> |
| 119 | +<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| 120 | +<div class="block">Returns the current element if <a href="#next()"><code>next()</code></a> yielded <code>true</code>.</div> |
| 121 | +</div> |
| 122 | +<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../annotations/NonNull.html" title="annotation interface in io.reactivex.rxjava4.annotations">@NonNull</a> <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/concurrent/CompletionStage.html" title="class or interface in java.util.concurrent" class="external-link">CompletionStage</a><wbr><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></code></div> |
| 123 | +<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#next()" class="member-name-link">next</a>()</code></div> |
| 124 | +<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| 125 | +<div class="block">Determine if there are more elements available from the source.</div> |
| 126 | +</div> |
| 127 | +</div> |
| 128 | +</div> |
| 129 | +</div> |
| 130 | +</section> |
| 131 | +</li> |
| 132 | +</ul> |
| 133 | +</section> |
| 134 | +<section class="details"> |
| 135 | +<ul class="details-list"> |
| 136 | +<!-- ============ METHOD DETAIL ========== --> |
| 137 | +<li> |
| 138 | +<section class="method-details" id="method-detail"> |
| 139 | +<h2>Method Details</h2> |
| 140 | +<ul class="member-list"> |
| 141 | +<li> |
| 142 | +<section class="detail" id="next()"> |
| 143 | +<h3>next</h3> |
| 144 | +<div class="horizontal-scroll"> |
| 145 | +<div class="member-signature"><span class="annotations"><a href="../annotations/NonNull.html" title="annotation interface in io.reactivex.rxjava4.annotations">@NonNull</a> |
| 146 | +</span><span class="return-type"><a href="../annotations/NonNull.html" title="annotation interface in io.reactivex.rxjava4.annotations">@NonNull</a> <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/concurrent/CompletionStage.html" title="class or interface in java.util.concurrent" class="external-link">CompletionStage</a><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a>></span> <span class="element-name">next</span>()</div> |
| 147 | +<div class="block">Determine if there are more elements available from the source.</div> |
| 148 | +<dl class="notes"> |
| 149 | +<dt>Returns:</dt> |
| 150 | +<dd>eventually true or false, indicating availability or termination</dd> |
| 151 | +</dl> |
| 152 | +</div> |
| 153 | +</section> |
| 154 | +</li> |
| 155 | +<li> |
| 156 | +<section class="detail" id="current()"> |
| 157 | +<h3>current</h3> |
| 158 | +<div class="horizontal-scroll"> |
| 159 | +<div class="member-signature"><span class="annotations"><a href="../annotations/NonNull.html" title="annotation interface in io.reactivex.rxjava4.annotations">@NonNull</a> |
| 160 | +</span><span class="return-type"><a href="#type-param-T" title="type parameter in Streamer">T</a></span> <span class="element-name">current</span>()</div> |
| 161 | +<div class="block">Returns the current element if <a href="#next()"><code>next()</code></a> yielded <code>true</code>. |
| 162 | +Can be called multiple times between <a href="#next()"><code>next()</code></a> calls.</div> |
| 163 | +<dl class="notes"> |
| 164 | +<dt>Returns:</dt> |
| 165 | +<dd>the current element</dd> |
| 166 | +<dt>Throws:</dt> |
| 167 | +<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/NoSuchElementException.html" title="class or interface in java.util" class="external-link">NoSuchElementException</a></code> - before the very first <a href="#next()"><code>next()</code></a> or after <a href="#next()"><code>next()</code></a> returned <code>false</code></dd> |
| 168 | +</dl> |
| 169 | +</div> |
| 170 | +</section> |
| 171 | +</li> |
| 172 | +<li> |
| 173 | +<section class="detail" id="cancel()"> |
| 174 | +<h3>cancel</h3> |
| 175 | +<div class="horizontal-scroll"> |
| 176 | +<div class="member-signature"><span class="annotations"><a href="../annotations/NonNull.html" title="annotation interface in io.reactivex.rxjava4.annotations">@NonNull</a> |
| 177 | +</span><span class="return-type"><a href="../annotations/NonNull.html" title="annotation interface in io.reactivex.rxjava4.annotations">@NonNull</a> <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/concurrent/CompletionStage.html" title="class or interface in java.util.concurrent" class="external-link">CompletionStage</a><<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>></span> <span class="element-name">cancel</span>()</div> |
| 178 | +<div class="block">Called when the stream ends or gets cancelled. Should be always invoked. |
| 179 | +TODO, this is inherited from <code>IAsyncDisposable</code> in C#...</div> |
| 180 | +<dl class="notes"> |
| 181 | +<dt>Returns:</dt> |
| 182 | +<dd>the stage you can await to cleanups to happen</dd> |
| 183 | +</dl> |
| 184 | +</div> |
| 185 | +</section> |
| 186 | +</li> |
| 187 | +<li> |
| 188 | +<section class="detail" id="close()"> |
| 189 | +<h3>close</h3> |
| 190 | +<div class="horizontal-scroll"> |
| 191 | +<div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| 192 | +<div class="block">Make this Streamer a resource and a Closeable.</div> |
| 193 | +<dl class="notes"> |
| 194 | +<dt>Specified by:</dt> |
| 195 | +<dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| 196 | +</dl> |
| 197 | +</div> |
| 198 | +</section> |
| 199 | +</li> |
| 200 | +</ul> |
| 201 | +</section> |
| 202 | +</li> |
| 203 | +</ul> |
| 204 | +</section> |
| 205 | +<!-- ========= END OF CLASS DATA ========= --> |
| 206 | +</main> |
| 207 | +</div> |
| 208 | +</body> |
| 209 | +</html> |
0 commit comments