PMD.java
| Index Score | ||
|---|---|---|
 |
 |
net.sourceforge.pmd |
 |
|
PMD |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| EXITS | Procedure exits |  |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| UNIQUE_OPERANDS | Number of unique operands | |
| OPERANDS | Number of operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| PARAMS | Number of formal parameter declarations | |
| PROGRAM_LENGTH | Halstead program length | |
| LOGICAL_LINES | Number of statements | |
| OPERATORS | Number of operators | |
| BLOCKS | Number of blocks | |
| ELOC | Effective lines of code | |
| SIZE | Size of the file in bytes | |
| LOC | Lines of code | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| LINES | Number of lines in the source file | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0008 | JAVA0008 Empty catch block | |
| JAVA0266 | JAVA0266 Use of System.out | |
| JAVA0138 | JAVA0138 N parameters defined for method (maximum: M) | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0150 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0123 | JAVA0123 Use all three components of for loop | |
| JAVA0265 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0267 | JAVA0267 Use of System.err | |
/**
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
package net.sourceforge.pmd;
import java.io.BufferedInputStream;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.Reader;
import java.io.UnsupportedEncodingException;
import java.io.Writer;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.Enumeration;
import java.util.LinkedList;
import java.util.List;
import java.util.StringTokenizer;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.ThreadFactory;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import net.sourceforge.pmd.cpd.SourceFileOrDirectoryFilter;
import net.sourceforge.pmd.lang.Language;
import net.sourceforge.pmd.lang.LanguageVersion;
import net.sourceforge.pmd.lang.LanguageVersionHandler;
import net.sourceforge.pmd.lang.Parser;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.java.ast.ParseException;
import net.sourceforge.pmd.lang.xpath.Initializer;
import net.sourceforge.pmd.renderers.Renderer;
import net.sourceforge.pmd.util.Benchmark;
import net.sourceforge.pmd.util.ClasspathClassLoader;
import net.sourceforge.pmd.util.FileFinder;
import net.sourceforge.pmd.util.datasource.DataSource;
import net.sourceforge.pmd.util.datasource.FileDataSource;
import net.sourceforge.pmd.util.datasource.ZipDataSource;
import net.sourceforge.pmd.util.log.ConsoleLogHandler;
import net.sourceforge.pmd.util.log.ScopedLogHandlersManager;
public class PMD {
public static final String EOL = System.getProperty("line.separator", "\n");
public static final String VERSION = "5.0-SNAPSHOT";
public static final String SUPPRESS_MARKER = "NOPMD";
private static final Logger LOG = Logger.getLogger(PMD.class.getName());
private Configuration configuration = new Configuration();
/**
* Get the runtime configuration. The configuration can be modified
* to affect how PMD behaves.
* @return The configuration.
* @see Configuration
*/
public Configuration getConfiguration() {
return configuration;
}
/**
* Set the runtime configuration.
* @see Configuration
*/
public void setConfiguration(Configuration configuration) {
this.configuration = configuration;
}
/**
* Processes the input stream against a rule set using the given input encoding.
*
* @param inputStream The InputStream to analyze.
* @param encoding The InputStream encoded. If <code>null</code>, then the System default encoding will be used.
* @param ruleSets The collection of rules to process against the file.
* @param ctx The context in which PMD is operating.
* @throws PMDException if the input encoding is unsupported, the input stream could
* not be parsed, or other error is encountered.
* @see #processFile(Reader, RuleSets, RuleContext)
*/
public void processFile(InputStream inputStream, String encoding, RuleSets ruleSets, RuleContext ctx)
throws PMDException {
try {
if (encoding == null) {
encoding = System.getProperty("file.encoding");
}
processFile(new InputStreamReader(inputStream, encoding), ruleSets, ctx);
} catch (UnsupportedEncodingException uee) {
throw new PMDException("Unsupported encoding exception: " + uee.getMessage());
}
}
/**
* Processes the input stream against a rule set using the given input encoding.
* If the LanguageVersion is <code>null</code> on the RuleContext, it will
* be automatically determined.
*
* @param reader The Reader to analyze.
* @param ruleSets The collection of rules to process against the file.
* @param ctx The context in which PMD is operating.
* @throws PMDException if the input encoding is unsupported, the input stream could
* not be parsed, or other error is encountered.
* @see #processFile(Reader, RuleSets, RuleContext)
*/
public void processFile(Reader reader, RuleSets ruleSets, RuleContext ctx) throws PMDException {
// If LanguageVersion of the source file is not known, make a determination
if (ctx.getLanguageVersion() == null) {
LanguageVersion languageVersion = configuration.getLanguageVersionOfFile(ctx.getSourceCodeFilename());
ctx.setLanguageVersion(languageVersion);
}
// make sure custom XPath functions are initialized
Initializer.initialize();
try {
// Coarse check to see if any RuleSet applies to files, will need to do a finer RuleSet specific check later
if (ruleSets.applies(ctx.getSourceCodeFile())) {
LanguageVersion languageVersion = ctx.getLanguageVersion();
LanguageVersionHandler languageVersionHandler = languageVersion.getLanguageVersionHandler();
Parser parser = languageVersionHandler.getParser();
parser.setSuppressMarker(configuration.getSuppressMarker());
long start = System.nanoTime();
Node rootNode = parser.parse(ctx.getSourceCodeFilename(), reader);
ctx.getReport().suppress(parser.getSuppressMap());
long end = System.nanoTime();
Benchmark.mark(Benchmark.TYPE_PARSER, end - start, 0);
start = System.nanoTime();
languageVersionHandler.getSymbolFacade().start(rootNode);
end = System.nanoTime();
Benchmark.mark(Benchmark.TYPE_SYMBOL_TABLE, end - start, 0);
Language language = languageVersion.getLanguage();
if (ruleSets.usesDFA(language)) {
start = System.nanoTime();
languageVersionHandler.getDataFlowFacade().start(rootNode);
end = System.nanoTime();
Benchmark.mark(Benchmark.TYPE_DFA, end - start, 0);
}
if (ruleSets.usesTypeResolution(language)) {
start = System.nanoTime();
languageVersionHandler.getTypeResolutionFacade(configuration.getClassLoader()).start(rootNode);
end = System.nanoTime();
Benchmark.mark(Benchmark.TYPE_TYPE_RESOLUTION, end - start, 0);
}
List<Node> acus = new ArrayList<Node>();
acus.add(rootNode);
ruleSets.apply(acus, ctx, language);
}
} catch (ParseException pe) {
throw new PMDException("Error while parsing " + ctx.getSourceCodeFilename(), pe);
} catch (Exception e) {
throw new PMDException("Error while processing " + ctx.getSourceCodeFilename(), e);
} finally {
try {
reader.close();
} catch (IOException e) {
}
}
}
/**
* Create a ClassLoader which loads classes using a CLASSPATH like String.
* If the String looks like a URL to a file (e.g. starts with <code>file://</code>)
* the file will be read with each line representing an entry on the classpath.
* <p>
* The ClassLoader used to load the <code>net.sourceforge.pmd.PMD</code> class
* will be used as the parent ClassLoader of the created ClassLoader.
*
* @param classpath The classpath String.
* @return A ClassLoader
* @throws IOException
* @see ClasspathClassLoader
*/
public static ClassLoader createClasspathClassLoader(String classpath) throws IOException {
ClassLoader classLoader = PMD.class.getClassLoader();
if (classpath != null) {
classLoader = new ClasspathClassLoader(classpath, classLoader);
}
return classLoader;
}
private static void doPMD(CommandLineOptions opts) {
long startFiles = System.nanoTime();
SourceFileSelector fileSelector = new SourceFileSelector();
fileSelector.setSelectJavaFiles(opts.isCheckJavaFiles());
fileSelector.setSelectJspFiles(opts.isCheckJspFiles());
List<DataSource> files;
if (opts.containsCommaSeparatedFileList()) {
files = collectFromCommaDelimitedString(opts.getInputPath(), fileSelector);
} else {
files = collectFilesFromOneName(opts.getInputPath(), fileSelector);
}
long endFiles = System.nanoTime();
Benchmark.mark(Benchmark.TYPE_COLLECT_FILES, endFiles - startFiles, 0);
List<LanguageVersion> languageVersions = new ArrayList<LanguageVersion>();
Language language = Language.JAVA;
LanguageVersion languageVersion = language.getVersion(opts.getTargetJDK());
if (languageVersion == null) {
languageVersion = language.getDefaultVersion();
}
languageVersions.add(languageVersion);
LOG.fine("Using " + languageVersion.getShortName());
final ClassLoader classLoader;
try {
classLoader = createClasspathClassLoader(opts.getAuxClasspath());
} catch (IOException e) {
LOG.log(Level.SEVERE, "Bad -auxclasspath argument", e);
System.out.println(opts.usage());
return;
}
long reportStart;
long reportEnd;
Renderer renderer;
Writer w = null;
reportStart = System.nanoTime();
try {
renderer = opts.createRenderer();
List<Renderer> renderers = new LinkedList<Renderer>();
renderers.add(renderer);
if (opts.getReportFile() != null) {
w = new BufferedWriter(new FileWriter(opts.getReportFile()));
} else {
w = new OutputStreamWriter(System.out);
}
renderer.setWriter(w);
renderer.start();
reportEnd = System.nanoTime();
Benchmark.mark(Benchmark.TYPE_REPORTING, reportEnd - reportStart, 0);
RuleContext ctx = new RuleContext();
try {
long startLoadRules = System.nanoTime();
RuleSetFactory ruleSetFactory = new RuleSetFactory();
ruleSetFactory.setMinimumPriority(opts.getMinPriority());
ruleSetFactory.setWarnDeprecated(true);
RuleSets rulesets = ruleSetFactory.createRuleSets(opts.getRulesets());
ruleSetFactory.setWarnDeprecated(false);
printRuleNamesInDebug(rulesets);
long endLoadRules = System.nanoTime();
Benchmark.mark(Benchmark.TYPE_LOAD_RULES, endLoadRules - startLoadRules, 0);
processFiles(opts.getCpus(), ruleSetFactory, languageVersions, files, ctx, renderers, opts
.stressTestEnabled(), opts.getRulesets(), opts.shortNamesEnabled(), opts.getInputPath(), opts
.getEncoding(), opts.getSuppressMarker(), classLoader);
} catch (RuleSetNotFoundException rsnfe) {
LOG.log(Level.SEVERE, "Ruleset not found", rsnfe);
System.out.println(opts.usage());
}
reportStart = System.nanoTime();
renderer.end();
w.write(EOL);
w.flush();
if (opts.getReportFile() != null) {
w.close();
w = null;
}
} catch (Exception e) {
String message = e.getMessage();
if (message != null) {
LOG.severe(message);
} else {
LOG.log(Level.SEVERE, "Exception during processing", e);
}
LOG.log(Level.FINE, "Exception during processing", e); //Only displayed when debug logging is on
LOG.info(opts.usage());
} finally {
if (opts.getReportFile() != null && w != null) {
try {
w.close();
} catch (Exception e) {
System.out.println(e.getMessage());
}
}
reportEnd = System.nanoTime();
Benchmark.mark(Benchmark.TYPE_REPORTING, reportEnd - reportStart, 0);
}
}
public static void main(String[] args) {
long start = System.nanoTime();
final CommandLineOptions opts = new CommandLineOptions(args);
final Level logLevel = opts.debugEnabled() ? Level.FINER : Level.INFO;
final Handler logHandler = new ConsoleLogHandler();
final ScopedLogHandlersManager logHandlerManager = new ScopedLogHandlersManager(logLevel, logHandler);
final Level oldLogLevel = LOG.getLevel();
LOG.setLevel(logLevel); //Need to do this, since the static logger has already been initialized at this point
try {
doPMD(opts);
} finally {
logHandlerManager.close();
LOG.setLevel(oldLogLevel);
if (opts.benchmark()) {
long end = System.nanoTime();
Benchmark.mark(Benchmark.TYPE_TOTAL_PMD, end - start, 0);
System.err.println(Benchmark.report());
}
}
}
private static class PmdRunnable extends PMD implements Callable<Report> {
private final ExecutorService executor;
private final DataSource dataSource;
private final String fileName;
private final String encoding;
private final String rulesets;
private final List<Renderer> renderers;
public PmdRunnable(ExecutorService executor, DataSource dataSource, String fileName,
List<LanguageVersion> languageVersions, List<Renderer> renderers, String encoding, String rulesets,
String suppressMarker, ClassLoader classLoader) {
this.executor = executor;
this.dataSource = dataSource;
this.fileName = fileName;
this.encoding = encoding;
this.rulesets = rulesets;
this.renderers = renderers;
getConfiguration().setDefaultLanguageVersions(languageVersions);
getConfiguration().setSuppressMarker(suppressMarker);
getConfiguration().setClassLoader(classLoader);
}
public Report call() {
PmdThread thread = (PmdThread) Thread.currentThread();
RuleContext ctx = thread.getRuleContext();
RuleSets rs = thread.getRuleSets(rulesets);
Report report = new Report();
ctx.setReport(report);
ctx.setSourceCodeFilename(fileName);
ctx.setSourceCodeFile(new File(fileName));
if (LOG.isLoggable(Level.FINE)) {
LOG.fine("Processing " + ctx.getSourceCodeFilename());
}
for (Renderer r : renderers) {
r.startFileAnalysis(dataSource);
}
try {
InputStream stream = new BufferedInputStream(dataSource.getInputStream());
processFile(stream, encoding, rs, ctx);
} catch (PMDException pmde) {
LOG.log(Level.FINE, "Error while processing file", pmde.getCause());
report.addError(new Report.ProcessingError(pmde.getMessage(), fileName));
} catch (IOException ioe) {
// unexpected exception: log and stop executor service
LOG.log(Level.FINE, "IOException during processing", ioe);
report.addError(new Report.ProcessingError(ioe.getMessage(), fileName));
executor.shutdownNow();
} catch (RuntimeException re) {
// unexpected exception: log and stop executor service
LOG.log(Level.FINE, "RuntimeException during processing", re);
report.addError(new Report.ProcessingError(re.getMessage(), fileName));
executor.shutdownNow();
}
return report;
}
}
private static class PmdThreadFactory implements ThreadFactory {
private final RuleSetFactory ruleSetFactory;
private final RuleContext ctx;
private final AtomicInteger counter = new AtomicInteger();
public PmdThreadFactory(RuleSetFactory ruleSetFactory, RuleContext ctx) {
this.ruleSetFactory = ruleSetFactory;
this.ctx = ctx;
}
public Thread newThread(Runnable r) {
PmdThread t = new PmdThread(counter.incrementAndGet(), r, ruleSetFactory, ctx);
threadList.add(t);
return t;
}
public List<PmdThread> threadList = Collections.synchronizedList(new LinkedList<PmdThread>());
}
private static class PmdThread extends Thread {
public PmdThread(int id, Runnable r, RuleSetFactory ruleSetFactory, RuleContext ctx) {
super(r, "PmdThread " + id);
this.id = id;
context = new RuleContext(ctx);
this.ruleSetFactory = ruleSetFactory;
}
private int id;
private RuleContext context;
private RuleSets rulesets;
private RuleSetFactory ruleSetFactory;
public RuleContext getRuleContext() {
return context;
}
public RuleSets getRuleSets(String rsList) {
if (rulesets == null) {
try {
rulesets = ruleSetFactory.createRuleSets(rsList);
} catch (Exception e) {
e.printStackTrace();
}
}
return rulesets;
}
@Override
public String toString() {
return "PmdThread " + id;
}
}
/**
* Do we have proper permissions to use multithreading?
*/
private static final boolean MT_SUPPORTED;
static {
boolean error = false;
try {
/*
* ant task ran from Eclipse with jdk 1.5.0 raises an AccessControlException
* when shutdown is called. Standalone pmd or ant from command line are fine.
*
* With jdk 1.6.0, ant task from Eclipse also works.
*/
ExecutorService executor = Executors.newFixedThreadPool(1);
executor.shutdown();
} catch (RuntimeException e) {
error = true;
}
MT_SUPPORTED = !error;
}
/**
* Run PMD on a list of files using multiple threads.
*/
public static void processFiles(int threadCount, RuleSetFactory ruleSetFactory,
List<LanguageVersion> languageVersions, List<DataSource> files, RuleContext ctx, List<Renderer> renderers,
String rulesets, final boolean shortNamesEnabled, final String inputPath, String encoding,
String suppressMarker, ClassLoader classLoader) {
processFiles(threadCount, ruleSetFactory, languageVersions, files, ctx, renderers, false, rulesets,
shortNamesEnabled, inputPath, encoding, suppressMarker, classLoader);
}
/**
* Run PMD on a list of files using multiple threads.
*/
public static void processFiles(int threadCount, RuleSetFactory ruleSetFactory,
List<LanguageVersion> languageVersions, List<DataSource> files, RuleContext ctx, List<Renderer> renderers,
boolean stressTestEnabled, String rulesets, final boolean shortNamesEnabled, final String inputPath,
String encoding, String suppressMarker, ClassLoader classLoader) {
/*
* Check if multithreaded is supported.
* ExecutorService can also be disabled if threadCount is not positive, e.g. using the
* "-cpus 0" command line option.
*/
boolean useMT = MT_SUPPORTED && threadCount > 0;
if (stressTestEnabled) {
// randomize processing order
Collections.shuffle(files);
} else {
Collections.sort(files, new Comparator<DataSource>() {
public int compare(DataSource d1, DataSource d2) {
String s1 = d1.getNiceFileName(shortNamesEnabled, inputPath);
String s2 = d2.getNiceFileName(shortNamesEnabled, inputPath);
return s1.compareTo(s2);
}
});
}
if (useMT) {
RuleSets rs = null;
try {
rs = ruleSetFactory.createRuleSets(rulesets);
} catch (RuleSetNotFoundException rsnfe) {
// should not happen: parent already created a ruleset
}
rs.start(ctx);
PmdThreadFactory factory = new PmdThreadFactory(ruleSetFactory, ctx);
ExecutorService executor = Executors.newFixedThreadPool(threadCount, factory);
List<Future<Report>> tasks = new LinkedList<Future<Report>>();
for (DataSource dataSource : files) {
String niceFileName = dataSource.getNiceFileName(shortNamesEnabled, inputPath);
PmdRunnable r = new PmdRunnable(executor, dataSource, niceFileName, languageVersions, renderers,
encoding, rulesets, suppressMarker, classLoader);
Future<Report> future = executor.submit(r);
tasks.add(future);
}
executor.shutdown();
while (!tasks.isEmpty()) {
Future<Report> future = tasks.remove(0);
Report report = null;
try {
report = future.get();
} catch (InterruptedException ie) {
Thread.currentThread().interrupt();
future.cancel(true);
} catch (ExecutionException ee) {
Throwable t = ee.getCause();
if (t instanceof RuntimeException) {
throw (RuntimeException) t;
} else if (t instanceof Error) {
throw (Error) t;
} else {
throw new IllegalStateException("PmdRunnable exception", t);
}
}
try {
long start = System.nanoTime();
for (Renderer r : renderers) {
r.renderFileReport(report);
}
long end = System.nanoTime();
Benchmark.mark(Benchmark.TYPE_REPORTING, end - start, 1);
} catch (IOException ioe) {
}
}
try {
rs.end(ctx);
long start = System.nanoTime();
for (Renderer r : renderers) {
r.renderFileReport(ctx.getReport());
}
long end = System.nanoTime();
Benchmark.mark(Benchmark.TYPE_REPORTING, end - start, 1);
} catch (IOException ioe) {
}
} else {
// single threaded execution
PMD pmd = new PMD();
pmd.getConfiguration().setDefaultLanguageVersions(languageVersions);
pmd.getConfiguration().setSuppressMarker(suppressMarker);
RuleSets rs = null;
try {
rs = ruleSetFactory.createRuleSets(rulesets);
} catch (RuleSetNotFoundException rsnfe) {
// should not happen: parent already created a ruleset
}
for (DataSource dataSource : files) {
String niceFileName = dataSource.getNiceFileName(shortNamesEnabled, inputPath);
Report report = new Report();
ctx.setReport(report);
ctx.setSourceCodeFilename(niceFileName);
ctx.setSourceCodeFile(new File(niceFileName));
if (LOG.isLoggable(Level.FINE)) {
LOG.fine("Processing " + ctx.getSourceCodeFilename());
}
rs.start(ctx);
for (Renderer r : renderers) {
r.startFileAnalysis(dataSource);
}
try {
InputStream stream = new BufferedInputStream(dataSource.getInputStream());
pmd.processFile(stream, encoding, rs, ctx);
} catch (PMDException pmde) {
LOG.log(Level.FINE, "Error while processing file", pmde.getCause());
report.addError(new Report.ProcessingError(pmde.getMessage(), niceFileName));
} catch (IOException ioe) {
// unexpected exception: log and stop executor service
LOG.log(Level.FINE, "Unable to read source file", ioe);
report.addError(new Report.ProcessingError(ioe.getMessage(), niceFileName));
} catch (RuntimeException re) {
// unexpected exception: log and stop executor service
LOG.log(Level.FINE, "RuntimeException while processing file", re);
report.addError(new Report.ProcessingError(re.getMessage(), niceFileName));
}
rs.end(ctx);
try {
long start = System.nanoTime();
for (Renderer r : renderers) {
r.renderFileReport(report);
}
long end = System.nanoTime();
Benchmark.mark(Benchmark.TYPE_REPORTING, end - start, 1);
} catch (IOException ioe) {
}
}
}
}
/**
* Run PMD on a list of files.
*
* @param files the List of DataSource instances.
* @param ctx the context in which PMD is operating. This contains the Report and
* whatnot
* @param rulesets the RuleSets
* @param debugEnabled
* @param shortNamesEnabled
* @param inputPath
* @param encoding
* @throws IOException If one of the files could not be read
*/
public void processFiles(List<DataSource> files, RuleContext ctx, RuleSets rulesets, boolean debugEnabled,
boolean shortNamesEnabled, String inputPath, String encoding) throws IOException {
for (DataSource dataSource : files) {
String niceFileName = dataSource.getNiceFileName(shortNamesEnabled, inputPath);
ctx.setSourceCodeFilename(niceFileName);
ctx.setSourceCodeFile(new File(niceFileName));
LOG.fine("Processing " + ctx.getSourceCodeFilename());
try {
InputStream stream = new BufferedInputStream(dataSource.getInputStream());
processFile(stream, encoding, rulesets, ctx);
} catch (PMDException pmde) {
LOG.log(Level.FINE, "Error while processing files", pmde.getCause());
ctx.getReport().addError(new Report.ProcessingError(pmde.getMessage(), niceFileName));
}
}
}
/**
* If in debug modus, print the names of the rules.
*
* @param rulesets the RuleSets to print
*/
private static void printRuleNamesInDebug(RuleSets rulesets) {
if (LOG.isLoggable(Level.FINER)) {
for (Rule r : rulesets.getAllRules()) {
LOG.finer("Loaded rule " + r.getName());
}
}
}
/**
* Collects the given file into a list.
*
* @param inputFileName a file name
* @param fileSelector Filtering of wanted source files
* @return the list of files collected from the <code>inputFileName</code>
* @see #collect(String, SourceFileSelector)
*/
private static List<DataSource> collectFilesFromOneName(String inputFileName, SourceFileSelector fileSelector) {
return collect(inputFileName, fileSelector);
}
/**
* Collects the files from the given comma-separated list.
*
* @param fileList comma-separated list of filenames
* @param fileSelector Filtering of wanted source files
* @return list of files collected from the <code>fileList</code>
*/
private static List<DataSource> collectFromCommaDelimitedString(String fileList, SourceFileSelector fileSelector) {
List<DataSource> files = new ArrayList<DataSource>();
for (StringTokenizer st = new StringTokenizer(fileList, ","); st.hasMoreTokens();) {
files.addAll(collect(st.nextToken(), fileSelector));
}
return files;
}
/**
* Collects the files from the given <code>filename</code>.
*
* @param filename the source from which to collect files
* @param fileSelector Filtering of wanted source files
* @return a list of files found at the given <code>filename</code>
* @throws RuntimeException if <code>filename</code> is not found
*/
private static List<DataSource> collect(String filename, SourceFileSelector fileSelector) {
File inputFile = new File(filename);
if (!inputFile.exists()) {
throw new RuntimeException("File " + inputFile.getName() + " doesn't exist");
}
List<DataSource> dataSources = new ArrayList<DataSource>();
if (!inputFile.isDirectory()) {
if (filename.endsWith(".zip") || filename.endsWith(".jar")) {
ZipFile zipFile;
try {
zipFile = new ZipFile(inputFile);
Enumeration<? extends ZipEntry> e = zipFile.entries();
while (e.hasMoreElements()) {
ZipEntry zipEntry = e.nextElement();
if (fileSelector.isWantedFile(zipEntry.getName())) {
dataSources.add(new ZipDataSource(zipFile, zipEntry));
}
}
} catch (IOException ze) {
throw new RuntimeException("Zip file " + inputFile.getName() + " can't be opened");
}
} else {
dataSources.add(new FileDataSource(inputFile));
}
} else {
FileFinder finder = new FileFinder();
List<File> files = finder.findFilesFrom(inputFile.getAbsolutePath(), new SourceFileOrDirectoryFilter(
fileSelector), true);
for (File f : files) {
dataSources.add(new FileDataSource(f));
}
}
return dataSources;
}
}
The table below shows all metrics for PMD.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 118.00 | Number of blocks | |
| BLOCK_COMMENT | 11.00 | Number of block comment lines | |
| COMMENTS | 121.00 | Comment lines | |
| COMMENT_DENSITY | 0.26 | Comment density | |
| COMPARISONS | 38.00 | Number of comparison operators | |
| CYCLOMATIC | 80.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 14.00 | Comments in declarations | |
| DOC_COMMENT | 99.00 | Number of javadoc comment lines | |
| ELOC | 458.00 | Effective lines of code | |
| EXEC_COMMENTS | 13.00 | Comments in executable code | |
| EXITS | 141.00 | Procedure exits | |
| FUNCTIONS | 23.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 83.28 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 103.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 1.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 4.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 1.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 1.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 26.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 4.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 6.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 1.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 3.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 4.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 669.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 1.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 7.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 1.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 6.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 1.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 1.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 4.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 1.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 4.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 759.00 | Number of lines in the source file | |
| LINE_COMMENT | 11.00 | Number of line comments | |
| LOC | 543.00 | Lines of code | |
| LOGICAL_LINES | 321.00 | Number of statements | |
| LOOPS | 3.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 1609.00 | Number of operands | |
| OPERATORS | 2676.00 | Number of operators | |
| PARAMS | 69.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 4285.00 | Halstead program length | |
| PROGRAM_VOCAB | 565.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 34.00 | Number of return points from functions | |
| SIZE | 26223.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 512.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 53.00 | Number of unique operators | |
| WHITESPACE | 95.00 | Number of whitespace lines | |