FitResult.java

/*
 * Copyright (c) 2002 Cunningham & Cunningham, Inc.
 * Copyright (c) 2009-2015 by Jochen Wierum & Cologne Intelligence
 *
 * This file is part of FitGoodies.
 *
 * FitGoodies is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * FitGoodies is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with FitGoodies.  If not, see <http://www.gnu.org/licenses/>.
 */


package de.cologneintelligence.fitgoodies.runners;

import de.cologneintelligence.fitgoodies.Counts;

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

/**
 * Represents a collection of fit results.
 */
public interface FitResult {
	/**
	 * Saves the result <code>result</code> for the file <code>file</code>.
	 *
	 * @param file   filename
	 * @param result fit result counts
	 */
	void put(File file, Counts result);

	/**
	 * Print the result to <code>stream</code>, using <code>directory</code>
	 * as the title of the report.
	 *
	 * @param directory processed directory
	 * @param stream    stream to write results to
	 * @throws IOException exceptions generated by stream
	 */
	void print(File directory, OutputStream stream) throws IOException;
}