/*
* FindBugs - Find Bugs in Java programs
* Copyright (C) 2006, University of Maryland
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package edu.umd.cs.findbugs;
import java.io.IOException;
import java.util.Set;
import org.dom4j.DocumentException;
import edu.umd.cs.findbugs.classfile.IClassObserver;
import edu.umd.cs.findbugs.config.AnalysisFeatureSetting;
import edu.umd.cs.findbugs.config.UserPreferences;
import edu.umd.cs.findbugs.filter.FilterException;
/**
* Interface for a FindBugs engine class. An instance of this interface takes a
* project, user configuration options, orchestrates the analysis of the classes
* in the project, and reports the results to the configured BugReporter.
*
* @author David Hovemeyer
*/
public interface IFindBugsEngine {
/**
* Get the BugReporter.
*
* @return the BugReporter
*/
public BugReporter getBugReporter();
/**
* Set the BugReporter.
*
* @param bugReporter
* The BugReporter to set
*/
public void setBugReporter(BugReporter bugReporter);
/**
* Set the Project.
*
* @param project
* The Project to set
*/
public void setProject(Project project);
/**
* Get the Project.
*
* @return the Project
*/
public Project getProject();
/**
* Set the progress callback that will be used to keep track of the progress
* of the analysis.
*
* @param progressCallback
* the progress callback
*/
public void setProgressCallback(FindBugsProgress progressCallback);
/**
* Set filter of bug instances to include or exclude.
*
* @param filterFileName
* the name of the filter file
* @param include
* true if the filter specifies bug instances to include, false
* if it specifies bug instances to exclude
*/
public void addFilter(String filterFileName, boolean include) throws IOException, FilterException;
/**
* Provide baseline of bugs not to report
*
* @param baselineBugs
* the name of the xml bug baseline file
* @throws DocumentException
*/
public void excludeBaselineBugs(String baselineBugs) throws IOException, DocumentException;
/**
* Set the UserPreferences representing which Detectors should be used. If
* UserPreferences are not set explicitly, the default set of Detectors will
* be used.
*
* @param userPreferences
* the UserPreferences
*/
public void setUserPreferences(UserPreferences userPreferences);
/**
* Add an IClassObserver.
*
* @param classObserver
* the IClassObserver
*/
public void addClassObserver(IClassObserver classObserver);
/**
* Set the ClassScreener. This object chooses which individual classes to
* analyze. By default, all classes are analyzed.
*
* @param classScreener
* the ClassScreener to use
*/
public void setClassScreener(IClassScreener classScreener);
/**
* Set relaxed reporting mode.
*
* @param relaxedReportingMode
* true if relaxed reporting mode should be enabled, false if not
*/
public void setRelaxedReportingMode(boolean relaxedReportingMode);
/**
* Set whether or not training output should be emitted.
*
* @param trainingOutputDir
* directory to save training output in
*/
public void enableTrainingOutput(String trainingOutputDir);
/**
* Set whether or not training input should be used to make the analysis
* more precise.
*
* @param trainingInputDir
* directory to load training input from
*/
public void enableTrainingInput(String trainingInputDir);
/**
* Set analysis feature settings.
*
* @param settingList
* list of analysis feature settings
*/
public void setAnalysisFeatureSettings(AnalysisFeatureSetting[] settingList);
/**
* @return Returns the releaseName.
*/
public String getReleaseName();
/**
* @param releaseName
* The releaseName to set.
*/
public void setReleaseName(String releaseName);
/**
* @return Returns the projectName.
*/
public String getProjectName();
/**
* @param projectName
* The project name to set.
*/
public void setProjectName(String projectName);
/**
* Set the filename of the source info file containing line numbers for
* fields and classes.
*
* @param sourceInfoFile
* the source info filename
*/
public void setSourceInfoFile(String sourceInfoFile);
/**
* Execute FindBugs on the Project. All bugs found are reported to the
* BugReporter object which was set when this object was constructed.
*
* @throws java.io.IOException
* if an I/O exception occurs analyzing one of the files
* @throws InterruptedException
* if the thread is interrupted while conducting the analysis
*/
public void execute() throws java.io.IOException, InterruptedException;
/**
* Get the name of the most recent class to be analyzed. This is useful for
* diagnosing an unexpected exception. Returns null if no class has been
* analyzed.
*/
public String getCurrentClass();
/**
* Get the number of bug instances that were reported during analysis.
*/
public int getBugCount();
/**
* Get the number of errors that occurred during analysis.
*/
public int getErrorCount();
/**
* Get the number of time missing classes were reported during analysis.
*/
public int getMissingClassCount();
/**
* Get the UserPreferences.
*
* @return the UserPreferences
*/
public UserPreferences getUserPreferences();
/**
* Return whether or not training output should be emitted after analysis
* completes.
*
* @return true if training output should be emitted, false if not
*/
public boolean emitTrainingOutput();
/**
* Get the training output directory.
*
* @return the training output directory
*/
public String getTrainingOutputDir();
/**
* Return whether or not we should make use of training data.
*
* @return true if training data should be used, false if not
*/
public boolean useTrainingInput();
/**
* Get the training input database directory.
*
* @return the training input database directory
*/
public String getTrainingInputDir();
/**
* Set whether or not nested archives should be scanned.
*
* @param scanNestedArchives
* true if nested archives should be scanned, false if not
*/
public void setScanNestedArchives(boolean scanNestedArchives);
/**
* Set whether or not to generate an empty output file if there were no
* class files specified.
*
* @param noClassOk
* true if FindBugs should generate empty output file
*/
public void setNoClassOk(boolean noClassOk);
/**
* Set the DetectorFactoryCollection from which plugins/detectors may be
* accessed.
*
* @param detectorFactoryCollection
* the DetectorFactoryCollection
*/
public void setDetectorFactoryCollection(DetectorFactoryCollection detectorFactoryCollection);
/**
* @param xmlWithAbridgedMessages
*/
public void setAbridgedMessages(boolean xmlWithAbridgedMessages);
public void setMergeSimilarWarnings(boolean mergeSimilarWarnings);
public void setApplySuppression(boolean applySuppression);
public void finishSettings();
void setRankThreshold(int rankThreshold);
void setBugReporterDecorators(Set<String> explicitlyEnabled, Set<String> explicitlyDisabled);
}