Package org.pipecraft.pipes.terminal

Class AsyncConsumerPipe<T>

java.lang.Object

org.pipecraft.pipes.terminal.TerminalPipe

org.pipecraft.pipes.terminal.AsyncConsumerPipe<T>

Type Parameters:

T - The input item type

All Implemented Interfaces:

Closeable, AutoCloseable, BasePipe

public class AsyncConsumerPipe<T>
extends TerminalPipe

Consumes the contents of an AsyncPipe, blocking in the start() method until all data is read. This class is similar to ConsumerPipe, but intended for async pipes. The close() method should be called by the same thread calling start().

Author:

Eyal Schneider

Constructor Summary

Constructors

Constructor	Description
AsyncConsumerPipe(AsyncPipe<T> inputPipe)	Constructor
AsyncConsumerPipe(AsyncPipe<T> inputPipe, FailableConsumer<? super T,PipeException> itemAction)	Constructor
AsyncConsumerPipe(AsyncPipe<T> inputPipe, FailableConsumer<? super T,PipeException> itemAction, Runnable terminationAction)	Constructor

Method Summary

Modifier and Type	Method	Description
void	close()
float	getProgress()
void	start()	Performs pre-processing prior to item flow throw the pipe.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncConsumerPipe

public AsyncConsumerPipe(AsyncPipe<T> inputPipe,
                         FailableConsumer<? super T,PipeException> itemAction,
                         Runnable terminationAction)

Constructor

Parameters:

inputPipe - The pipe to consume

itemAction - The action to perform on all items. Legitimate errors should be wrapped by PipeException. Errors cause pipeline termination. Must be thread safe!

terminationAction - An action to perform once all input items have been consumed. Runs once, upon a successful iteration termination only.

AsyncConsumerPipe

public AsyncConsumerPipe(AsyncPipe<T> inputPipe,
                         FailableConsumer<? super T,PipeException> itemAction)

Constructor

Parameters:

inputPipe - The pipe to consume

itemAction - The action to perform on all items. Legitimate errors should be wrapped by PipeException. Errors cause pipeline termination. Must be thread safe!

AsyncConsumerPipe

public AsyncConsumerPipe(AsyncPipe<T> inputPipe)

Constructor

Parameters:

inputPipe - The pipe to consume

Method Detail

start

public void start()
           throws PipeException,
                  InterruptedException

Description copied from interface: BasePipe

Performs pre-processing prior to item flow throw the pipe. Implementations must call the same method for all their input pipes before accessing their items. This is typically done here.

Throws:

PipeException - In case of pipe errors in this pipe or somewhere up-stream.

InterruptedException - In case that the operation has been interrupted by another thread.

getProgress

public float getProgress()

Specified by:

getProgress in interface BasePipe

Overrides:

getProgress in class TerminalPipe

Returns:

The pipe flow progress, as a floating number between 0.0 and 1.0. Important implementation rules: 1) Calling this method before start() call is complete isn't allowed and has an undefined behavior. 2) Implementation should do best effort to provide an estimate of the progress this pipe has made (0.0 - 1.0) 3) When the pipe is fully consumed, getProgress() should return 1.0. 4) Results must be monotonous, i.e. results of consecutive calls may never be decreasing. 5) Thread safety: progress may be maintained by some thread/s but monitoring by other threads. Implementations must be thread safe.

close

public void close()
           throws IOException

Throws:

IOException