FindUnrelatedTypesInGenericContainer.java
| Index Score | ||
|---|---|---|
 |
 |
edu.umd.cs.findbugs.detect |
 |
 |
FindBugs |
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 | |
|---|---|---|
| EXEC_COMMENTS | Comments in executable code |  |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LINE_COMMENT | Number of line comments | |
| EXITS | Procedure exits | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| COMPARISONS | Number of comparison operators | |
| OPERANDS | Number of operands | |
| UNIQUE_OPERANDS | Number of unique operands | |
| SIZE | Size of the file in bytes | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| CYCLOMATIC | Cyclomatic complexity | |
| OPERATORS | Number of operators | |
| ELOC | Effective lines of code | |
| RETURNS | Number of return points from functions | |
| LOGICAL_LINES | Number of statements | |
| LINES | Number of lines in the source file | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| LOC | Lines of code | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0035 | JAVA0035 Missing braces in for statement | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0171 | JAVA0171 Unused local variable | |
| JAVA0123 | JAVA0123 Use all three components of for loop | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
/*
* 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.detect;
import java.util.Arrays;
import java.util.BitSet;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import org.apache.bcel.Constants;
import org.apache.bcel.Repository;
import org.apache.bcel.classfile.Attribute;
import org.apache.bcel.classfile.ConstantCP;
import org.apache.bcel.classfile.ConstantNameAndType;
import org.apache.bcel.classfile.JavaClass;
import org.apache.bcel.classfile.Method;
import org.apache.bcel.classfile.Synthetic;
import org.apache.bcel.generic.ArrayType;
import org.apache.bcel.generic.BasicType;
import org.apache.bcel.generic.ConstantPoolGen;
import org.apache.bcel.generic.Instruction;
import org.apache.bcel.generic.InstructionHandle;
import org.apache.bcel.generic.InvokeInstruction;
import org.apache.bcel.generic.MethodGen;
import org.apache.bcel.generic.ObjectType;
import org.apache.bcel.generic.ReferenceType;
import org.apache.bcel.generic.Type;
import edu.umd.cs.findbugs.BugAccumulator;
import edu.umd.cs.findbugs.BugInstance;
import edu.umd.cs.findbugs.BugReporter;
import edu.umd.cs.findbugs.Detector;
import edu.umd.cs.findbugs.SourceLineAnnotation;
import edu.umd.cs.findbugs.SystemProperties;
import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.ba.CFG;
import edu.umd.cs.findbugs.ba.CFGBuilderException;
import edu.umd.cs.findbugs.ba.ClassContext;
import edu.umd.cs.findbugs.ba.DataflowAnalysisException;
import edu.umd.cs.findbugs.ba.IncompatibleTypes;
import edu.umd.cs.findbugs.ba.Location;
import edu.umd.cs.findbugs.ba.MethodUnprofitableException;
import edu.umd.cs.findbugs.ba.SignatureParser;
import edu.umd.cs.findbugs.ba.generic.GenericObjectType;
import edu.umd.cs.findbugs.ba.generic.GenericUtilities;
import edu.umd.cs.findbugs.ba.generic.GenericUtilities.TypeCategory;
import edu.umd.cs.findbugs.ba.type.TopType;
import edu.umd.cs.findbugs.ba.type.TypeDataflow;
import edu.umd.cs.findbugs.ba.type.TypeFrame;
/**
* @author Nat Ayewah
*/
public class FindUnrelatedTypesInGenericContainer implements Detector {
private BugReporter bugReporter;
private static final boolean DEBUG = SystemProperties.getBoolean("gc.debug");
/**
* Map classname, methodname and signature to an int [].
* Each position in the int [] corresponds to an argument in the methodSignature.
* For each argument i, the value at position i corresponds to the index of the
* corresponding type in the class type parameters. If the argument
* has no correspondence, then the value is -1. <p>
*
* Get the String key by calling getCollectionsMapKey()
*/
private Map<String, int []> collectionsMap = new HashMap<String, int[]>();
/**
* @param triplet[0] = className.
* The name of the collection e.g. <code>java.util.List</code>
* @param triplet[1] = methodName.
* The method's name e.g. <code>contains</code>
* @param triplet[2] = methodSignature.
* The method's signature e.g. <code>(Ljava/lang/Object;)Z</code>
* @return
*/
public static String getCollectionsMapKey(String...triplet) {
return triplet[0] + "??" + triplet[1] + "???" + triplet[2];
}
private void addToCollectionsMap(String className, String methodName,
String methodSignature, int... argumentParameterIndex) {
collectionsMap.put(
getCollectionsMapKey(className, methodName, methodSignature),
argumentParameterIndex);
}
private void addToCollectionsMap(String [] classNames, String methodName,
String methodSignature, int... argumentParameterIndex) {
for (String className : classNames)
addToCollectionsMap(
className, methodName, methodSignature,
argumentParameterIndex);
}
String [] collectionMembers = new String [] {
"java.util.Collection",
"java.util.AbstractCollection",
"java.util.List",
"java.util.AbstractList",
"java.util.ArrayList",
"java.util.LinkedList",
"java.util.Set",
"java.util.SortedSet",
"java.util.LinkedHashSet",
"java.util.HashSet",
"java.util.TreeSet"
};
String [] mapMembers = new String [] {
"java.util.Map",
"java.util.AbstractMap",
"java.util.SortedMap",
"java.util.TreeMap",
"java.util.HashMap",
"java.util.LinkedHashMap",
"java.util.concurrent.ConcurrentHashMap",
"java.util.EnumMap",
"java.util.Hashtable",
"java.util.IdentityHashMap",
"java.util.WeakHashMap"
};
String [] listMembers = new String [] {
"java.util.List",
"java.util.AbstractList",
"java.util.ArrayList",
"java.util.LinkedList"
};
public FindUnrelatedTypesInGenericContainer(BugReporter bugReporter) {
this.bugReporter = bugReporter;
String basicSignature = "(Ljava/lang/Object;)Z";
String collectionSignature = "(Ljava/util/Collection<*>;)Z";
String indexSignature = "(Ljava/lang/Object;)I";
// Collection<E>
addToCollectionsMap(collectionMembers, "contains", basicSignature, 0);
//addToCollectionsMap(collectionMembers, "equals", basicSignature, 0);
addToCollectionsMap(collectionMembers, "remove", basicSignature, 0);
//addToCollectionsMap(collectionMembers, "containsAll", collectionSignature, 0);
//addToCollectionsMap(collectionMembers, "removeAll", collectionSignature, 0);
//addToCollectionsMap(collectionMembers, "retainAll", collectionSignature, 0);
// List<E>
addToCollectionsMap(listMembers, "indexOf", indexSignature, 0);
addToCollectionsMap(listMembers, "lastIndexOf", indexSignature, 0);
// Map<K,V>
addToCollectionsMap(mapMembers, "containsKey", basicSignature, 0);
addToCollectionsMap(mapMembers, "containsValue", basicSignature, 1);
// XXX these do not work, to support these need changeable return types
addToCollectionsMap(mapMembers, "get", basicSignature, 0);
addToCollectionsMap(mapMembers, "remove", basicSignature, 0);
}
/**
* Visit the class context
* @see edu.umd.cs.findbugs.Detector#visitClassContext(edu.umd.cs.findbugs.ba.ClassContext)
*/
public void visitClassContext(ClassContext classContext) {
JavaClass javaClass = classContext.getJavaClass();
Method[] methodList = javaClass.getMethods();
for (Method method : methodList) {
if (method.getCode() == null)
continue;
try {
analyzeMethod(classContext, method);
} catch (MethodUnprofitableException e) {
assert true; // move along; nothing to see
} catch (CFGBuilderException e) {
String msg = "Detector " + this.getClass().getName()
+ " caught exception while analyzing " + javaClass.getClassName() + "." + method.getName() + " : " + method.getSignature();
bugReporter.logError(msg , e);
} catch (DataflowAnalysisException e) {
String msg = "Detector " + this.getClass().getName()
+ " caught exception while analyzing " + javaClass.getClassName() + "." + method.getName() + " : " + method.getSignature();
bugReporter.logError(msg, e);
}
}
}
/**
* Use this to screen out methods that do not contain invocations.
*/
public boolean prescreen(ClassContext classContext, Method method) {
BitSet bytecodeSet = classContext.getBytecodeSet(method);
return bytecodeSet != null && (
bytecodeSet.get(Constants.INVOKEINTERFACE) ||
bytecodeSet.get(Constants.INVOKEVIRTUAL) ||
bytecodeSet.get(Constants.INVOKESPECIAL) ||
bytecodeSet.get(Constants.INVOKESTATIC) ||
bytecodeSet.get(Constants.INVOKENONVIRTUAL)
);
}
/**
* Methods marked with the "Synthetic" attribute do not appear
* in the source code
*/
private boolean isSynthetic(Method m) {
Attribute[] attrs = m.getAttributes();
for (Attribute attr : attrs) {
if (attr instanceof Synthetic)
return true;
}
return false;
}
private void analyzeMethod(ClassContext classContext, Method method)
throws CFGBuilderException, DataflowAnalysisException {
if (isSynthetic(method) || !prescreen(classContext, method))
return;
BugAccumulator accumulator = new BugAccumulator(bugReporter);
CFG cfg = classContext.getCFG(method);
TypeDataflow typeDataflow = classContext.getTypeDataflow(method);
ConstantPoolGen cpg = classContext.getConstantPoolGen();
MethodGen methodGen = classContext.getMethodGen(method);
if (methodGen == null) return;
String fullMethodName =
methodGen.getClassName() + "." + methodGen.getName();
String sourceFile = classContext.getJavaClass().getSourceFileName();
if (DEBUG) {
System.out.println("Checking " + fullMethodName);
}
// Process each instruction
for (Iterator<Location> iter = cfg.locationIterator(); iter.hasNext();) {
Location location = iter.next();
InstructionHandle handle = location.getHandle();
Instruction ins = handle.getInstruction();
// Only consider invoke instructions
if (!(ins instanceof InvokeInstruction))
continue;
InvokeInstruction inv = (InvokeInstruction)ins;
// check the relevance of this instruction
String [] itriplet = getInstructionTriplet(inv, cpg);
String [] triplet = getRelevantTriplet(itriplet);
if (triplet == null)
continue;
// get the list of parameter indexes for each argument position
int [] argumentParameterIndex =
collectionsMap.get( getCollectionsMapKey(triplet) );
TypeFrame frame = typeDataflow.getFactAtLocation(location);
if (!frame.isValid()) {
// This basic block is probably dead
continue;
}
Type operandType = frame.getTopValue();
if (operandType.equals(TopType.instance())) {
// unreachable
continue;
}
// Only consider generic...
Type objectType = frame.getInstance(inv, cpg);
if (!(objectType instanceof GenericObjectType))
continue;
GenericObjectType operand = (GenericObjectType) objectType;
// ... containers
if (!operand.hasParameters()) continue;
int numArguments = frame.getNumArguments(inv, cpg);
if (numArguments <= 0 || argumentParameterIndex.length != numArguments)
continue;
// compare containers type parameters to corresponding arguments
boolean match = true;
IncompatibleTypes [] matches = new IncompatibleTypes [numArguments];
for (int i=0; i<numArguments; i++) matches[i] = IncompatibleTypes.SEEMS_OK;
SignatureParser sigParser = new SignatureParser(inv.getSignature(cpg));
for (int ii=0; ii < numArguments; ii++) {
if (argumentParameterIndex[ii] < 0) continue; // not relevant argument
if (argumentParameterIndex[ii] >= operand.getNumParameters())
continue; // should never happen
Type parmType = operand.getParameterAt(argumentParameterIndex[ii]);
Type argType = frame.getArgument(inv, cpg, ii, sigParser);
matches[ii] = compareTypes(parmType, argType);
if (matches[ii] != IncompatibleTypes.SEEMS_OK) match = false;
}
if (match)
continue; // no bug
// Prepare bug report
SourceLineAnnotation sourceLineAnnotation = SourceLineAnnotation
.fromVisitedInstruction(classContext, methodGen, sourceFile, handle);
// Report a bug that mentions each of the failed arguments in matches
for (int i=0; i<numArguments; i++) {
if (matches[i] == IncompatibleTypes.SEEMS_OK) continue;
Type parmType = operand.getParameterAt(argumentParameterIndex[i]);
if (parmType instanceof GenericObjectType)
parmType = ((GenericObjectType)parmType).getUpperBound();
Type argType = frame.getArgument(inv, cpg, i, sigParser);
accumulator.accumulateBug(new BugInstance(this,
"GC_UNRELATED_TYPES", matches[i].getPriority())
.addClassAndMethod(methodGen, sourceFile)
//.addString(GenericUtilities.getString(parmType))
//.addString(GenericUtilities.getString(argType))
.addFoundAndExpectedType(argType.getSignature(), parmType.getSignature())
.addCalledMethod(methodGen, (InvokeInstruction) ins)
,sourceLineAnnotation);
}
}
accumulator.reportAccumulatedBugs();
}
/**
* Get a String triplet representing the information in this instruction:
* the className, methodName, and methodSignature
*/
private String [] getInstructionTriplet(InvokeInstruction inv, ConstantPoolGen cpg) {
// get the class name
ConstantCP ref = (ConstantCP) cpg.getConstant( inv.getIndex() );
String className = ref.getClass(cpg.getConstantPool());
// get the method name
ConstantNameAndType refNT =
(ConstantNameAndType) cpg.getConstant( ref.getNameAndTypeIndex() );
String methodName = refNT.getName(cpg.getConstantPool());
// get the method signature
String methodSignature = refNT.getSignature(cpg.getConstantPool());
return new String[] { className, methodName, methodSignature };
}
/**
* Given a triplet representing the className, methodName, and methodSignature
* of an instruction, check to see if it is in our collectionsMap. <p>
* [Not Implemented] If not, search harder to see if one of the super classes
* of className is in our collectionMap
*/
private @CheckForNull String [] getRelevantTriplet(String [] instructionTriplet) {
if (collectionsMap.containsKey( getCollectionsMapKey(instructionTriplet) ))
return instructionTriplet;
// HARDCODES
// Map "get" and "remove"
if (Arrays.asList(mapMembers).contains(instructionTriplet[0])) {
if ( "get" .equals(instructionTriplet[1]) ||
"remove".equals(instructionTriplet[1]) ) {
addToCollectionsMap(instructionTriplet[0],
instructionTriplet[1], instructionTriplet[2], 0);
return instructionTriplet;
}
}
// XXX The rest not implemented
// Not found
return null;
}
/**
* Compare to see if the argument <code>argType</code> passed to the method
* matches the type of the corresponding parameter. The simplest case is when
* both are equal. <p>
* This is a conservative comparison - returns true if it cannot decide.
* If the parameter type is a type variable (e.g. <code>T</code>) then we don't
* know enough (yet) to decide if they do not match so return true.
*/
private IncompatibleTypes compareTypes(Type parmType, Type argType) {
// XXX equality not implemented for GenericObjectType
// if (parmType.equals(argType)) return true;
// Compare type signatures instead
String parmString = GenericUtilities.getString(parmType);
String argString = GenericUtilities.getString(argType);
if (parmString.equals(argString)) return IncompatibleTypes.SEEMS_OK;
// if either type is java.lang.Object, then automatically true!
// again compare strings...
String objString = GenericUtilities.getString(Type.OBJECT);
if ( parmString.equals(objString) ||
argString.equals(objString) ) {
return IncompatibleTypes.SEEMS_OK;
}
// get a category for each type
TypeCategory parmCat = GenericUtilities.getTypeCategory(parmType);
TypeCategory argCat = GenericUtilities.getTypeCategory(argType);
// -~- plain objects are easy
if ( parmCat == TypeCategory.PLAIN_OBJECT_TYPE &&
argCat == TypeCategory.PLAIN_OBJECT_TYPE )
return IncompatibleTypes.getPriorityForAssumingCompatible(parmType, argType);
// -~- parmType is: "? extends Another Type" OR "? super Another Type"
if ( parmCat == TypeCategory.WILDCARD_EXTENDS ||
parmCat == TypeCategory.WILDCARD_SUPER )
return compareTypes(
((GenericObjectType)parmType).getExtension(), argType);
// -~- Not handling type variables
if ( parmCat == TypeCategory.TYPE_VARIABLE ||
argCat == TypeCategory.TYPE_VARIABLE )
return IncompatibleTypes.SEEMS_OK;
// -~- Array Types: compare dimensions, then base type
if ( parmCat == TypeCategory.ARRAY_TYPE &&
argCat == TypeCategory.ARRAY_TYPE ) {
ArrayType parmArray = (ArrayType) parmType;
ArrayType argArray = (ArrayType) argType;
if (parmArray.getDimensions() != argArray.getDimensions())
return IncompatibleTypes.ARRAY_AND_NON_ARRAY;
return compareTypes(parmArray.getBasicType(), argArray.getBasicType());
}
// If one is an Array Type and the other is not, then they
// are incompatible. (We already know neither is java.lang.Object)
if ( parmCat == TypeCategory.ARRAY_TYPE ^
argCat == TypeCategory.ARRAY_TYPE ) {
return IncompatibleTypes.ARRAY_AND_NON_ARRAY;
}
if (parmCat == TypeCategory.PARAMETERIZED && argCat == TypeCategory.PLAIN_OBJECT_TYPE) {
return IncompatibleTypes.getPriorityForAssumingCompatible(((GenericObjectType)parmType).getObjectType(), argType);
}
if (parmCat == TypeCategory.PLAIN_OBJECT_TYPE && argCat == TypeCategory.PARAMETERIZED) {
return IncompatibleTypes.getPriorityForAssumingCompatible(parmType, ((GenericObjectType)argType).getObjectType());
}
// -~- Parameter Types: compare base type then parameters
if ( parmCat == TypeCategory.PARAMETERIZED &&
argCat == TypeCategory.PARAMETERIZED ) {
GenericObjectType parmGeneric = (GenericObjectType) parmType;
GenericObjectType argGeneric = (GenericObjectType) argType;
// base types should be related
return compareTypes( parmGeneric.getObjectType(),
argGeneric.getObjectType());
// XXX More to come
}
// If one is a Parameter Type and the other is not, then they
// are incompatible. (We already know neither is java.lang.Object)
if (false) {
// not true. Consider class Foo extends ArrayList<String>
if ( parmCat == TypeCategory.PARAMETERIZED ^
argCat == TypeCategory.PARAMETERIZED ) {
return IncompatibleTypes.SEEMS_OK; // fix this when we know what we are doing here
}
}
// -~- Wildcard e.g. List<*>.contains(...)
if (parmCat == TypeCategory.WILDCARD) // No Way to know
return IncompatibleTypes.SEEMS_OK;
// -~- Non Reference types
// if ( parmCat == TypeCategory.NON_REFERENCE_TYPE ||
// argCat == TypeCategory.NON_REFERENCE_TYPE )
if (parmType instanceof BasicType || argType instanceof BasicType) {
// this should not be possible, compiler will complain (pre 1.5)
// or autobox primitive types (1.5 +)
throw new IllegalArgumentException("checking for compatibility of " + parmType + " with " + argType);
}
return IncompatibleTypes.SEEMS_OK;
}
// old version of compare types
private boolean compareTypesOld(Type parmType, Type argType) {
// XXX equality not implemented for GenericObjectType
// if (parmType.equals(argType)) return true;
// Compare type signatures instead
if (GenericUtilities.getString(parmType)
.equals(GenericUtilities.getString(argType)))
return true;
if (parmType instanceof GenericObjectType) {
GenericObjectType o = (GenericObjectType) parmType;
if (o.getTypeCategory() == GenericUtilities.TypeCategory.WILDCARD_EXTENDS) {
return compareTypesOld(o.getExtension(), argType);
}
}
// ignore type variables for now
if (parmType instanceof GenericObjectType &&
!((GenericObjectType) parmType).hasParameters()) return true;
if (argType instanceof GenericObjectType &&
!((GenericObjectType) argType).hasParameters()) return true;
// Case: Both are generic containers
if (parmType instanceof GenericObjectType && argType instanceof GenericObjectType) {
return true;
} else {
// Don't consider non reference types (should not be possible)
if (!(parmType instanceof ReferenceType && argType instanceof ReferenceType))
return true;
// Don't consider non object types (for now)
if (!(parmType instanceof ObjectType && argType instanceof ObjectType))
return true;
// Otherwise, compare base types ignoring generic information
try {
return Repository.instanceOf(
((ObjectType)argType).getClassName(),
((ObjectType)parmType).getClassName());
} catch (ClassNotFoundException e) {}
}
return true;
}
/**
* Empty
* @see edu.umd.cs.findbugs.Detector#report()
*/
public void report() {
}
}
The table below shows all metrics for FindUnrelatedTypesInGenericContainer.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 42.00 | Number of blocks | |
| BLOCK_COMMENT | 18.00 | Number of block comment lines | |
| COMMENTS | 133.00 | Comment lines | |
| COMMENT_DENSITY | 0.44 | Comment density | |
| COMPARISONS | 65.00 | Number of comparison operators | |
| CYCLOMATIC | 84.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 12.00 | Comments in declarations | |
| DOC_COMMENT | 54.00 | Number of javadoc comment lines | |
| ELOC | 304.00 | Effective lines of code | |
| EXEC_COMMENTS | 46.00 | Comments in executable code | |
| EXITS | 82.00 | Procedure exits | |
| FUNCTIONS | 13.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 0.57 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 72.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 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 1.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 | 27.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 1.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 | 1.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 | 9.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 5.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 | 1.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 | 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 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 2.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 | 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 | 2.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1064.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 | 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 | 0.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 | 1.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 | 1.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 | 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 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 1.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.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 | 0.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 | |
| JAVA0289 | 3.00 | null | |
| LINES | 564.00 | Number of lines in the source file | |
| LINE_COMMENT | 61.00 | Number of line comments | |
| LOC | 341.00 | Lines of code | |
| LOGICAL_LINES | 179.00 | Number of statements | |
| LOOPS | 4.00 | Number of loops | |
| NEST_DEPTH | 3.00 | Maximum nesting depth | |
| OPERANDS | 1042.00 | Number of operands | |
| OPERATORS | 1672.00 | Number of operators | |
| PARAMS | 23.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2714.00 | Halstead program length | |
| PROGRAM_VOCAB | 359.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 49.00 | Number of return points from functions | |
| SIZE | 20446.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 307.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 52.00 | Number of unique operators | |
| WHITESPACE | 90.00 | Number of whitespace lines | |