/**
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.cache;

import java.io.File;
import java.util.List;

import net.sourceforge.pmd.RuleSets;
import net.sourceforge.pmd.RuleViolation;
import net.sourceforge.pmd.ThreadSafeReportListener;

/**
 * An analysis cache for incremental analysis.
 */
public interface AnalysisCache extends ThreadSafeReportListener {

    /**
     * Persist the analysis results on whatever means is used by the cache
     */
    void persist();

    /**
     * Check if a given file is up to date in the cache and can be skipped from analysis
     * @param sourceFile The file to check in the cache
     * @return True if the cache is a hit, false otherwise
     */
    boolean isUpToDate(File sourceFile);

    /**
     * Retrieves cached violations for the given file. Make sure to call {@link #isUpToDate(File)} first.
     * @param sourceFile The file to check in the cache
     * @return The list of cached violations.
     */
    List<RuleViolation> getCachedViolations(File sourceFile);

    /**
     * Notifies the cache that analysis of the given file has failed and should not be cached
     * @param sourceFile The file whose analysis failed
     */
    void analysisFailed(File sourceFile);
    
    /**
     * Checks if the cache is valid for the configured rulesets and class loader.
     * @param ruleSets The rulesets configured for this analysis.
     * @param auxclassPathClassLoader The class loader for auxclasspath configured for this analysis.
     */
    void checkValidity(RuleSets ruleSets, ClassLoader auxclassPathClassLoader);
}
