/*******************************************************************************
* GenPlay, Einstein Genome Analyzer
* Copyright (C) 2009, 2014 Albert Einstein College of Medicine
*
* This program 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.
*
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
* Authors: Julien Lajugie <julien.lajugie@einstein.yu.edu>
* Nicolas Fourel <nicolas.fourel@einstein.yu.edu>
* Eric Bouhassira <eric.bouhassira@einstein.yu.edu>
*
* Website: <http://genplay.einstein.yu.edu>
******************************************************************************/
package edu.yu.einstein.genplay.core.operation;
import edu.yu.einstein.genplay.dataStructure.list.genomeWideList.SCWList.binList.BinList;
import edu.yu.einstein.genplay.gui.statusBar.Stoppable;
/**
* Operation on a {@link BinList}
* @param <T> result type of the operation
* @author Julien Lajugie
* @version 0.1
*/
public interface Operation<T> extends Stoppable {
/**
* Processes the operation
* @return the result of the operation
* @throws Exception
*/
public T compute() throws Exception;
/**
* @return a description of the operation
*/
public String getDescription();
/**
* @return a description of what is done during the process
*/
public String getProcessingDescription();
/**
* @return the number of steps needed to complete the operation
*/
public int getStepCount();
}