Package org.pipecraft.pipes.terminal

Class BinFileWriterPipe<T>

java.lang.Object

org.pipecraft.pipes.terminal.TerminalPipe

org.pipecraft.pipes.terminal.CompoundTerminalPipe

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

All Implemented Interfaces:

Closeable, AutoCloseable, BasePipe

public class BinFileWriterPipe<T>
extends CompoundTerminalPipe

A terminal pipe writing items to a local file in a binary format. Supports gz compression. Calling start() blocks until all data from the input pipe is written to the file.

Author:

Eyal Schneider

Constructor Summary

Constructors

Constructor	Description
BinFileWriterPipe(Pipe<T> input, File outputFile, FileWriteOptions options, EncoderFactory<? super T> encoderFactory)	Constructor
BinFileWriterPipe(Pipe<T> input, File outputFile, EncoderFactory<? super T> encoderFactory)	Constructor Uses default file write settings (see @{FileWriteOptions})

Method Summary

Modifier and Type	Method	Description
protected TerminalPipe	createPipeline()

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

close, getProgress, start

Methods inherited from class java.lang.Object

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

Constructor Detail

BinFileWriterPipe

public BinFileWriterPipe(Pipe<T> input,
                         File outputFile,
                         FileWriteOptions options,
                         EncoderFactory<? super T> encoderFactory)

Constructor

Parameters:

input - The input pipe to read items from

outputFile - The output file

options - The file writing options

encoderFactory - The encoder factory to use for converting items to binary form

BinFileWriterPipe

public BinFileWriterPipe(Pipe<T> input,
                         File outputFile,
                         EncoderFactory<? super T> encoderFactory)

Constructor Uses default file write settings (see @{FileWriteOptions})

Parameters:

input - The input pipe to read items from

outputFile - The output file

encoderFactory - The encoder factory to use for converting items to binary form

Method Detail

createPipeline

protected TerminalPipe createPipeline()
                               throws PipeException,
                                      InterruptedException

Specified by:

createPipeline in class CompoundTerminalPipe

Returns:

A new terminal pipeline to represent the logic of this pipe

Throws:

PipeException - In case of a pipeline creation error

InterruptedException - In case that the thread is interrupted