Files
spring-batch/build/api/org/springframework/batch/item/ItemWriter.html
Michael Minella 75ab909314 update
2017-03-23 10:18:33 -05:00

257 lines
16 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:35 CDT 2017 -->
<title>ItemWriter (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="ItemWriter (null 4.0.0.BUILD-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":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/ItemStreamWriter.html" title="interface in org.springframework.batch.item"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/springframework/batch/item/ItemWriterException.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/ItemWriter.html" target="_top">Frames</a></li>
<li><a href="ItemWriter.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 ItemWriter" class="title">Interface ItemWriter&lt;T&gt;</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/ItemStreamWriter.html" title="interface in org.springframework.batch.item">ItemStreamWriter</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/support/AbstractItemStreamItemWriter.html" title="class in org.springframework.batch.item.support">AbstractItemStreamItemWriter</a>, <a href="../../../../org/springframework/batch/item/amqp/AmqpItemWriter.html" title="class in org.springframework.batch.item.amqp">AmqpItemWriter</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/integration/chunk/ChunkMessageChannelItemWriter.html" title="class in org.springframework.batch.integration.chunk">ChunkMessageChannelItemWriter</a>, <a href="../../../../org/springframework/batch/item/support/ClassifierCompositeItemWriter.html" title="class in org.springframework.batch.item.support">ClassifierCompositeItemWriter</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/sample/domain/trade/internal/CustomerCreditItemWriter.html" title="class in org.springframework.batch.sample.domain.trade.internal">CustomerCreditItemWriter</a>, <a href="../../../../org/springframework/batch/sample/domain/trade/internal/CustomerCreditUpdateWriter.html" title="class in org.springframework.batch.sample.domain.trade.internal">CustomerCreditUpdateWriter</a>, <a href="../../../../org/springframework/batch/sample/domain/trade/CustomerUpdateWriter.html" title="class in org.springframework.batch.sample.domain.trade">CustomerUpdateWriter</a>, <a href="../../../../org/springframework/batch/sample/domain/trade/internal/CustomerUpdateWriter.html" title="class in org.springframework.batch.sample.domain.trade.internal">CustomerUpdateWriter</a>, <a href="../../../../org/springframework/batch/sample/support/DummyItemWriter.html" title="class in org.springframework.batch.sample.support">DummyItemWriter</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/data/GemfireItemWriter.html" title="class in org.springframework.batch.item.data">GemfireItemWriter</a>, <a href="../../../../org/springframework/batch/sample/domain/trade/internal/HibernateAwareCustomerCreditItemWriter.html" title="class in org.springframework.batch.sample.domain.trade.internal">HibernateAwareCustomerCreditItemWriter</a>, <a href="../../../../org/springframework/batch/item/database/HibernateItemWriter.html" title="class in org.springframework.batch.item.database">HibernateItemWriter</a>, <a href="../../../../org/springframework/batch/item/database/IbatisBatchItemWriter.html" title="class in org.springframework.batch.item.database">IbatisBatchItemWriter</a>, <a href="../../../../org/springframework/batch/sample/common/InfiniteLoopWriter.html" title="class in org.springframework.batch.sample.common">InfiniteLoopWriter</a>, <a href="../../../../org/springframework/batch/item/adapter/ItemWriterAdapter.html" title="class in org.springframework.batch.item.adapter">ItemWriterAdapter</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/JdbcBatchItemWriter.html" title="class in org.springframework.batch.item.database">JdbcBatchItemWriter</a>, <a href="../../../../org/springframework/batch/sample/domain/football/internal/JdbcGameDao.html" title="class in org.springframework.batch.sample.domain.football.internal">JdbcGameDao</a>, <a href="../../../../org/springframework/batch/sample/domain/football/internal/JdbcPlayerSummaryDao.html" title="class in org.springframework.batch.sample.domain.football.internal">JdbcPlayerSummaryDao</a>, <a href="../../../../org/springframework/batch/item/jms/JmsItemWriter.html" title="class in org.springframework.batch.item.jms">JmsItemWriter</a>, <a href="../../../../org/springframework/batch/item/database/JpaItemWriter.html" title="class in org.springframework.batch.item.database">JpaItemWriter</a>, <a href="../../../../org/springframework/batch/item/KeyValueItemWriter.html" title="class in org.springframework.batch.item">KeyValueItemWriter</a>, <a href="../../../../org/springframework/batch/item/support/ListItemWriter.html" title="class in org.springframework.batch.item.support">ListItemWriter</a>, <a href="../../../../org/springframework/batch/core/test/timeout/LoggingItemWriter.html" title="class in org.springframework.batch.core.test.timeout">LoggingItemWriter</a>, <a href="../../../../org/springframework/batch/item/mail/javamail/MimeMessageItemWriter.html" title="class in org.springframework.batch.item.mail.javamail">MimeMessageItemWriter</a>, <a href="../../../../org/springframework/batch/item/data/MongoItemWriter.html" title="class in org.springframework.batch.item.data">MongoItemWriter</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/Neo4jItemWriter.html" title="class in org.springframework.batch.item.data">Neo4jItemWriter</a>, <a href="../../../../org/springframework/batch/sample/domain/person/internal/PersonWriter.html" title="class in org.springframework.batch.sample.domain.person.internal">PersonWriter</a>, <a href="../../../../org/springframework/batch/sample/domain/football/internal/PlayerItemWriter.html" title="class in org.springframework.batch.sample.domain.football.internal">PlayerItemWriter</a>, <a href="../../../../org/springframework/batch/item/adapter/PropertyExtractingDelegatingItemWriter.html" title="class in org.springframework.batch.item.adapter">PropertyExtractingDelegatingItemWriter</a>, <a href="../../../../org/springframework/batch/item/data/RepositoryItemWriter.html" title="class in org.springframework.batch.item.data">RepositoryItemWriter</a>, <a href="../../../../org/springframework/batch/sample/support/RetrySampleItemWriter.html" title="class in org.springframework.batch.sample.support">RetrySampleItemWriter</a>, <a href="../../../../org/springframework/batch/item/mail/SimpleMailMessageItemWriter.html" title="class in org.springframework.batch.item.mail">SimpleMailMessageItemWriter</a>, <a href="../../../../org/springframework/batch/item/data/SpELMappingGemfireItemWriter.html" title="class in org.springframework.batch.item.data">SpELMappingGemfireItemWriter</a>, <a href="../../../../org/springframework/batch/sample/common/StagingItemWriter.html" title="class in org.springframework.batch.sample.common">StagingItemWriter</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/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">ItemWriter&lt;T&gt;</span></pre>
<div class="block"><p>
Basic interface for generic output operations. Class implementing this
interface will be responsible for serializing objects as necessary.
Generally, it is responsibility of implementing class to decide which
technology to use for mapping and how it should be configured.
</p>
<p>
The write method is responsible for making sure that any internal buffers are
flushed. If a transaction is active it will also usually be necessary to
discard the output on a subsequent rollback. The resource to which the writer
is sending data should normally be able to handle this itself.
</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/ItemWriter.html#write-java.util.List-">write</a></span>(java.util.List&lt;? extends <a href="../../../../org/springframework/batch/item/ItemWriter.html" title="type parameter in ItemWriter">T</a>&gt;&nbsp;items)</code>
<div class="block">Process the supplied data element.</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="write-java.util.List-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>write</h4>
<pre>void&nbsp;write(java.util.List&lt;? extends <a href="../../../../org/springframework/batch/item/ItemWriter.html" title="type parameter in ItemWriter">T</a>&gt;&nbsp;items)
throws java.lang.Exception</pre>
<div class="block">Process the supplied data element. Will not be called with any null items
in normal operation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>items</code> - items to be written</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code> - if there are errors. The framework will catch the
exception and convert or rethrow it as appropriate.</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/ItemStreamWriter.html" title="interface in org.springframework.batch.item"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/springframework/batch/item/ItemWriterException.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/ItemWriter.html" target="_top">Frames</a></li>
<li><a href="ItemWriter.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>