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

295 lines
19 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:35 CDT 2017 -->
<title>ItemStream (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="ItemStream (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":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="../../../../org/springframework/batch/item/ItemReaderException.html" title="class in org.springframework.batch.item"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/springframework/batch/item/ItemStreamException.html" title="class in org.springframework.batch.item"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/springframework/batch/item/ItemStream.html" target="_top">Frames</a></li>
<li><a href="ItemStream.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.item</div>
<h2 title="Interface ItemStream" class="title">Interface ItemStream</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item">ItemStreamReader</a>&lt;T&gt;, <a href="../../../../org/springframework/batch/item/ItemStreamWriter.html" title="interface in org.springframework.batch.item">ItemStreamWriter</a>&lt;T&gt;, <a href="../../../../org/springframework/batch/item/file/ResourceAwareItemReaderItemStream.html" title="interface in org.springframework.batch.item.file">ResourceAwareItemReaderItemStream</a>&lt;T&gt;, <a href="../../../../org/springframework/batch/item/file/ResourceAwareItemWriterItemStream.html" title="interface in org.springframework.batch.item.file">ResourceAwareItemWriterItemStream</a>&lt;T&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/springframework/batch/item/database/AbstractCursorItemReader.html" title="class in org.springframework.batch.item.database">AbstractCursorItemReader</a>, <a href="../../../../org/springframework/batch/item/support/AbstractItemCountingItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemCountingItemStreamItemReader</a>, <a href="../../../../org/springframework/batch/item/support/AbstractItemStreamItemReader.html" title="class in org.springframework.batch.item.support">AbstractItemStreamItemReader</a>, <a href="../../../../org/springframework/batch/item/support/AbstractItemStreamItemWriter.html" title="class in org.springframework.batch.item.support">AbstractItemStreamItemWriter</a>, <a href="../../../../org/springframework/batch/item/data/AbstractNeo4jItemReader.html" title="class in org.springframework.batch.item.data">AbstractNeo4jItemReader</a>, <a href="../../../../org/springframework/batch/item/data/AbstractPaginatedDataItemReader.html" title="class in org.springframework.batch.item.data">AbstractPaginatedDataItemReader</a>, <a href="../../../../org/springframework/batch/item/database/AbstractPagingItemReader.html" title="class in org.springframework.batch.item.database">AbstractPagingItemReader</a>, <a href="../../../../org/springframework/batch/integration/async/AsyncItemWriter.html" title="class in org.springframework.batch.integration.async">AsyncItemWriter</a>, <a href="../../../../org/springframework/batch/jsr/item/CheckpointSupport.html" title="class in org.springframework.batch.jsr.item">CheckpointSupport</a>, <a href="../../../../org/springframework/batch/integration/chunk/ChunkMessageChannelItemWriter.html" title="class in org.springframework.batch.integration.chunk">ChunkMessageChannelItemWriter</a>, <a href="../../../../org/springframework/batch/core/step/item/ChunkMonitor.html" title="class in org.springframework.batch.core.step.item">ChunkMonitor</a>, <a href="../../../../org/springframework/batch/item/support/CompositeItemStream.html" title="class in org.springframework.batch.item.support">CompositeItemStream</a>, <a href="../../../../org/springframework/batch/item/support/CompositeItemWriter.html" title="class in org.springframework.batch.item.support">CompositeItemWriter</a>, <a href="../../../../org/springframework/batch/item/file/FlatFileItemReader.html" title="class in org.springframework.batch.item.file">FlatFileItemReader</a>, <a href="../../../../org/springframework/batch/item/file/FlatFileItemWriter.html" title="class in org.springframework.batch.item.file">FlatFileItemWriter</a>, <a href="../../../../org/springframework/batch/item/database/HibernateCursorItemReader.html" title="class in org.springframework.batch.item.database">HibernateCursorItemReader</a>, <a href="../../../../org/springframework/batch/item/database/HibernatePagingItemReader.html" title="class in org.springframework.batch.item.database">HibernatePagingItemReader</a>, <a href="../../../../org/springframework/batch/item/database/IbatisPagingItemReader.html" title="class in org.springframework.batch.item.database">IbatisPagingItemReader</a>, <a href="../../../../org/springframework/batch/jsr/item/ItemReaderAdapter.html" title="class in org.springframework.batch.jsr.item">ItemReaderAdapter</a>, <a href="../../../../org/springframework/batch/item/ItemStreamSupport.html" title="class in org.springframework.batch.item">ItemStreamSupport</a>, <a href="../../../../org/springframework/batch/jsr/item/ItemWriterAdapter.html" title="class in org.springframework.batch.jsr.item">ItemWriterAdapter</a>, <a href="../../../../org/springframework/batch/item/database/JdbcCursorItemReader.html" title="class in org.springframework.batch.item.database">JdbcCursorItemReader</a>, <a href="../../../../org/springframework/batch/item/database/JdbcPagingItemReader.html" title="class in org.springframework.batch.item.database">JdbcPagingItemReader</a>, <a href="../../../../org/springframework/batch/item/database/JpaPagingItemReader.html" title="class in org.springframework.batch.item.database">JpaPagingItemReader</a>, <a href="../../../../org/springframework/batch/item/ldif/LdifReader.html" title="class in org.springframework.batch.item.ldif">LdifReader</a>, <a href="../../../../org/springframework/batch/item/ldif/MappingLdifReader.html" title="class in org.springframework.batch.item.ldif">MappingLdifReader</a>, <a href="../../../../org/springframework/batch/item/data/MongoItemReader.html" title="class in org.springframework.batch.item.data">MongoItemReader</a>, <a href="../../../../org/springframework/batch/item/file/MultiResourceItemReader.html" title="class in org.springframework.batch.item.file">MultiResourceItemReader</a>, <a href="../../../../org/springframework/batch/item/file/MultiResourceItemWriter.html" title="class in org.springframework.batch.item.file">MultiResourceItemWriter</a>, <a href="../../../../org/springframework/batch/item/data/Neo4jItemReader.html" title="class in org.springframework.batch.item.data">Neo4jItemReader</a>, <a href="../../../../org/springframework/batch/item/data/RepositoryItemReader.html" title="class in org.springframework.batch.item.data">RepositoryItemReader</a>, <a href="../../../../org/springframework/batch/item/file/ResourcesItemReader.html" title="class in org.springframework.batch.item.file">ResourcesItemReader</a>, <a href="../../../../org/springframework/batch/item/support/SingleItemPeekableItemReader.html" title="class in org.springframework.batch.item.support">SingleItemPeekableItemReader</a>, <a href="../../../../org/springframework/batch/item/xml/StaxEventItemReader.html" title="class in org.springframework.batch.item.xml">StaxEventItemReader</a>, <a href="../../../../org/springframework/batch/item/xml/StaxEventItemWriter.html" title="class in org.springframework.batch.item.xml">StaxEventItemWriter</a>, <a href="../../../../org/springframework/batch/item/database/StoredProcedureItemReader.html" title="class in org.springframework.batch.item.database">StoredProcedureItemReader</a>, <a href="../../../../org/springframework/batch/item/support/SynchronizedItemStreamReader.html" title="class in org.springframework.batch.item.support">SynchronizedItemStreamReader</a>, <a href="../../../../org/springframework/batch/sample/domain/trade/internal/TradeWriter.html" title="class in org.springframework.batch.sample.domain.trade.internal">TradeWriter</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ItemStream</span></pre>
<div class="block"><p>
Marker interface defining a contract for periodically storing state and restoring from that state should an error
occur.
<p></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Dave Syer, Lucas Ward</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/item/ItemStream.html#close--">close</a></span>()</code>
<div class="block">If any resources are needed for the stream to operate they need to be destroyed here.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/item/ItemStream.html#open-org.springframework.batch.item.ExecutionContext-">open</a></span>(<a href="../../../../org/springframework/batch/item/ExecutionContext.html" title="class in org.springframework.batch.item">ExecutionContext</a>&nbsp;executionContext)</code>
<div class="block">Open the stream for the provided <a href="../../../../org/springframework/batch/item/ExecutionContext.html" title="class in org.springframework.batch.item"><code>ExecutionContext</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/springframework/batch/item/ItemStream.html#update-org.springframework.batch.item.ExecutionContext-">update</a></span>(<a href="../../../../org/springframework/batch/item/ExecutionContext.html" title="class in org.springframework.batch.item">ExecutionContext</a>&nbsp;executionContext)</code>
<div class="block">Indicates that the execution context provided during open is about to be saved.</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="open-org.springframework.batch.item.ExecutionContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>void&nbsp;open(<a href="../../../../org/springframework/batch/item/ExecutionContext.html" title="class in org.springframework.batch.item">ExecutionContext</a>&nbsp;executionContext)
throws <a href="../../../../org/springframework/batch/item/ItemStreamException.html" title="class in org.springframework.batch.item">ItemStreamException</a></pre>
<div class="block">Open the stream for the provided <a href="../../../../org/springframework/batch/item/ExecutionContext.html" title="class in org.springframework.batch.item"><code>ExecutionContext</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>executionContext</code> - current step's <a href="../../../../org/springframework/batch/item/ExecutionContext.html" title="class in org.springframework.batch.item"><code>ExecutionContext</code></a>. Will be the
executionContext from the last run of the step on a restart.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if context is null</dd>
<dd><code><a href="../../../../org/springframework/batch/item/ItemStreamException.html" title="class in org.springframework.batch.item">ItemStreamException</a></code></dd>
</dl>
</li>
</ul>
<a name="update-org.springframework.batch.item.ExecutionContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>void&nbsp;update(<a href="../../../../org/springframework/batch/item/ExecutionContext.html" title="class in org.springframework.batch.item">ExecutionContext</a>&nbsp;executionContext)
throws <a href="../../../../org/springframework/batch/item/ItemStreamException.html" title="class in org.springframework.batch.item">ItemStreamException</a></pre>
<div class="block">Indicates that the execution context provided during open is about to be saved. If any state is remaining, but
has not been put in the context, it should be added here.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>executionContext</code> - to be updated</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if executionContext is null.</dd>
<dd><code><a href="../../../../org/springframework/batch/item/ItemStreamException.html" title="class in org.springframework.batch.item">ItemStreamException</a></code></dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close()
throws <a href="../../../../org/springframework/batch/item/ItemStreamException.html" title="class in org.springframework.batch.item">ItemStreamException</a></pre>
<div class="block">If any resources are needed for the stream to operate they need to be destroyed here. Once this method has been
called all other methods (except open) may throw an exception.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/springframework/batch/item/ItemStreamException.html" title="class in org.springframework.batch.item">ItemStreamException</a></code></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><a href="../../../../org/springframework/batch/item/ItemReaderException.html" title="class in org.springframework.batch.item"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/springframework/batch/item/ItemStreamException.html" title="class in org.springframework.batch.item"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/springframework/batch/item/ItemStream.html" target="_top">Frames</a></li>
<li><a href="ItemStream.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