net.sf.filePiper.model.FileProcessorEnvironment Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of file-piper Show documentation

This project is a GUI utility for processing files. It allows selecting a set of source files and a pipeline of processes to apply onto those files. The applications shows in a nice-looking user interface where you can define profiles for your repetitive tasks. It provides pre-defined processors doing usual file manipulation tasks like: Copy, Head, Tail, Chunk, Search, Replace, Zip, Unzip... But the biggest value of this file processor tool is the ability to add easily custom file processors written in java.

The newest version!

package net.sf.filePiper.model;


import java.io.IOException;
import java.io.OutputStream;


/**
 * Interface used by the FileProcessor to interact with its environment.
 * 
 * @author BEROL
 */
public interface FileProcessorEnvironment {


    /**
     * Get an output stream for writing. 

     * The output stream will be created based on the information passed in the info (the proposed name) and the global pipeline
     * output settings.
     * 
     * @param info
     *            info about the file to create. The proposed name contained in this info can be used to create the final file
     *            name if the pipeline is configured to use it.
     * @return a suitable output stream.
     * @throws IOException
     */
    public OutputStream getOutputStream(InputFileInfo info) throws IOException;


    /**
     * Returns true if the file processing shoud continue, false if it was aborted. 

     * This flag should be checked on a regular basis by the file processor to react when processing is aborted.
     * 
     * @return true if the file processing shoud continue, false if it was aborted.
     */
    public boolean shouldContinue();


    /**
     * Get the object representing the whole file processing pipeline. 

     * In general, a FileProcessor does not need to access the Pipeline directly.
     * 
     * @return the object representing the whole file processing pipeline.
     */
    public Pipeline getPipeline();


    /**
     * Get the current execution phase of the processor environment.
     * 
     * @return the current execution phase of the processor environment.
     */
    public ExecutionPhase getCurrentPhase();


}