Class FlatFileItemWriter<T>

java.lang.Object

org.springframework.batch.infrastructure.item.ItemStreamSupport

org.springframework.batch.infrastructure.item.support.AbstractItemStreamItemWriter<T>

org.springframework.batch.infrastructure.item.support.AbstractFileItemWriter<T>

org.springframework.batch.infrastructure.item.file.FlatFileItemWriter<T>

All Implemented Interfaces:

ResourceAwareItemWriterItemStream<T>, ItemStream, ItemStreamWriter<T>, ItemWriter<T>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class FlatFileItemWriter<T>
extends AbstractFileItemWriter<T>

This class is an item writer that writes data to a file or stream. The writer also provides restart. The location of the output file is defined by a Resource and must represent a writable file.
Uses buffered writer to improve performance.
The implementation is not thread-safe.

Author:

Waseem Malik, Tomas Slanina, Robert Kasanicky, Dave Syer, Michael Minella, Mahmoud Ben Hassine, Stefano Cordio, Jimmy Praet

Nested Class Summary

Nested classes/interfaces inherited from class AbstractFileItemWriter

AbstractFileItemWriter.OutputState

Field Summary

Fields

Modifier and Type	Field	Description
protected LineAggregator<T>	lineAggregator

Fields inherited from class AbstractFileItemWriter

append, DEFAULT_CHARSET, DEFAULT_LINE_SEPARATOR, DEFAULT_TRANSACTIONAL, lineSeparator, logger, resource, shouldDeleteIfExists, state

Constructor Summary

Constructors

Constructor	Description
FlatFileItemWriter(LineAggregator<T> lineAggregator)	Create a new FlatFileItemWriter with the LineAggregator specified.
FlatFileItemWriter(org.springframework.core.io.WritableResource resource, LineAggregator<T> lineAggregator)	Create a new FlatFileItemWriter with the WritableResource and LineAggregator specified.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Assert that mandatory properties (lineAggregator) are set.
String	doWrite(Chunk<? extends T> items)	Write out a string of items followed by a "new line", where the format of the new line separator is determined by the underlying operating system.
void	setLineAggregator(LineAggregator<T> lineAggregator)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.1 in favor of passing the line aggregator to the constructor.

Methods inherited from class AbstractFileItemWriter

close, getOutputState, open, setAppendAllowed, setEncoding, setFooterCallback, setForceSync, setHeaderCallback, setLineSeparator, setResource, setSaveState, setShouldDeleteIfEmpty, setShouldDeleteIfExists, setTransactional, update, write

Methods inherited from class ItemStreamSupport

getExecutionContextKey, getName, setBeanName, setExecutionContextName, setName

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

lineAggregator

protected LineAggregator<T> lineAggregator

Constructor Details

FlatFileItemWriter

public FlatFileItemWriter(LineAggregator<T> lineAggregator)

Create a new FlatFileItemWriter with the LineAggregator specified.

Parameters:

lineAggregator - to use to convert items to lines of text

Since:

6.0

FlatFileItemWriter

public FlatFileItemWriter(org.springframework.core.io.WritableResource resource,
 LineAggregator<T> lineAggregator)

Create a new FlatFileItemWriter with the WritableResource and LineAggregator specified.

Parameters:

resource - to write to

lineAggregator - to use to convert items to lines of text

Since:

6.0

Method Details

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Assert that mandatory properties (lineAggregator) are set.

Throws:

Exception

See Also:

• InitializingBean.afterPropertiesSet()

setLineAggregator

@Deprecated(since="6.1",
            forRemoval=true)
public void setLineAggregator(LineAggregator<T> lineAggregator)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.1 in favor of passing the line aggregator to the constructor. Scheduled for removal in 7.0.

Public setter for the LineAggregator. This will be used to translate the item into a line for output.

Parameters:

lineAggregator - the LineAggregator to set

doWrite

public String doWrite(Chunk<? extends T> items)

Description copied from class: AbstractFileItemWriter

Write out a string of items followed by a "new line", where the format of the new line separator is determined by the underlying operating system.

Specified by:

doWrite in class AbstractFileItemWriter<T>

Parameters:

items - to be written

Returns:

written lines