Spring/spring-batch
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Files
dd679050ee467b7f9fdd347893e23dcaff070335
spring-batch/build/api/org/springframework/batch/repeat/CompletionPolicy.html
Michael Minella 75ab909314 update
2017-03-23 10:18:33 -05:00

326 lines
15 KiB
HTML
Raw Blame History

<!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_31) on Thu Mar 23 09:54:33 CDT 2017 -->
<title>CompletionPolicy (null 4.0.0.BUILD-SNAPSHOT API)</title>
<meta name="date" content="2017-03-23">
<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="CompletionPolicy (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":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>Prev&nbsp;Class</li>
<li><a href="../../../../org/springframework/batch/repeat/RepeatCallback.html" title="interface in org.springframework.batch.repeat"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/springframework/batch/repeat/CompletionPolicy.html" target="_top">Frames</a></li>
<li><a href="CompletionPolicy.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">org.springframework.batch.repeat</div>
<h2 title="Interface CompletionPolicy" class="title">Interface CompletionPolicy</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/springframework/batch/jsr/repeat/CheckpointAlgorithmAdapter.html" title="class in org.springframework.batch.jsr.repeat">CheckpointAlgorithmAdapter</a>, <a href="../../../../org/springframework/batch/repeat/policy/CompletionPolicySupport.html" title="class in org.springframework.batch.repeat.policy">CompletionPolicySupport</a>, <a href="../../../../org/springframework/batch/repeat/policy/CompositeCompletionPolicy.html" title="class in org.springframework.batch.repeat.policy">CompositeCompletionPolicy</a>, <a href="../../../../org/springframework/batch/repeat/policy/CountingCompletionPolicy.html" title="class in org.springframework.batch.repeat.policy">CountingCompletionPolicy</a>, <a href="../../../../org/springframework/batch/repeat/policy/DefaultResultCompletionPolicy.html" title="class in org.springframework.batch.repeat.policy">DefaultResultCompletionPolicy</a>, <a href="../../../../org/springframework/batch/repeat/policy/SimpleCompletionPolicy.html" title="class in org.springframework.batch.repeat.policy">SimpleCompletionPolicy</a>, <a href="../../../../org/springframework/batch/core/resource/StepExecutionSimpleCompletionPolicy.html" title="class in org.springframework.batch.core.resource">StepExecutionSimpleCompletionPolicy</a>, <a href="../../../../org/springframework/batch/repeat/policy/TimeoutTerminationPolicy.html" title="class in org.springframework.batch.repeat.policy">TimeoutTerminationPolicy</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">CompletionPolicy</span></pre>
<div class="block">Interface for batch completion policies, to enable batch operations to
strategise normal completion conditions. Stateful implementations of batch
iterators should <em>only</em> update state using the update method. If you
need custom behaviour consider extending an existing implementation or using
the composite provided.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Dave Syer</dd>
</dl>
</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/repeat/CompletionPolicy.html#isComplete-org.springframework.batch.repeat.RepeatContext-">isComplete</a></span>(<a href="../../../../org/springframework/batch/repeat/RepeatContext.html" title="interface in org.springframework.batch.repeat">RepeatContext</a>&nbsp;context)</code>
<div class="block">Allow policy to signal completion according to internal state, without
having to wait for the callback to complete.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/repeat/CompletionPolicy.html#isComplete-org.springframework.batch.repeat.RepeatContext-org.springframework.batch.repeat.RepeatStatus-">isComplete</a></span>(<a href="../../../../org/springframework/batch/repeat/RepeatContext.html" title="interface in org.springframework.batch.repeat">RepeatContext</a>&nbsp;context,
<a href="../../../../org/springframework/batch/repeat/RepeatStatus.html" title="enum in org.springframework.batch.repeat">RepeatStatus</a>&nbsp;result)</code>
<div class="block">Determine whether a batch is complete given the latest result from the
callback.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/springframework/batch/repeat/RepeatContext.html" title="interface in org.springframework.batch.repeat">RepeatContext</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/repeat/CompletionPolicy.html#start-org.springframework.batch.repeat.RepeatContext-">start</a></span>(<a href="../../../../org/springframework/batch/repeat/RepeatContext.html" title="interface in org.springframework.batch.repeat">RepeatContext</a>&nbsp;parent)</code>
<div class="block">Create a new context for the execution of a batch.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/repeat/CompletionPolicy.html#update-org.springframework.batch.repeat.RepeatContext-">update</a></span>(<a href="../../../../org/springframework/batch/repeat/RepeatContext.html" title="interface in org.springframework.batch.repeat">RepeatContext</a>&nbsp;context)</code>
<div class="block">Give implementations the opportunity to update the state of the current
batch.</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="isComplete-org.springframework.batch.repeat.RepeatContext-org.springframework.batch.repeat.RepeatStatus-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isComplete</h4>
<pre>boolean&nbsp;isComplete(<a href="../../../../org/springframework/batch/repeat/RepeatContext.html" title="interface in org.springframework.batch.repeat">RepeatContext</a>&nbsp;context,
<a href="../../../../org/springframework/batch/repeat/RepeatStatus.html" title="enum in org.springframework.batch.repeat">RepeatStatus</a>&nbsp;result)</pre>
<div class="block">Determine whether a batch is complete given the latest result from the
callback. If this method returns true then
<a href="../../../../org/springframework/batch/repeat/CompletionPolicy.html#isComplete-org.springframework.batch.repeat.RepeatContext-"><code>isComplete(RepeatContext)</code></a> should also (but not necessarily vice
versa, since the answer here depends on the result).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the current batch context.</dd>
<dd><code>result</code> - the result of the latest batch item processing.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the batch should terminate.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/springframework/batch/repeat/CompletionPolicy.html#isComplete-org.springframework.batch.repeat.RepeatContext-"><code>isComplete(RepeatContext)</code></a></dd>
</dl>
</li>
</ul>
<a name="isComplete-org.springframework.batch.repeat.RepeatContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isComplete</h4>
<pre>boolean&nbsp;isComplete(<a href="../../../../org/springframework/batch/repeat/RepeatContext.html" title="interface in org.springframework.batch.repeat">RepeatContext</a>&nbsp;context)</pre>
<div class="block">Allow policy to signal completion according to internal state, without
having to wait for the callback to complete.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the current batch context.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the batch should terminate.</dd>
</dl>
</li>
</ul>
<a name="start-org.springframework.batch.repeat.RepeatContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre><a href="../../../../org/springframework/batch/repeat/RepeatContext.html" title="interface in org.springframework.batch.repeat">RepeatContext</a>&nbsp;start(<a href="../../../../org/springframework/batch/repeat/RepeatContext.html" title="interface in org.springframework.batch.repeat">RepeatContext</a>&nbsp;parent)</pre>
<div class="block">Create a new context for the execution of a batch. N.B. implementations
should <em>not</em> return the parent from this method - they must
create a new context to meet the specific needs of the policy. The best
way to do this might be to override an existing implementation and use
the <a href="../../../../org/springframework/batch/repeat/RepeatContext.html" title="interface in org.springframework.batch.repeat"><code>RepeatContext</code></a> to store state in its attributes.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - the current context if one is already in progress.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a context object that can be used by the implementation to store
internal state for a batch.</dd>
</dl>
</li>
</ul>
<a name="update-org.springframework.batch.repeat.RepeatContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>update</h4>
<pre>void&nbsp;update(<a href="../../../../org/springframework/batch/repeat/RepeatContext.html" title="interface in org.springframework.batch.repeat">RepeatContext</a>&nbsp;context)</pre>
<div class="block">Give implementations the opportunity to update the state of the current
batch. Will be called <em>once</em> per callback, after it has been
launched, but not necessarily after it completes (if the batch is
asynchronous).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - the value returned by start.</dd>
</dl>
</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>Prev&nbsp;Class</li>
<li><a href="../../../../org/springframework/batch/repeat/RepeatCallback.html" title="interface in org.springframework.batch.repeat"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/springframework/batch/repeat/CompletionPolicy.html" target="_top">Frames</a></li>
<li><a href="CompletionPolicy.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>
Reference in New Issue View Git Blame Copy Permalink