Interface for periodically storing and restoring state should an error occur. More...
Public Member Functions | |
| void | Open (ExecutionContext executionContext) |
| Open the stream for the provided ExecutionContext. More... | |
| void | Update (ExecutionContext executionContext) |
| 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. More... | |
| void | Flush () |
| Flushes the stream if able. More... | |
| void | Close () |
| 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. More... | |
Detailed Description
Interface for periodically storing and restoring state should an error occur.
Member Function Documentation
| void Summer.Batch.Infrastructure.Item.IItemStream.Close | ( | ) |
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.
- Exceptions
-
ItemStreamException
Implemented in Summer.Batch.Infrastructure.Item.File.FlatFileItemWriter< T >, Summer.Batch.Extra.Ebcdic.EbcdicFileWriter< T >, Summer.Batch.Infrastructure.Item.File.MultiResourceItemReader< T >, Summer.Batch.Infrastructure.Item.Support.AbstractItemCountingItemStreamItemReader< T >, Summer.Batch.Infrastructure.Item.Support.CompositeItemStream, Summer.Batch.Infrastructure.Item.Support.CompositeItemWriter< T >, and Summer.Batch.Infrastructure.Item.Util.ItemStreamSupport.
| void Summer.Batch.Infrastructure.Item.IItemStream.Flush | ( | ) |
Flushes the stream if able.
Implemented in Summer.Batch.Infrastructure.Item.File.FlatFileItemWriter< T >, Summer.Batch.Extra.Ebcdic.EbcdicFileWriter< T >, Summer.Batch.Infrastructure.Item.File.MultiResourceItemReader< T >, Summer.Batch.Infrastructure.Item.Support.CompositeItemStream, Summer.Batch.Infrastructure.Item.Support.CompositeItemWriter< T >, and Summer.Batch.Infrastructure.Item.Util.ItemStreamSupport.
| void Summer.Batch.Infrastructure.Item.IItemStream.Open | ( | ExecutionContext | executionContext | ) |
Open the stream for the provided ExecutionContext.
- Parameters
-
executionContext current step's ExecutionContext. Will be the executionContext from the last run of the step on a restart.
- Exceptions
-
ItemStreamException ArgumentException if execution context is null
Implemented in Summer.Batch.Infrastructure.Item.File.FlatFileItemWriter< T >, Summer.Batch.Extra.Ebcdic.EbcdicFileWriter< T >, Summer.Batch.Infrastructure.Item.Support.AbstractItemCountingItemStreamItemReader< T >, Summer.Batch.Infrastructure.Item.File.MultiResourceItemReader< T >, Summer.Batch.Infrastructure.Item.Support.CompositeItemStream, Summer.Batch.Infrastructure.Item.Util.ItemStreamSupport, and Summer.Batch.Infrastructure.Item.Support.CompositeItemWriter< T >.
| void Summer.Batch.Infrastructure.Item.IItemStream.Update | ( | ExecutionContext | executionContext | ) |
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.
- Parameters
-
executionContext to be updated
- Exceptions
-
ItemStreamException ArgumentException if execution context is null
Implemented in Summer.Batch.Infrastructure.Item.File.FlatFileItemWriter< T >, Summer.Batch.Extra.Ebcdic.EbcdicFileWriter< T >, Summer.Batch.Infrastructure.Item.Support.AbstractItemCountingItemStreamItemReader< T >, Summer.Batch.Infrastructure.Item.File.MultiResourceItemReader< T >, Summer.Batch.Infrastructure.Item.Support.CompositeItemStream, Summer.Batch.Infrastructure.Item.Support.CompositeItemWriter< T >, and Summer.Batch.Infrastructure.Item.Util.ItemStreamSupport.
The documentation for this interface was generated from the following file:
- Summer.Batch.Infrastructure/Item/IItemStream.cs