Package org.springframework.batch.item

Interface ItemWriter<T>

All Known Subinterfaces:
ItemStreamWriter<T>, ResourceAwareItemWriterItemStream<T>
All Known Implementing Classes:
AbstractFileItemWriter, AbstractItemStreamItemWriter, AmqpItemWriter, AsyncItemWriter, AvroItemWriter, BlockingQueueItemWriter, ChunkMessageChannelItemWriter, ClassifierCompositeItemWriter, CompositeItemWriter, ConsumerItemWriter, FlatFileItemWriter, ItemWriterAdapter, JdbcBatchItemWriter, JmsItemWriter, JpaItemWriter, JsonFileItemWriter, KafkaItemWriter, KeyValueItemWriter, ListItemWriter, MimeMessageItemWriter, MongoItemWriter, MultiResourceItemWriter, Neo4jItemWriter, PropertyExtractingDelegatingItemWriter, RedisItemWriter, RepositoryItemWriter, SimpleMailMessageItemWriter, StaxEventItemWriter, SynchronizedItemStreamWriter, SynchronizedItemWriter
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface ItemWriter<T>

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.

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.

Author:
Dave Syer, Lucas Ward, Taeik Lim, Mahmoud Ben Hassine

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    write(Chunk<? extends T> chunk)
    Process the supplied data element.

  • Method Details

    • write

      void write(@NonNull Chunk<? extends T> chunk) throws Exception
      Process the supplied data element. Will not be called with any null items in normal operation.
      Parameters:
      chunk - of items to be written. Must not be null.
      Throws:
      Exception - if there are errors. The framework will catch the exception and convert or rethrow it as appropriate.