CheckStyleTask.java
| Index Score | ||
|---|---|---|
 |
 |
com.puppycrawl.tools.checkstyle |
 |
|
Checkstyle |
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 | |
|---|---|---|
| DECL_COMMENTS | Comments in declarations |  |
| LINE_COMMENT | Number of line comments | |
| SIZE | Size of the file in bytes | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| EXITS | Procedure exits | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0160 | JAVA0160 Method does not throw specified exception | |
| LINES | Number of lines in the source file | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| RETURNS | Number of return points from functions | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0137 | JAVA0137 Non-abstract class missing constructor | |
| FUNCTIONS | Number of function declarations | |
| LOC | Lines of code | |
| COMMENTS | Comment lines | |
| BLOCKS | Number of blocks | |
| LOGICAL_LINES | Number of statements | |
| OPERATORS | Number of operators | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| OPERANDS | Number of operands | |
| ELOC | Effective lines of code | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| EXEC_COMMENTS | Comments in executable code | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0288 | JAVA0288 Inconsistent null check | |
| UNIQUE_OPERATORS | Number of unique operators | |
| LOOPS | Number of loops | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2007 Oliver Burn
//
// 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 com.puppycrawl.tools.checkstyle;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Properties;
import java.util.Hashtable;
import java.util.ResourceBundle;
import java.net.URL;
import com.puppycrawl.tools.checkstyle.api.AuditListener;
import com.puppycrawl.tools.checkstyle.api.Configuration;
import com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter;
import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
import org.apache.tools.ant.AntClassLoader;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.DirectoryScanner;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.taskdefs.LogOutputStream;
import org.apache.tools.ant.types.EnumeratedAttribute;
import org.apache.tools.ant.types.FileSet;
import org.apache.tools.ant.types.Path;
import org.apache.tools.ant.types.Reference;
/**
* An implementation of a ANT task for calling checkstyle. See the documentation
* of the task for usage.
* @author Oliver Burn
*/
public class CheckStyleTask extends Task
{
/** poor man's enum for an xml formatter */
private static final String E_XML = "xml";
/** poor man's enum for an plain formatter */
private static final String E_PLAIN = "plain";
/** class path to locate class files */
private Path mClasspath;
/** name of file to check */
private String mFileName;
/** config file containing configuration */
private String mConfigLocation;
/** contains package names */
private File mPackageNamesFile;
/** whether to fail build on violations */
private boolean mFailOnViolation = true;
/** property to set on violations */
private String mFailureProperty;
/** contains the filesets to process */
private final List mFileSets = new ArrayList();
/** contains the formatters to log to */
private final List mFormatters = new ArrayList();
/** contains the Properties to override */
private final List mOverrideProps = new ArrayList();
/** the name of the properties file */
private File mPropertiesFile;
/** the maximum number of errors that are tolerated. */
private int mMaxErrors;
/** the maximum number of warnings that are tolerated. */
private int mMaxWarnings = Integer.MAX_VALUE;
////////////////////////////////////////////////////////////////////////////
// Setters for ANT specific attributes
////////////////////////////////////////////////////////////////////////////
/**
* Tells this task to set the named property to "true" when there
* is a violation.
* @param aPropertyName the name of the property to set
* in the event of an failure.
*/
public void setFailureProperty(String aPropertyName)
{
mFailureProperty = aPropertyName;
}
/** @param aFail whether to fail if a violation is found */
public void setFailOnViolation(boolean aFail)
{
mFailOnViolation = aFail;
}
/**
* Sets the maximum number of errors allowed. Default is 0.
* @param aMaxErrors the maximum number of errors allowed.
*/
public void setMaxErrors(int aMaxErrors)
{
mMaxErrors = aMaxErrors;
}
/**
* Sets the maximum number of warings allowed. Default is
* {@link Integer#MAX_VALUE}.
* @param aMaxWarnings the maximum number of warnings allowed.
*/
public void setMaxWarnings(int aMaxWarnings)
{
mMaxWarnings = aMaxWarnings;
}
/**
* Adds a set of files (nested fileset attribute).
* @param aFS the file set to add
*/
public void addFileset(FileSet aFS)
{
mFileSets.add(aFS);
}
/**
* Add a formatter.
* @param aFormatter the formatter to add for logging.
*/
public void addFormatter(Formatter aFormatter)
{
mFormatters.add(aFormatter);
}
/**
* Add an override property.
* @param aProperty the property to add
*/
public void addProperty(Property aProperty)
{
mOverrideProps.add(aProperty);
}
/**
* Set the class path.
* @param aClasspath the path to locate classes
*/
public void setClasspath(Path aClasspath)
{
if (mClasspath == null) {
mClasspath = aClasspath;
}
else {
mClasspath.append(aClasspath);
}
}
/**
* Set the class path from a reference defined elsewhere.
* @param aClasspathRef the reference to an instance defining the classpath
*/
public void setClasspathRef(Reference aClasspathRef)
{
createClasspath().setRefid(aClasspathRef);
}
/** @return a created path for locating classes */
public Path createClasspath()
{
if (mClasspath == null) {
mClasspath = new Path(getProject());
}
return mClasspath.createPath();
}
/** @param aFile the file to be checked */
public void setFile(File aFile)
{
mFileName = aFile.getAbsolutePath();
}
/** @param aFile the configuration file to use */
public void setConfig(File aFile)
{
setConfigLocation(aFile.getAbsolutePath());
}
/** @param aURL the URL of the configuration to use */
public void setConfigURL(URL aURL)
{
setConfigLocation(aURL.toExternalForm());
}
/**
* Sets the location of the configuration.
* @param aLocation the location, which is either a
*/
private void setConfigLocation(String aLocation)
{
if (mConfigLocation != null) {
throw new BuildException("Attributes 'config' and 'configURL' "
+ "must not be set at the same time");
}
mConfigLocation = aLocation;
}
/** @param aFile the package names file to use */
public void setPackageNamesFile(File aFile)
{
mPackageNamesFile = aFile;
}
////////////////////////////////////////////////////////////////////////////
// Setters for Checker configuration attributes
////////////////////////////////////////////////////////////////////////////
/**
* Sets a properties file for use instead
* of individually setting them.
* @param aProps the properties File to use
*/
public void setProperties(File aProps)
{
mPropertiesFile = aProps;
}
////////////////////////////////////////////////////////////////////////////
// The doers
////////////////////////////////////////////////////////////////////////////
/**
* Actually checks the files specified. All errors are reported to
* System.out. Will fail if any errors occurred.
* @throws BuildException an error occurred
*/
public void execute() throws BuildException
{
final long startTime = System.currentTimeMillis();
final ClassLoader loader = Thread.currentThread()
.getContextClassLoader();
try {
Thread.currentThread().setContextClassLoader(
getClass().getClassLoader());
realExecute();
}
finally {
Thread.currentThread().setContextClassLoader(loader);
final long endTime = System.currentTimeMillis();
log("Total execution took " + (endTime - startTime) + " ms.",
Project.MSG_VERBOSE);
}
}
/**
* Helper implementation to perform execution.
*/
private void realExecute()
{
// output version info in debug mode
final ResourceBundle compilationProperties = ResourceBundle
.getBundle("checkstylecompilation");
final String version = compilationProperties
.getString("checkstyle.compile.version");
final String compileTimestamp = compilationProperties
.getString("checkstyle.compile.timestamp");
log("checkstyle version " + version, Project.MSG_VERBOSE);
log("compiled on " + compileTimestamp, Project.MSG_VERBOSE);
// Check for no arguments
if ((mFileName == null) && (mFileSets.size() == 0)) {
throw new BuildException(
"Must specify atleast one of 'file' or nested 'fileset'.",
getLocation());
}
if (mConfigLocation == null) {
throw new BuildException("Must specify 'config'.", getLocation());
}
// Create the checker
Checker c = null;
try {
c = createChecker();
final SeverityLevelCounter warningCounter =
new SeverityLevelCounter(SeverityLevel.WARNING);
c.addListener(warningCounter);
// Process the files
long startTime = System.currentTimeMillis();
final File[] files = scanFileSets();
long endTime = System.currentTimeMillis();
log("To locate the files took " + (endTime - startTime) + " ms.",
Project.MSG_VERBOSE);
log("Running Checkstyle " + version + " on " + files.length
+ " files", Project.MSG_INFO);
log("Using configuration " + mConfigLocation, Project.MSG_VERBOSE);
startTime = System.currentTimeMillis();
final int numErrs = c.process(files);
endTime = System.currentTimeMillis();
log("To process the files took " + (endTime - startTime) + " ms.",
Project.MSG_VERBOSE);
final int numWarnings = warningCounter.getCount();
final boolean ok = (numErrs <= mMaxErrors)
&& (numWarnings <= mMaxWarnings);
// Handle the return status
if (!ok) {
final String failureMsg =
"Got " + numErrs + " errors and " + numWarnings
+ " warnings.";
if (mFailureProperty != null) {
getProject().setProperty(mFailureProperty, failureMsg);
}
if (mFailOnViolation) {
throw new BuildException(failureMsg, getLocation());
}
}
}
finally {
if (c != null) {
c.destroy();
}
}
}
/**
* Creates new instance of <code>Checker</code>.
* @return new instance of <code>Checker</code>
*/
private Checker createChecker()
{
Checker c = null;
try {
final Properties props = createOverridingProperties();
final Configuration config = ConfigurationLoader.loadConfiguration(
mConfigLocation, new PropertiesExpander(props), true);
final DefaultContext context = new DefaultContext();
final ClassLoader loader = new AntClassLoader(getProject(),
mClasspath);
context.add("classloader", loader);
c = new Checker();
//load the set of package names
if (mPackageNamesFile != null) {
final ModuleFactory moduleFactory = PackageNamesLoader
.loadModuleFactory(mPackageNamesFile.getAbsolutePath());
c.setModuleFactory(moduleFactory);
}
c.contextualize(context);
c.configure(config);
// setup the listeners
final AuditListener[] listeners = getListeners();
for (int i = 0; i < listeners.length; i++) {
c.addListener(listeners[i]);
}
}
catch (final Exception e) {
throw new BuildException("Unable to create a Checker: "
+ e.getMessage(), e);
}
return c;
}
/**
* Create the Properties object based on the arguments specified
* to the ANT task.
* @return the properties for property expansion expansion
* @throws BuildException if an error occurs
*/
private Properties createOverridingProperties()
{
final Properties retVal = new Properties();
// Load the properties file if specified
if (mPropertiesFile != null) {
FileInputStream inStream = null;
try {
inStream = new FileInputStream(mPropertiesFile);
retVal.load(inStream);
}
catch (final FileNotFoundException e) {
throw new BuildException("Could not find Properties file '"
+ mPropertiesFile + "'", e, getLocation());
}
catch (final IOException e) {
throw new BuildException("Error loading Properties file '"
+ mPropertiesFile + "'", e, getLocation());
}
finally {
try {
if (inStream != null) {
inStream.close();
}
}
catch (final IOException e) {
throw new BuildException("Error closing Properties file '"
+ mPropertiesFile + "'", e, getLocation());
}
}
}
// override with Ant properties like ${basedir}
final Hashtable antProps = this.getProject().getProperties();
for (final Iterator it = antProps.keySet().iterator(); it.hasNext();) {
final String key = (String) it.next();
final String value = String.valueOf(antProps.get(key));
retVal.put(key, value);
}
// override with properties specified in subelements
for (final Iterator it = mOverrideProps.iterator(); it.hasNext();) {
final Property p = (Property) it.next();
retVal.put(p.getKey(), p.getValue());
}
return retVal;
}
/**
* Return the list of listeners set in this task.
* @return the list of listeners.
* @throws ClassNotFoundException if an error occurs
* @throws InstantiationException if an error occurs
* @throws IllegalAccessException if an error occurs
* @throws IOException if an error occurs
*/
protected AuditListener[] getListeners() throws ClassNotFoundException,
InstantiationException, IllegalAccessException, IOException
{
final int formatterCount = Math.max(1, mFormatters.size());
final AuditListener[] listeners = new AuditListener[formatterCount];
// formatters
if (mFormatters.size() == 0) {
final OutputStream debug = new LogOutputStream(this,
Project.MSG_DEBUG);
final OutputStream err = new LogOutputStream(this, Project.MSG_ERR);
listeners[0] = new DefaultLogger(debug, true, err, true);
}
else {
for (int i = 0; i < formatterCount; i++) {
final Formatter f = (Formatter) mFormatters.get(i);
listeners[i] = f.createListener(this);
}
}
return listeners;
}
/**
* returns the list of files (full path name) to process.
* @return the list of files included via the filesets.
*/
protected File[] scanFileSets()
{
final ArrayList list = new ArrayList();
if (mFileName != null) {
// oops we've got an additional one to process, don't
// forget it. No sweat, it's fully resolved via the setter.
log("Adding standalone file for audit", Project.MSG_VERBOSE);
list.add(new File(mFileName));
}
for (int i = 0; i < mFileSets.size(); i++) {
final FileSet fs = (FileSet) mFileSets.get(i);
final DirectoryScanner ds = fs.getDirectoryScanner(getProject());
ds.scan();
final String[] names = ds.getIncludedFiles();
log(i + ") Adding " + names.length + " files from directory "
+ ds.getBasedir(), Project.MSG_VERBOSE);
for (int j = 0; j < names.length; j++) {
final String pathname = ds.getBasedir() + File.separator
+ names[j];
list.add(new File(pathname));
}
}
return (File[]) list.toArray(new File[0]);
}
/**
* Poor mans enumeration for the formatter types.
* @author Oliver Burn
*/
public static class FormatterType extends EnumeratedAttribute
{
/** my possible values */
private static final String[] VALUES = {E_XML, E_PLAIN};
/** {@inheritDoc} */
public String[] getValues()
{
return VALUES;
}
}
/**
* Details about a formatter to be used.
* @author Oliver Burn
*/
public static class Formatter
{
/** the formatter type */
private FormatterType mFormatterType;
/** the file to output to */
private File mToFile;
/** Whether or not the write to the named file. */
private boolean mUseFile = true;
/**
* Set the type of the formatter.
* @param aType the type
*/
public void setType(FormatterType aType)
{
final String val = aType.getValue();
if (!E_XML.equals(val) && !E_PLAIN.equals(val)) {
throw new BuildException("Invalid formatter type: " + val);
}
mFormatterType = aType;
}
/**
* Set the file to output to.
* @param aTo the file to output to
*/
public void setTofile(File aTo)
{
mToFile = aTo;
}
/**
* Sets whether or not we write to a file if it is provided.
* @param aUse whether not not to use provided file.
*/
public void setUseFile(boolean aUse)
{
mUseFile = aUse;
}
/**
* Creates a listener for the formatter.
* @param aTask the task running
* @return a listener
* @throws IOException if an error occurs
*/
public AuditListener createListener(Task aTask) throws IOException
{
if ((mFormatterType != null)
&& E_XML.equals(mFormatterType.getValue()))
{
return createXMLLogger(aTask);
}
return createDefaultLogger(aTask);
}
/**
* @return a DefaultLogger instance
* @param aTask the task to possibly log to
* @throws IOException if an error occurs
*/
private AuditListener createDefaultLogger(Task aTask)
throws IOException
{
if ((mToFile == null) || !mUseFile) {
return new DefaultLogger(
new LogOutputStream(aTask, Project.MSG_DEBUG),
true, new LogOutputStream(aTask, Project.MSG_ERR), true);
}
return new DefaultLogger(new FileOutputStream(mToFile), true);
}
/**
* @return an XMLLogger instance
* @param aTask the task to possibly log to
* @throws IOException if an error occurs
*/
private AuditListener createXMLLogger(Task aTask) throws IOException
{
if ((mToFile == null) || !mUseFile) {
return new XMLLogger(new LogOutputStream(aTask,
Project.MSG_INFO), true);
}
return new XMLLogger(new FileOutputStream(mToFile), true);
}
}
/**
* Represents a property that consists of a key and value.
*/
public static class Property
{
/** the property key */
private String mKey;
/** the property value */
private String mValue;
/** @return the property key */
public String getKey()
{
return mKey;
}
/** @param aKey sets the property key */
public void setKey(String aKey)
{
mKey = aKey;
}
/** @return the property value */
public String getValue()
{
return mValue;
}
/** @param aValue set the property value */
public void setValue(String aValue)
{
mValue = aValue;
}
/** @param aValue set the property value from a File */
public void setFile(File aValue)
{
setValue(aValue.getAbsolutePath());
}
}
/** Represents a custom listener. */
public static class Listener
{
/** classname of the listener class */
private String mClassname;
/** @return the classname */
public String getClassname()
{
return mClassname;
}
/** @param aClassname set the classname */
public void setClassname(String aClassname)
{
mClassname = aClassname;
}
}
}
The table below shows all metrics for CheckStyleTask.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 74.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 194.00 | Comment lines | |
| COMMENT_DENSITY | 0.69 | Comment density | |
| COMPARISONS | 30.00 | Number of comparison operators | |
| CYCLOMATIC | 70.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 83.00 | Comments in declarations | |
| DOC_COMMENT | 154.00 | Number of javadoc comment lines | |
| ELOC | 281.00 | Effective lines of code | |
| EXEC_COMMENTS | 12.00 | Comments in executable code | |
| EXITS | 64.00 | Procedure exits | |
| FUNCTIONS | 36.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 63.11 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 78.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 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.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 | 0.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 | 0.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 | 1.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 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 1.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 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 1.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.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 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 4.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.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 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.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 | 3.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 | 1.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 | 0.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 | 0.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 | 2.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.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 | 1.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 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 2.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 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 1.00 | JAVA0288 Inconsistent null check | |
| LINES | 678.00 | Number of lines in the source file | |
| LINE_COMMENT | 40.00 | Number of line comments | |
| LOC | 402.00 | Lines of code | |
| LOGICAL_LINES | 182.00 | Number of statements | |
| LOOPS | 6.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 804.00 | Number of operands | |
| OPERATORS | 1534.00 | Number of operators | |
| PARAMS | 25.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2338.00 | Halstead program length | |
| PROGRAM_VOCAB | 339.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 53.00 | Number of return points from functions | |
| SIZE | 22142.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 293.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 46.00 | Number of unique operators | |
| WHITESPACE | 82.00 | Number of whitespace lines | |