com.github.nicosensei.textbatch.input.InputFileReader Maven / Gradle / Ivy

Go to download

/**
 *
 */
package com.github.nicosensei.textbatch.input;

/**
 * @author ngiraud
 *
 */
public interface InputFileReader {

    /**
     * Closes the reader.
     * @throws InputFileException
     */
    void close() throws InputFileException;

    /**
     * Atomically obtain a section of the combined path file
     * @return
     * @throws InputFileException
     */
    InputFileSection readSection() throws InputFileException;

    /**
     * Atomically obtain a line of the combined path file
     * @return
     * @throws InputFileException
     */
    L readLine() throws InputFileException;

    /**
     * @returns the encoding to use to read files.
     */
    String getEncoding();
    
    /**
     * @return the size of an input section
     */
    int getSectionSize();

}