314 lines
15 KiB
HTML
314 lines
15 KiB
HTML
<!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:37 CDT 2017 -->
|
|
<title>org.springframework.batch.item (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="org.springframework.batch.item (null 4.0.0.BUILD-SNAPSHOT API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
</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 class="navBarCell1Rev">Package</li>
|
|
<li>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/integration/step/package-summary.html">Prev Package</a></li>
|
|
<li><a href="../../../../org/springframework/batch/item/adapter/package-summary.html">Next Package</a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/springframework/batch/item/package-summary.html" target="_top">Frames</a></li>
|
|
<li><a href="package-summary.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses-noframe.html">All 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>
|
|
<a name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<div class="header">
|
|
<h1 title="Package" class="title">Package org.springframework.batch.item</h1>
|
|
<div class="docSummary">
|
|
<div class="block">
|
|
Infrastructure interfaces and primary dependencies for item concerns.</div>
|
|
</div>
|
|
<p>See: <a href="#package.description">Description</a></p>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
|
|
<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Interface</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tbody>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ItemCountAware.html" title="interface in org.springframework.batch.item">ItemCountAware</a></td>
|
|
<td class="colLast">
|
|
<div class="block">Marker interface indicating that an item should have the item count set on it.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ItemProcessor.html" title="interface in org.springframework.batch.item">ItemProcessor</a><I,O></td>
|
|
<td class="colLast">
|
|
<div class="block">Interface for item transformation.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item">ItemReader</a><T></td>
|
|
<td class="colLast">
|
|
<div class="block">Strategy interface for providing the data.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ItemStream.html" title="interface in org.springframework.batch.item">ItemStream</a></td>
|
|
<td class="colLast">
|
|
<div class="block">
|
|
Marker interface defining a contract for periodically storing state and restoring from that state should an error
|
|
occur.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ItemStreamReader.html" title="interface in org.springframework.batch.item">ItemStreamReader</a><T></td>
|
|
<td class="colLast">
|
|
<div class="block">Convenience interface that combines <a href="../../../../org/springframework/batch/item/ItemStream.html" title="interface in org.springframework.batch.item"><code>ItemStream</code></a> and <a href="../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a>
|
|
.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ItemStreamWriter.html" title="interface in org.springframework.batch.item">ItemStreamWriter</a><T></td>
|
|
<td class="colLast">
|
|
<div class="block">Convenience interface that combines <a href="../../../../org/springframework/batch/item/ItemStream.html" title="interface in org.springframework.batch.item"><code>ItemStream</code></a> and <a href="../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item"><code>ItemWriter</code></a>
|
|
.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item">ItemWriter</a><T></td>
|
|
<td class="colLast">
|
|
<div class="block">
|
|
Basic interface for generic output operations.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/PeekableItemReader.html" title="interface in org.springframework.batch.item">PeekableItemReader</a><T></td>
|
|
<td class="colLast">
|
|
<div class="block">
|
|
A specialisation of <a href="../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> that allows the user to look ahead
|
|
into the stream of items.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ResourceAware.html" title="interface in org.springframework.batch.item">ResourceAware</a></td>
|
|
<td class="colLast">
|
|
<div class="block">Marker interface indicating that an item should have the Spring <code>Resource</code> in which it was read from, set on it.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</li>
|
|
<li class="blockList">
|
|
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
|
|
<caption><span>Class Summary</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Class</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tbody>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ExecutionContext.html" title="class in org.springframework.batch.item">ExecutionContext</a></td>
|
|
<td class="colLast">
|
|
<div class="block">Object representing a context for an <a href="../../../../org/springframework/batch/item/ItemStream.html" title="interface in org.springframework.batch.item"><code>ItemStream</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ItemStreamSupport.html" title="class in org.springframework.batch.item">ItemStreamSupport</a></td>
|
|
<td class="colLast">
|
|
<div class="block">Empty method implementation of <a href="../../../../org/springframework/batch/item/ItemStream.html" title="interface in org.springframework.batch.item"><code>ItemStream</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/KeyValueItemWriter.html" title="class in org.springframework.batch.item">KeyValueItemWriter</a><K,V></td>
|
|
<td class="colLast">
|
|
<div class="block">A base class to implement any <a href="../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item"><code>ItemWriter</code></a> that writes to a key value store
|
|
using a <code>Converter</code> to derive a key from an item</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/SpELItemKeyMapper.html" title="class in org.springframework.batch.item">SpELItemKeyMapper</a><K,V></td>
|
|
<td class="colLast">
|
|
<div class="block">An implementation of <code>Converter</code> that uses SpEL to map a Value to a key</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</li>
|
|
<li class="blockList">
|
|
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
|
|
<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Exception</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tbody>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ItemReaderException.html" title="class in org.springframework.batch.item">ItemReaderException</a></td>
|
|
<td class="colLast">
|
|
<div class="block">A base exception class that all exceptions thrown from an <a href="../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> extend.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ItemStreamException.html" title="class in org.springframework.batch.item">ItemStreamException</a></td>
|
|
<td class="colLast">
|
|
<div class="block">Exception representing any errors encountered while processing a stream.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ItemWriterException.html" title="class in org.springframework.batch.item">ItemWriterException</a></td>
|
|
<td class="colLast">
|
|
<div class="block">A base exception class that all exceptions thrown from an <a href="../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item"><code>ItemWriter</code></a> extend.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/NonTransientResourceException.html" title="class in org.springframework.batch.item">NonTransientResourceException</a></td>
|
|
<td class="colLast">
|
|
<div class="block">Exception indicating that an error has been encountered doing I/O from a
|
|
reader, and the exception should be considered fatal.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ParseException.html" title="class in org.springframework.batch.item">ParseException</a></td>
|
|
<td class="colLast">
|
|
<div class="block">Exception indicating that an error has been encountered parsing IO, typically from a file.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/ReaderNotOpenException.html" title="class in org.springframework.batch.item">ReaderNotOpenException</a></td>
|
|
<td class="colLast">
|
|
<div class="block">Exception indicating that an <a href="../../../../org/springframework/batch/item/ItemReader.html" title="interface in org.springframework.batch.item"><code>ItemReader</code></a> needed to be opened before read.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/UnexpectedInputException.html" title="class in org.springframework.batch.item">UnexpectedInputException</a></td>
|
|
<td class="colLast">
|
|
<div class="block">Used to signal an unexpected end of an input or message stream.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/WriteFailedException.html" title="class in org.springframework.batch.item">WriteFailedException</a></td>
|
|
<td class="colLast">
|
|
<div class="block">Unchecked exception indicating that an error has occurred while trying to
|
|
clear a buffer on a rollback.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><a href="../../../../org/springframework/batch/item/WriterNotOpenException.html" title="class in org.springframework.batch.item">WriterNotOpenException</a></td>
|
|
<td class="colLast">
|
|
<div class="block">Exception indicating that an <a href="../../../../org/springframework/batch/item/ItemWriter.html" title="interface in org.springframework.batch.item"><code>ItemWriter</code></a> needed to be opened before being
|
|
written to.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<a name="package.description">
|
|
<!-- -->
|
|
</a>
|
|
<h2 title="Package org.springframework.batch.item Description">Package org.springframework.batch.item Description</h2>
|
|
<div class="block"><p>
|
|
Infrastructure interfaces and primary dependencies for item concerns.
|
|
</p></div>
|
|
</div>
|
|
<!-- ======= 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 class="navBarCell1Rev">Package</li>
|
|
<li>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/integration/step/package-summary.html">Prev Package</a></li>
|
|
<li><a href="../../../../org/springframework/batch/item/adapter/package-summary.html">Next Package</a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?org/springframework/batch/item/package-summary.html" target="_top">Frames</a></li>
|
|
<li><a href="package-summary.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses-noframe.html">All 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>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|