Package org.pipecraft.pipes.sync.inter

Class IntermediateBinFileWriterPipe<T>

java.lang.Object

org.pipecraft.pipes.sync.inter.DelegatePipe<T>

org.pipecraft.pipes.sync.inter.IntermediateBinFileWriterPipe<T>

All Implemented Interfaces:

Closeable, AutoCloseable, BasePipe, Pipe<T>

public class IntermediateBinFileWriterPipe<T>
extends DelegatePipe<T>

The intermediate version of BinFileWriterPipe. Writes items to a local file in a binary format. Supports compression.

Author:

Eyal Schneider

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class org.pipecraft.pipes.sync.inter.DelegatePipe

getOriginPipe, getProgress, peek

Methods inherited from class java.lang.Object

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

Constructor Detail

IntermediateBinFileWriterPipe

public IntermediateBinFileWriterPipe(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

IntermediateBinFileWriterPipe

public IntermediateBinFileWriterPipe(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

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class DelegatePipe<T>

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.

Specified by:

start in interface BasePipe

Overrides:

start in class DelegatePipe<T>

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.

next

public T next()
       throws PipeException,
              InterruptedException

Specified by:

next in interface Pipe<T>

Overrides:

next in class DelegatePipe<T>

Returns:

The next item in this pipe output, or null if the output end has been reached. May be a blocking operation.

Throws:

PipeException - In case of pipe errors in this pipe or somewhere up-stream while trying to prepare next item to return.

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