Package com.intellij.openapi.vcs

Class CodeSmellDetector

java.lang.Object

com.intellij.openapi.vcs.CodeSmellDetector

Direct Known Subclasses:

CodeSmellDetectorImpl

public abstract class CodeSmellDetector
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CodeSmellDetector()

Method Summary

Modifier and Type	Method and Description
abstract java.util.List<CodeSmellInfo>	findCodeSmells(java.util.List<? extends VirtualFile> files) Performs pre-checkin code analysis on the specified files.
static CodeSmellDetector	getInstance(Project project)
abstract void	showCodeSmellErrors(java.util.List<CodeSmellInfo> smells) Shows the specified list of problems found during pre-checkin code analysis in a Messages pane.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CodeSmellDetector

public CodeSmellDetector()

Method Detail

getInstance

public static CodeSmellDetector getInstance(Project project)

findCodeSmells

public abstract java.util.List<CodeSmellInfo> findCodeSmells(java.util.List<? extends VirtualFile> files)
                                                      throws ProcessCanceledException

Performs pre-checkin code analysis on the specified files.

Parameters:

files - the files to analyze.

Returns:

the list of problems found during the analysis.

Throws:

ProcessCanceledException - if the analysis was cancelled by the user.

showCodeSmellErrors

public abstract void showCodeSmellErrors(java.util.List<CodeSmellInfo> smells)

Shows the specified list of problems found during pre-checkin code analysis in a Messages pane.

Parameters:

smells - the problems to show.