com.levigo.jadice.document.read.fluent
Interface AsyncReadConfigurer

All Superinterfaces:

ReadConfigurer

public interface AsyncReadConfigurer
extends ReadConfigurer

A ReadConfigurer which does asynchronous execution. All work will be done on background Threads using the jadice TaskExecutor API.

IMPORTANT: This interface is used as a public part of the fluent read API. It is not designed to be implemented and must not be implemented by clients.

Method Summary

Task<List<Document>>	asTask() Construct a Task of this read configuration.
void	execute() Execute this read configuration.
void	execute(TaskExecutor<List<Document>> taskExecutor) Execute this read configuration on the given TaskExecutor.

Methods inherited from interface com.levigo.jadice.document.read.fluent.ReadConfigurer

add, defaultControls, defaultLayerMapping, defaultLayerMapping, getFirstDocument, getRegisteredDocuments, into, newDocument, newDocument, skip, task, task

Method Detail

asTask

Task<List<Document>> asTask()

Construct a Task of this read configuration. The Task returned may be used to be executed on a TaskExecutor

Returns:

a Task instance containing all instructions to perform the reading of the configured documents and all parts.

execute

void execute(TaskExecutor<List<Document>> taskExecutor)

Execute this read configuration on the given TaskExecutor.

Parameters:

taskExecutor -

Throws:

IllegalArgumentException - if taskExecutor is null

execute

void execute()

Execute this read configuration. This method is basically same as execute(TaskExecutor) but uses an anonymous internal TaskExecutor