blob: cb19a187f0c91cd6ceb33712cd20d5fe413297ef [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_40) on Thu Jul 20 13:15:19 PDT 2017 -->
<title>WorkUnitStream (gobblin-api 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WorkUnitStream (gobblin-api 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../gobblin/source/workunit/WorkUnitBinPacker.html" title="interface in gobblin.source.workunit"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/source/workunit/WorkUnitWeighter.html" title="interface in gobblin.source.workunit"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/source/workunit/WorkUnitStream.html" target="_top">Frames</a></li>
<li><a href="WorkUnitStream.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">gobblin.source.workunit</div>
<h2 title="Interface WorkUnitStream" class="title">Interface WorkUnitStream</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../gobblin/source/workunit/BasicWorkUnitStream.html" title="class in gobblin.source.workunit">BasicWorkUnitStream</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">WorkUnitStream</span></pre>
<div class="block">A stream of <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>s, allows for working with large numbers of work units in a memory-efficient way, as
well as processing infinite streams of work units.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../gobblin/source/workunit/WorkUnitStream.html" title="interface in gobblin.source.workunit">WorkUnitStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnitStream.html#filter-com.google.common.base.Predicate-">filter</a></span>(<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Predicate.html?is-external=true" title="class or interface in com.google.common.base">Predicate</a>&lt;<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&gt;&nbsp;predicate)</code>
<div class="block">Apply a filtering function to this stream.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnitStream.html#getMaterializedWorkUnitCollection--">getMaterializedWorkUnitCollection</a></span>()</code>
<div class="block">Get a materialized collection of the <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>s in this stream.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnitStream.html#getWorkUnits--">getWorkUnits</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnitStream.html#isFiniteStream--">isFiniteStream</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnitStream.html#isSafeToMaterialize--">isSafeToMaterialize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../gobblin/source/workunit/WorkUnitStream.html" title="interface in gobblin.source.workunit">WorkUnitStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/source/workunit/WorkUnitStream.html#transform-com.google.common.base.Function-">transform</a></span>(<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Function.html?is-external=true" title="class or interface in com.google.common.base">Function</a>&lt;<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>,<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&gt;&nbsp;function)</code>
<div class="block">Apply a transformation function to this stream.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getWorkUnits--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkUnits</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&gt;&nbsp;getWorkUnits()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Iterator of <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>s.</dd>
</dl>
</li>
</ul>
<a name="isFiniteStream--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFiniteStream</h4>
<pre>boolean&nbsp;isFiniteStream()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if this <a href="../../../gobblin/source/workunit/WorkUnitStream.html" title="interface in gobblin.source.workunit"><code>WorkUnitStream</code></a> is finite.</dd>
</dl>
</li>
</ul>
<a name="transform-com.google.common.base.Function-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transform</h4>
<pre><a href="../../../gobblin/source/workunit/WorkUnitStream.html" title="interface in gobblin.source.workunit">WorkUnitStream</a>&nbsp;transform(<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Function.html?is-external=true" title="class or interface in com.google.common.base">Function</a>&lt;<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>,<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&gt;&nbsp;function)</pre>
<div class="block">Apply a transformation function to this stream.</div>
</li>
</ul>
<a name="filter-com.google.common.base.Predicate-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filter</h4>
<pre><a href="../../../gobblin/source/workunit/WorkUnitStream.html" title="interface in gobblin.source.workunit">WorkUnitStream</a>&nbsp;filter(<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Predicate.html?is-external=true" title="class or interface in com.google.common.base">Predicate</a>&lt;<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&gt;&nbsp;predicate)</pre>
<div class="block">Apply a filtering function to this stream.</div>
</li>
</ul>
<a name="isSafeToMaterialize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSafeToMaterialize</h4>
<pre>boolean&nbsp;isSafeToMaterialize()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if it is safe to call <a href="../../../gobblin/source/workunit/WorkUnitStream.html#getMaterializedWorkUnitCollection--"><code>getMaterializedWorkUnitCollection()</code></a> to get a collection of
<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>s.</dd>
</dl>
</li>
</ul>
<a name="getMaterializedWorkUnitCollection--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMaterializedWorkUnitCollection</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit">WorkUnit</a>&gt;&nbsp;getMaterializedWorkUnitCollection()</pre>
<div class="block">Get a materialized collection of the <a href="../../../gobblin/source/workunit/WorkUnit.html" title="class in gobblin.source.workunit"><code>WorkUnit</code></a>s in this stream. Note this call will fail if
<a href="../../../gobblin/source/workunit/WorkUnitStream.html#isSafeToMaterialize--"><code>isSafeToMaterialize()</code></a> is false. This method should be avoided unless strictly necessary, as it
introduces a synchronization point for all work units, removing the speed and memory-efficiency benefits.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../gobblin/source/workunit/WorkUnitBinPacker.html" title="interface in gobblin.source.workunit"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../gobblin/source/workunit/WorkUnitWeighter.html" title="interface in gobblin.source.workunit"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/source/workunit/WorkUnitStream.html" target="_top">Frames</a></li>
<li><a href="WorkUnitStream.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>