ICoveragePerformer.java

package org.erlide.cover.api;

import java.util.Collection;

/**
 * API for using cover plugin
 *
 * @author Aleksandra Lipiec <aleksandra.lipiec@erlang-solutions.com>
 *
 */
public interface ICoveragePerformer {

    /**
     * Start cover on the nodes given
     *
     * if cover is already started on the given nodes nothing happen
     *
     * if cover is already started and the node list changed, it is started once
     * again
     *
     * @param nodes
     */
    public void startCover(Collection<String> nodes) throws CoverException;

    /**
     * Sets coverage configuration, and prepares all selected files
     *
     * @param conf
     */
    public void setCoverageConfiguration(IConfiguration conf) throws CoverException;

    /**
     * Perform cover analises based on present configuration
     */
    public void analyse() throws CoverException;

    /**
     * Enables checking configuration
     *
     * @return
     */
    public IConfiguration getConfig();

}