com.helger.commons.io

Interface IBatchable

public interface IBatchable

This is an interface for objects that support batch processing, to avoid unnecessary IO operations.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isBatchProcessingActive()
EChange	startBatchProcessing() Start batch processing on this object.
EChange	stopBatchProcessingAndCommit() Stop batch processing on this object and commit any pending changes.

Method Detail

isBatchProcessingActive

boolean isBatchProcessingActive()

Returns:

true if batch processing is currently active, false otherwise.

startBatchProcessing

@Nonnull
EChange startBatchProcessing()

Start batch processing on this object. This should only have an effect on the first call.

Returns:

EChange.CHANGED if batch processing was enabled for this object, EChange.UNCHANGED if batch processing is already active.

stopBatchProcessingAndCommit

@Nonnull
EChange stopBatchProcessingAndCommit()

Stop batch processing on this object and commit any pending changes.

Returns:

EChange.CHANGED if batch processing was successfully stopped, EChange.UNCHANGED if batch processing was not active.