• Home
• org.daisy.dotify
• dotify.task-runner
• 2.1.0
• source code
• TempFileWriter.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.daisy.dotify.tasks.runner.TempFileWriter Maven / Gradle / Ivy

package org.daisy.dotify.tasks.runner;

import java.io.File;
import java.io.IOException;

/**
 * Provides an interface for copying files to a separate folder 
 * for debugging purposes.
 * 
 * @author Joel Håkansson
 */
public interface TempFileWriter {

	/**
	 * Writes a copy of the source file to a temporary folder. The identifier is
	 * intended as a means to identify the file at a later time. Therefore,
	 * an implementation should include the identifier as a part of the copy's file
	 * name (to the extent possible with respect to file system limitations).
	 * The implementation should also attempt to ensure that each created copy is
	 * preserved even when the same information is supplied multiple times, for 
	 * example by appending a time stamp to each file name. 
	 * 
	 * @param source the source file to copy
	 * @param identifier a string that can help identify the file in the temporary folder
	 * @throws IOException if something goes wrong
	 */
	public void writeTempFile(File source, String identifier) throws IOException;

	/**
	 * Deletes all temporary files written by this writer
	 */
	public void deleteTempFiles();
}