Package org.pipecraft.pipes.terminal

Class ConsumerPipe<T>

java.lang.Object

org.pipecraft.pipes.terminal.TerminalPipe

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

Type Parameters:

T - The input items' data type

All Implemented Interfaces:

Closeable, AutoCloseable, BasePipe

public class ConsumerPipe<T>
extends TerminalPipe

A terminal pipe that consumes all contents of the input pipe in a synchronous manner. That is, calling start() will loop in over all outputs of the input pipe, performing the given action on each item.

Author:

Eyal Schneider

Constructor Summary

Constructors

Constructor	Description
ConsumerPipe(Pipe<T> input)	Constructor Builds a no-op consumer
ConsumerPipe(Pipe<T> input, Runnable terminationAction)	Constructor
ConsumerPipe(Pipe<T> input, FailableConsumer<? super T,PipeException> itemAction)	Constructor
ConsumerPipe(Pipe<T> input, FailableConsumer<? super T,PipeException> itemAction, Runnable terminationAction)	Constructor

Method Summary

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

Methods inherited from class org.pipecraft.pipes.terminal.TerminalPipe

getProgress

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumerPipe

public ConsumerPipe(Pipe<T> input,
                    FailableConsumer<? super T,PipeException> itemAction,
                    Runnable terminationAction)

Constructor

Parameters:

input - The input pipe

itemAction - The action to perform on all items. Legitimate errors should be wrapped by PipeException.

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

ConsumerPipe

public ConsumerPipe(Pipe<T> input,
                    FailableConsumer<? super T,PipeException> itemAction)

Constructor

Parameters:

input - The input pipe

itemAction - The action to perform on all items. Legitimate errors should be wrapped by PipeException.

ConsumerPipe

public ConsumerPipe(Pipe<T> input,
                    Runnable terminationAction)

Constructor

Parameters:

input - The input pipe

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

ConsumerPipe

public ConsumerPipe(Pipe<T> input)

Constructor Builds a no-op consumer

Parameters:

input - The input pipe

Method Detail

close

public void close()
           throws IOException

Throws:

IOException

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.