CodeInspector.java
| Index Score | ||
|---|---|---|
 |
 |
de.hunsicker.jalopy.language |
 |
 |
Jalopy |
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 | |
|---|---|---|
| SIZE | Size of the file in bytes |  |
| CYCLOMATIC | Cyclomatic complexity | |
| LOC | Lines of code | |
| ELOC | Effective lines of code | |
| LINES | Number of lines in the source file | |
| COMPARISONS | Number of comparison operators | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERANDS | Number of operands | |
| LOGICAL_LINES | Number of statements | |
| BLOCKS | Number of blocks | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| WHITESPACE | Number of whitespace lines | |
| DECL_COMMENTS | Comments in declarations | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| RETURNS | Number of return points from functions | |
| EXITS | Procedure exits | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| DOC_COMMENT | Number of javadoc comment lines | |
| LOOPS | Number of loops | |
| FUNCTIONS | Number of function declarations | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| COMMENTS | Comment lines | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0039 | JAVA0039 Break statement with label | |
| JAVA0077 | JAVA0077 Private field not used in declaring class | |
| JAVA0009 | JAVA0009 Protected member in final class | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0040 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0031 | JAVA0031 Case statement not properly closed | |
| NEST_DEPTH | Maximum nesting depth | |
| LINE_COMMENT | Number of line comments | |
| JAVA0022 | JAVA0022 Static final field name does not have required form | |
| EXEC_COMMENTS | Comments in executable code | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0259 | JAVA0259 Return of collection/array field | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0020 | JAVA0020 Field name does not have required form | |
| JAVA0029 | JAVA0029 Private method not used | |
| JAVA0287 | JAVA0287 Unnecessary null check | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
/*
* Copyright (c) 2001-2002, Marco Hunsicker. All rights reserved.
*
* This software is distributable under the BSD license. See the terms of the
* BSD license in the documentation provided with this software.
*/
package de.hunsicker.jalopy.language;
import java.io.File;
import java.lang.reflect.Modifier;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
import antlr.CommonHiddenStreamToken;
import antlr.collections.AST;
import de.hunsicker.jalopy.language.antlr.JavaNode;
import de.hunsicker.jalopy.language.antlr.JavaTokenTypes;
import de.hunsicker.jalopy.storage.Convention;
import de.hunsicker.jalopy.storage.ConventionDefaults;
import de.hunsicker.jalopy.storage.ConventionKeys;
import de.hunsicker.util.ResourceBundleFactory;
/**
* Inspects a Java parse tree for convention violations and possible code weaknesses.
*
* @author <a href="http://jalopy.sf.net/contact.html">Marco Hunsicker</a>
* @version $Revision: 1.7 $
*
* @since 1.0b8
*/
public final class CodeInspector
extends TreeWalker
{
//~ Static variables/initializers ----------------------------------------------------
/** Type names for which a base type should be favored. */
private static final List _favorableTypes = new ArrayList(20); // List of <String>
/** Collection type names. */
private static final List _collectionTypes = new ArrayList(28); // List of <String>
/** The cache with the regular expression patterns. */
private static final HashMap _patternMap = new HashMap(30);
/** The name for ResourceBundle lookup. */
private static final String BUNDLE_NAME =
"de.hunsicker.jalopy.language.Bundle" /* NOI18N */;
/** The code convention. */
protected static final Convention _settings = Convention.getInstance();
private static final String STR_boolean = "boolean" /* NOI18N */;
private static final String STR_Object = "Object" /* NOI18N */;
private static final String STR_equals = "equals" /* NOI18N */;
private static final String STR_javalangObject = "java.lang.Object" /* NOI18N */;
private static final String STR_String = "String" /* NOI18N */;
private static final String STR_toString = "toString" /* NOI18N */;
private static final String STR_void = "void" /* NOI18N */;
private static final String STR_finalize = "finalize" /* NOI18N */;
private static final String STR_int = "int" /* NOI18N */;
private static final String STR_hashCode = "hashCode" /* NOI18N */;
private static final String STR_wait = "wait" /* NOI18N */;
private static final String STR_Exception = "Exception" /* NOI18N */;
private static final String STR_Throwable = "Throwable" /* NOI18N */;
private static final String STR_STRING_LITERAL_I18N =
"STRING_LITERAL_I18N" /* NOI18N */;
private static final String STR_OBEY_CONTRACT_EQUALS =
"OBEY_CONTRACT_EQUALS" /* NOI18N */;
private static final String STR_DONT_SUBSTITUTE_OBJECT_EQUALS =
"DONT_SUBSTITUTE_OBJECT_EQUALS" /* NOI18N */;
private static final String STR_OVERRIDE_HASHCODE = "OVERRIDE_HASHCODE" /* NOI18N */;
private static final String STR_OVERRIDE_TO_STRING =
"OVERRIDE_TO_STRING" /* NOI18N */;
private static final String STR_RETURN_ZERO_ARRAY = "RETURN_ZERO_ARRAY" /* NOI18N */;
private static final String STR_INTERFACE_ONLY_FOR_TYPE =
"INTERFACE_ONLY_FOR_TYPE" /* NOI18N */;
private static final String STR_REPLACE_STRUCTURE_WITH_CLASS =
"REPLACE_STRUCTURE_WITH_CLASS" /* NOI18N */;
private static final String STR_REFER_BY_INTERFACE =
"REFER_BY_INTERFACE" /* NOI18N */;
private static final String STR_VARIABLE_SHADOW = "VARIABLE_SHADOW" /* NOI18N */;
private static final String STR_DONT_IGNORE_EXCEPTION =
"DONT_IGNORE_EXCEPTION" /* NOI18N */;
private static final String STR_NEVER_THROW_EXCEPTION =
"NEVER_THROW_EXCEPTION" /* NOI18N */;
private static final String STR_NEVER_THROW_THROWABLE =
"NEVER_THROW_THROWABLE" /* NOI18N */;
private static final String STR_DECLARE_COLLECTION_COMMENT =
"DECLARE_COLLECTION_COMMENT" /* NOI18N */;
private static final String STR_WRONG_COLLECTION_COMMENT =
"WRONG_COLLECTION_COMMENT" /* NOI18N */;
private static final String STR_EMPTY_FINALLY = "EMPTY_FINALLY" /* NOI18N */;
private static final String STR_NEVER_WAIT_OUTSIDE_LOOP =
"NEVER_WAIT_OUTSIDE_LOOP" /* NOI18N */;
private static final String STR_NAMING_CONVENTION = "NAMING_CONVENTION" /* NOI18N */;
private static final String EMPTY_STRING = "" /* NOI18N */;
static
{
_favorableTypes.add("Vector" /* NOI18N */);
_favorableTypes.add("ArrayList" /* NOI18N */);
_favorableTypes.add("HashSet" /* NOI18N */);
_favorableTypes.add("TreeSet" /* NOI18N */);
_favorableTypes.add("HashMap" /* NOI18N */);
_favorableTypes.add("TreeMap" /* NOI18N */);
_favorableTypes.add("IdentityHashMap" /* NOI18N */);
_favorableTypes.add("WeakHashMap" /* NOI18N */);
_favorableTypes.add("Hashtable" /* NOI18N */);
_favorableTypes.add("java.util.ArrayList" /* NOI18N */);
_favorableTypes.add("java.util.Vector" /* NOI18N */);
_favorableTypes.add("java.util.HashSet" /* NOI18N */);
_favorableTypes.add("java.util.TreeSet" /* NOI18N */);
_favorableTypes.add("java.util.HashMap" /* NOI18N */);
_favorableTypes.add("java.util.TreeMap" /* NOI18N */);
_favorableTypes.add("java.util.IdentityHashMap" /* NOI18N */);
_favorableTypes.add("java.util.WeakHashMap" /* NOI18N */);
_favorableTypes.add("java.util.Hashtable" /* NOI18N */);
_collectionTypes.add("Collection" /* NOI18N */);
_collectionTypes.add("List" /* NOI18N */);
_collectionTypes.add("ArrayList" /* NOI18N */);
_collectionTypes.add("LinkedList" /* NOI18N */);
_collectionTypes.add("Vector" /* NOI18N */);
_collectionTypes.add("Set" /* NOI18N */);
_collectionTypes.add("ArraySet" /* NOI18N */);
_collectionTypes.add("HashSet" /* NOI18N */);
_collectionTypes.add("LinkedHashSet" /* NOI18N */);
_collectionTypes.add("SortedSet" /* NOI18N */);
_collectionTypes.add("TreeSet" /* NOI18N */);
_collectionTypes.add("Map" /* NOI18N */);
_collectionTypes.add("SortedMap" /* NOI18N */);
_collectionTypes.add("HashMap" /* NOI18N */);
_collectionTypes.add("Hashtable" /* NOI18N */);
_collectionTypes.add("TreeMap" /* NOI18N */);
_collectionTypes.add("IdentityHashMap" /* NOI18N */);
_collectionTypes.add("WeakHashMap" /* NOI18N */);
_collectionTypes.add("java.util.Collection" /* NOI18N */);
_collectionTypes.add("java.util.List" /* NOI18N */);
_collectionTypes.add("java.util.ArrayList" /* NOI18N */);
_collectionTypes.add("java.util.LinkedList" /* NOI18N */);
_collectionTypes.add("java.util.Vector" /* NOI18N */);
_collectionTypes.add("java.util.Set" /* NOI18N */);
_collectionTypes.add("java.util.ArraySet" /* NOI18N */);
_collectionTypes.add("java.util.HashSet" /* NOI18N */);
_collectionTypes.add("java.util.LinkedHashSet" /* NOI18N */);
_collectionTypes.add("java.util.SortedSet" /* NOI18N */);
_collectionTypes.add("java.util.TreeSet" /* NOI18N */);
_collectionTypes.add("java.util.Map" /* NOI18N */);
_collectionTypes.add("java.util.SortedMap" /* NOI18N */);
_collectionTypes.add("java.util.HashMap" /* NOI18N */);
_collectionTypes.add("java.util.Hashtable" /* NOI18N */);
_collectionTypes.add("java.util.TreeMap" /* NOI18N */);
_collectionTypes.add("java.util.IdentityHashMap" /* NOI18N */);
_collectionTypes.add("java.util.WeakHashMap" /* NOI18N */);
}
//~ Instance variables ---------------------------------------------------------------
/**
* Holds the issues found during inspection. Maps one node to either exaclty one
* issue or a list of the resource keys of several issues.
*/
private Map _issues; // Map of <JavaNode>:<Object>
/** The pattern matcher. */
//private final PatternMatcher _matcher = new Perl5Matcher();
/** Helper array used to store the arguments for the message formatter. */
protected final String[] _args = new String[3];
//~ Constructors ---------------------------------------------------------------------
/**
* Creates a new CodeInspector object.
*
* @param issues map to hold the found issues.
*/
public CodeInspector(Map issues)
{
_issues = issues;
}
//~ Methods --------------------------------------------------------------------------
private Pattern getPattern(String pattern) {
if (_patternMap.get(pattern)==null) {
_patternMap.put(pattern,Pattern.compile(pattern));
}
return (Pattern) _patternMap.get(pattern);
}
/**
* Inspects the given Java parse tree for code convention violations and coding
* weaknesses.
*
* @param tree root node of the parse tree.
* @param file the file that is inspected.
*/
public void inspect(
AST tree,
File file)
{
walk(tree);
}
/**
* {@inheritDoc}
*/
public void visit(AST node)
{
switch (node.getType())
{
case JavaTokenTypes.VARIABLE_DEF :
AST type = JavaNodeHelper.getFirstChild(node, JavaTokenTypes.TYPE);
String returnType = type.getFirstChild().getText();
if (
_settings.getBoolean(ConventionKeys.TIP_REFER_BY_INTERFACE, false)
&& _favorableTypes.contains(returnType))
{
addIssue(node, STR_REFER_BY_INTERFACE, _args);
}
checkCollectionReturnType((JavaNode) node, returnType);
String name = type.getNextSibling().getText();
checkVariableName(node, name);
break;
case JavaTokenTypes.METHOD_CALL :
checkMethodCall(node);
break;
case JavaTokenTypes.ASSIGN :
checkAssignment(node);
break;
case JavaTokenTypes.LITERAL_catch :
checkCatch(node);
break;
case JavaTokenTypes.LITERAL_finally :
checkFinally(node);
break;
case JavaTokenTypes.LABELED_STAT :
checkLabelName(node);
break;
case JavaTokenTypes.METHOD_DEF :
Method method = new Method(node);
checkObjectEquals(node, method);
checkReturnType(node, method);
checkParameters(node, method);
checkThrows(node, method);
checkMethodName(node, method);
if (!method.isAbstract())
{
checkArrayReturnType(node, method);
}
break;
case JavaTokenTypes.CTOR_DEF :
Constructor ctor = new Constructor(node);
checkParameters(node, ctor);
checkThrows(node, ctor);
break;
case JavaTokenTypes.CLASS_DEF :
checkClass(node);
checkClassName(node);
break;
case JavaTokenTypes.INTERFACE_DEF :
checkInterface(node);
checkInterfaceName(node);
break;
case JavaTokenTypes.PACKAGE_DEF :
checkPackageName(node);
break;
case JavaTokenTypes.STRING_LITERAL :
checkStringLiteral(node);
break;
}
}
/**
* Indicates whether the given object represents the "public boolean
* equals(java.lang.Object o)" method.
*
* @param method the method object.
*
* @return <code>true</code> if the given method type represents the equals method.
*/
private boolean isEqualsMethod(Method method)
{
if (method.getParameterCount() != 1)
{
return false;
}
if (
(method.modifierMask != Modifier.PUBLIC)
&& !Modifier.isPublic(method.modifierMask))
{
return false;
}
if (!STR_boolean.equals(method.returnType))
{
return false;
}
if (!STR_equals.equals(method.name))
{
return false;
}
Parameter parameter = (Parameter) method.parameters.get(0);
if (parameter.modifierMask != 0)
{
return false;
}
if (
!(STR_Object.equals(parameter.typeName))
&& STR_javalangObject.equals(parameter.typeName))
{
return false;
}
return true;
}
/**
* Indicates whether the given object represents the "protected void
* finalize()" method.
*
* @param method the method object.
*
* @return <code>true</code> if the given method type represents the finalize method.
*/
private boolean isFinalizeMethod(Method method)
{
if (method.getParameterCount() != 0)
{
return false;
}
if (
(method.modifierMask != Modifier.PROTECTED)
&& !Modifier.isProtected(method.modifierMask))
{
return false;
}
if (!STR_void.equals(method.returnType))
{
return false;
}
if (!STR_finalize.equals(method.name))
{
return false;
}
return true;
}
/**
* Indicates whether the given object represents the "<code>public int
* hashCode()</code>" method.
*
* @param method the method object.
*
* @return <code>true</code> if the given method type represents the hashCode method.
*/
private boolean isHashCodeMethod(Method method)
{
if (method.getParameterCount() != 0)
{
return false;
}
if (
(method.modifierMask != Modifier.PUBLIC)
&& !Modifier.isPublic(method.modifierMask))
{
return false;
}
if (!STR_int.equals(method.returnType))
{
return false;
}
if (!STR_hashCode.equals(method.name))
{
return false;
}
return true;
}
/**
* Searches the tree way back to determine the OBJBLOCK parent of the given node.
*
* @param node a node of the tree below an OBJBLOCK node.
*
* @return the OBJBLOCK parent of the given node.
*/
private JavaNode getObjectBlock(JavaNode node)
{
JavaNode parent = node.getParent();
switch (node.getType())
{
case JavaTokenTypes.OBJBLOCK :
return node;
default :
return getObjectBlock(parent);
}
}
/**
* Indicates whether the given object represents a substituted "<code>public
* boolean equals(java.lang.Object o)</code>" method (e.g. "public boolean
* equals(MyObject o)").
*
* @param method the method object.
*
* @return <code>true</code> if the given method type represents a substituted equals
* method.
*/
private boolean isSubstituteEqualsMethod(Method method)
{
if (method.getParameterCount() != 1)
{
return false;
}
if (
(method.modifierMask != Modifier.PUBLIC)
&& !Modifier.isPublic(method.modifierMask))
{
return false;
}
if (!STR_boolean.equals(method.returnType))
{
return false;
}
if (!STR_equals.equals(method.name))
{
return false;
}
Parameter parameter = (Parameter) method.parameters.get(0);
if (parameter.modifierMask != 0)
{
return false;
}
if (
(STR_Object.equals(parameter.typeName))
|| (STR_javalangObject.equals(parameter.typeName)))
{
return false;
}
return true;
}
/**
* Indicates whether the given object represents the "public String
* toString()" method.
*
* @param method the method object.
*
* @return <code>true</code> if the given method type represents the toString method.
*/
private boolean isToStringMethod(Method method)
{
if (method.getParameterCount() != 0)
{
return false;
}
if (
(method.modifierMask != Modifier.PUBLIC)
&& !Modifier.isPublic(method.modifierMask))
{
return false;
}
if (!STR_String.equals(method.returnType))
{
return false;
}
return STR_toString.equals(method.name);
}
/**
* Adds the given rule message for the given node.
*
* @param node node to add a tip for.
* @param resourceKey resource key of the rule.
* @param args the arguments for message formatting.
*/
protected void addIssue(
AST node,
String resourceKey,
Object[] args)
{
if (!_issues.containsKey(node))
{
_issues.put(
node,
MessageFormat.format(
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(resourceKey),
args));
}
else
{
Object value = _issues.get(node);
if (value instanceof List)
{
List issuesForNode = (List) value;
issuesForNode.add(
MessageFormat.format(
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
resourceKey), args));
}
else
{
List issuesForNode = new ArrayList(4);
issuesForNode.add(value);
issuesForNode.add(
MessageFormat.format(
ResourceBundleFactory.getBundle(BUNDLE_NAME).getString(
resourceKey), args));
_issues.put(node, issuesForNode);
}
}
}
/**
* Checks whether, in case the method has an array return type, the given method
* returns always an array and not <code>null</code>.
*
* @param node the METHOD_DEF node.
* @param method the method object.
*/
private void checkArrayReturnType(
AST node,
Method method)
{
if (_settings.getBoolean(ConventionKeys.TIP_RETURN_ZERO_ARRAY, false))
{
String returnType = method.returnType;
if (returnType.indexOf('[') > -1) // it's an array thingy
{
TreeWalker walker =
new TreeWalker()
{
public void visit(AST newNode)
{
switch (newNode.getType())
{
case JavaTokenTypes.LITERAL_return :
AST child = newNode.getFirstChild();
int retType = 0;
switch (child.getType())
{
case JavaTokenTypes.EXPR :
retType = child.getFirstChild().getType();
break;
case JavaTokenTypes.LPAREN :
AST expr =
JavaNodeHelper.advanceToFirstNonParen(child);
switch (expr.getType())
{
case JavaTokenTypes.EXPR :
retType = expr.getFirstChild().getType();
break;
}
break;
}
switch (retType)
{
case JavaTokenTypes.LITERAL_null :
if (
_settings.getBoolean(
ConventionKeys.TIP_RETURN_ZERO_ARRAY,
false))
{
addIssue(newNode, STR_RETURN_ZERO_ARRAY, _args);
}
stop();
break;
}
break;
}
}
};
walker.walk(JavaNodeHelper.getFirstChild(node, JavaTokenTypes.SLIST));
}
}
}
private void checkAssignment(AST node)
{
if (_settings.getBoolean(ConventionKeys.TIP_VARIABLE_SHADOW, false))
{
AST lhs = node.getFirstChild();
switch (lhs.getType())
{
case JavaTokenTypes.IDENT :
AST rhs = lhs.getNextSibling();
if (rhs != null)
{
switch (rhs.getType())
{
case JavaTokenTypes.IDENT :
// possible shadowing found,
if (lhs.getText().equals(rhs.getText()))
{
JavaNode objBlock = getObjectBlock((JavaNode) node);
boolean foundReference = false;
for (
AST child = objBlock.getFirstChild(); child != null;
child = child.getNextSibling())
{
switch (child.getType())
{
case JavaTokenTypes.VARIABLE_DEF :
String name =
JavaNodeHelper.getFirstChild(
child, JavaTokenTypes.IDENT).getText();
if (name.equals(lhs.getText()))
{
StringBuffer buf = new StringBuffer(100);
buf.append("this." /* NOI18N */);
buf.append(name);
buf.append(" == " /* NOI18N */);
buf.append(name);
_args[2] = buf.toString();
if (
_settings.getBoolean(
ConventionKeys.TIP_VARIABLE_SHADOW,
false))
{
addIssue(
node, STR_VARIABLE_SHADOW, _args);
}
foundReference = true;
}
break;
}
}
if (!foundReference)
{
/**
* @todo
*/
// 1. if inner class and non-static, search parents
// 2. if anonymous inner class, search parents
// 3. if dereived class, print message about possible shadowing
}
}
break;
}
}
break;
}
}
}
/**
* Checks whether the given catch clause is not empty.
*
* @param node a LITERAL_catch node.
*/
private void checkCatch(AST node)
{
if (_settings.getBoolean(ConventionKeys.TIP_DONT_IGNORE_EXCEPTION, false))
{
JavaNode lcurly = (JavaNode) JavaNodeHelper.getFirstChild(node, JavaTokenTypes.SLIST);
JavaNode child = (JavaNode)lcurly.getFirstChild();
// if this is an empty catch and the user does not document why it is empty
if (child.getType() == JavaTokenTypes.RCURLY && !child.hasCommentsBefore())
{
addIssue(node, STR_DONT_IGNORE_EXCEPTION, _args);
}
}
}
/**
* Checks whether the given class represents a structure and, in case equals is
* overriden, that hashCode is also overriden (or vice versa). Also checks whether
* the toString method is overriden.
*
* @param node a CLASS_DEF node.
*/
private void checkClass(AST node)
{
boolean checkReplaceStructure =
_settings.getBoolean(ConventionKeys.TIP_REPLACE_STRUCTURE_WITH_CLASS, false);
boolean checkOverrideHashCode =
_settings.getBoolean(ConventionKeys.TIP_OVERRIDE_HASHCODE, false);
boolean checkOverrideToString =
_settings.getBoolean(ConventionKeys.TIP_OVERRIDE_TO_STRING, false);
if (
!checkReplaceStructure && !checkOverrideHashCode
&& !checkOverrideToString)
{
return;
}
AST classModifierMask =
JavaNodeHelper.getFirstChild(node, JavaTokenTypes.MODIFIERS);
boolean isPublicClass =
Modifier.isPublic(JavaNodeModifier.valueOf(classModifierMask));
AST body = JavaNodeHelper.getFirstChild(node, JavaTokenTypes.OBJBLOCK);
boolean violate = isPublicClass;
boolean foundEquals = false;
AST equalsNode = null;
boolean foundHashCode = false;
boolean foundToString = false;
for (AST child = body.getFirstChild(); child != null;
child = child.getNextSibling())
{
switch (child.getType())
{
case JavaTokenTypes.LCURLY :
case JavaTokenTypes.RCURLY :
break;
case JavaTokenTypes.VARIABLE_DEF :
if (checkReplaceStructure && isPublicClass)
{
int vaiableModifierMask =
JavaNodeModifier.valueOf(child.getFirstChild());
if (!Modifier.isPublic(vaiableModifierMask))
{
violate = false;
}
}
break;
case JavaTokenTypes.METHOD_DEF :
violate = false;
Method method = null;
if (checkOverrideHashCode &&
!foundEquals && isEqualsMethod(method == null ? (method = new Method(child)): method))
{
equalsNode = child;
foundEquals = true;
}
if (checkOverrideHashCode &&
!foundHashCode && isHashCodeMethod(method == null ? (method = new Method(child)): method))
{
foundHashCode = true;
}
if (
checkOverrideToString && !foundToString
&& isToStringMethod(method == null ? (method = new Method(child)): method))
{
foundToString = true;
}
break;
default :
violate = false;
break;
}
}
if (checkReplaceStructure && isPublicClass && violate && checkReplaceStructure)
{
addIssue(node, STR_REPLACE_STRUCTURE_WITH_CLASS, _args);
}
if (checkOverrideHashCode && foundEquals && !foundHashCode )
{
addIssue(equalsNode, STR_OVERRIDE_HASHCODE, _args);
}
if (checkOverrideToString && !foundToString)
{
addIssue(node, STR_OVERRIDE_TO_STRING, _args);
}
}
/**
* Checks whether the given class name adheres to the naming convention.
*
* @param node a CLASS_DEF node.
*/
private void checkClassName(AST node)
{
if (
_settings.getBoolean(
ConventionKeys.TIP_ADHERE_TO_NAMING_CONVENTION, false))
{
String name = JavaNodeHelper.getFirstChild(node, JavaTokenTypes.IDENT).getText();
if (!JavaNodeModifier.isAbstract(node))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_CLASS, ConventionDefaults.REGEXP_CLASS));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "Class" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_CLASS_ABSTRACT,
ConventionDefaults.REGEXP_CLASS_ABSTRACT));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "Abstract class" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
}
}
/**
* Checks, in case the variable declares a collection type, whether an endline
* comment states the type of the elements
*
* @param node a VARIABLE_DEF node.
* @param returnType the returnType of the variable declaration.
*/
private void checkCollectionReturnType(
JavaNode node,
String returnType)
{
if (!JavaNodeHelper.isLocalVariable(node))
{
if (_collectionTypes.contains(returnType))
{
if (
!node.hasCommentsAfter()
&& _settings.getBoolean(
ConventionKeys.TIP_DECLARE_COLLECTION_COMMENT, false))
{
addIssue(node, STR_DECLARE_COLLECTION_COMMENT, _args);
}
else if (
_settings.getBoolean(
ConventionKeys.TIP_WRONG_COLLECTION_COMMENT, false))
{
CommonHiddenStreamToken comment = node.getHiddenAfter();
if (comment==null) {
addIssue(node, STR_WRONG_COLLECTION_COMMENT, _args);
}
else {
switch (comment.getType())
{
case JavaTokenTypes.SL_COMMENT :
String text = comment.getText();
if ((text.indexOf('<') == -1) || (text.indexOf('>') == -1))
{
addIssue(node, STR_WRONG_COLLECTION_COMMENT, _args);
}
break;
default :
/**
* @todo print warning about wrong comment type
*/
break;
}
}
}
}
}
}
/**
* Checks whether method throws an exception (which would violate the equals
* contract).
*
* @param node the METHOD_DEF node.
* @param method the method object.
*/
private void checkEqualsReturnType(
AST node,
Method method)
{
if (
_settings.getBoolean(
ConventionKeys.TIP_OBEY_CONTRACT_EQUALS, false))
{
AST slist = JavaNodeHelper.getFirstChild(node, JavaTokenTypes.SLIST);
// no body for abstract methods!
if (slist != null)
{
AST child = slist.getFirstChild();
// if the method body does not soley consist of a throw statement
if (child.getType() != JavaTokenTypes.LITERAL_throw ||
child.getNextSibling().getType() != JavaTokenTypes.RCURLY)
{
TreeWalker walker =
new TreeWalker()
{
public void visit(AST newNode)
{
switch (newNode.getType())
{
case JavaTokenTypes.LITERAL_throw :
addIssue(newNode, STR_OBEY_CONTRACT_EQUALS, _args);
stop();
break;
}
}
};
walker.walk(slist);
}
}
}
}
/**
* Checks the given finally clause whether is it not empty.
*
* @param node a LITERAL_finally node.
*/
private void checkFinally(AST node)
{
if (_settings.getBoolean(ConventionKeys.TIP_EMPTY_FINALLY, false))
{
if (
(node.getFirstChild().getFirstChild().getType() == JavaTokenTypes.RCURLY)
)
{
addIssue(node, STR_EMPTY_FINALLY, _args);
}
}
}
/**
* Checks whether the given interface is misused to export constants.
*
* @param node a INTERFACE_DEF node.
*/
private void checkInterface(AST node)
{
if (_settings.getBoolean(ConventionKeys.TIP_INTERFACE_ONLY_FOR_TYPE, false))
{
AST body = JavaNodeHelper.getFirstChild(node, JavaTokenTypes.OBJBLOCK);
boolean violate = true;
SEARCH:
for (
AST child = body.getFirstChild(); child != null;
child = child.getNextSibling())
{
switch (child.getType())
{
case JavaTokenTypes.RCURLY :
if (violate)
{
// tagging interfaces are just fine
violate = body.getFirstChild() != child;
}
break;
case JavaTokenTypes.VARIABLE_DEF :
// fields defined in interfaces are automatically 'static'
// and 'final', so no further checking here
break;
default :
// if we find something other than a VARIABLE_DEF than we know
// this can't be a constant interface
violate = false;
break SEARCH;
}
}
if (violate)
{
addIssue(node, STR_INTERFACE_ONLY_FOR_TYPE, _args);
}
}
}
/**
* Checks whether the given interface name adheres to the naming convention.
*
* @param node a INTERFACE_DEF node.
*/
private void checkInterfaceName(AST node)
{
if (
_settings.getBoolean(
ConventionKeys.TIP_ADHERE_TO_NAMING_CONVENTION, false))
{
String name = JavaNodeHelper.getFirstChild(node, JavaTokenTypes.IDENT).getText();
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_INTERFACE, ConventionDefaults.REGEXP_INTERFACE));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "Interface" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
}
/**
* Checks whether the given label adheres to the naming convention.
*
* @param node a LABELED_STAT node.
*/
private void checkLabelName(AST node)
{
if (
_settings.getBoolean(
ConventionKeys.TIP_ADHERE_TO_NAMING_CONVENTION, false))
{
String name = node.getFirstChild().getText();
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_LABEL, ConventionDefaults.REGEXP_LABEL));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "Label" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
}
/**
* Checks, in case the method call represents the Object.wait() method, whether it
* is invoked from within a loop.
*
* @param node a METHOD_CALL node.
*/
private void checkMethodCall(AST node)
{
if (!_settings.getBoolean(ConventionKeys.TIP_NEVER_WAIT_OUTSIDE_LOOP, false))
{
return;
}
AST child = node.getFirstChild();
String name = null;
switch (child.getType())
{
case JavaTokenTypes.IDENT :
name = child.getText();
break;
case JavaTokenTypes.DOT :
if (JavaNodeHelper.isChained(child))
{
name =
JavaNodeHelper.getFirstChainLink(node).getNextSibling().getText();
}
else
{
name = child.getFirstChild().getNextSibling().getText();
}
break;
}
if (STR_wait.equals(name))
{
JavaNode n = (JavaNode) node;
JavaNode expr = n.getParent();
switch (expr.getParent().getType())
{
case JavaTokenTypes.SLIST :
switch (expr.getParent().getParent().getType())
{
case JavaTokenTypes.LITERAL_while :
case JavaTokenTypes.LITERAL_for :
break;
default :
addIssue(n, STR_NEVER_WAIT_OUTSIDE_LOOP, _args);
break;
}
break;
case JavaTokenTypes.LITERAL_while :
case JavaTokenTypes.LITERAL_for :
break;
default :
addIssue(n, STR_NEVER_WAIT_OUTSIDE_LOOP, _args);
break;
}
}
}
/**
* Checks the given method name for naming violations.
*
* @param node a METHOD_DEF node.
* @param method the method object for this node.
*
* @since 1.0b9
*/
private void checkMethodName(
AST node,
Method method)
{
if (
_settings.getBoolean(
ConventionKeys.TIP_ADHERE_TO_NAMING_CONVENTION, false))
{
AST modifiers = JavaNodeHelper.getFirstChild(node, JavaTokenTypes.MODIFIERS);
int modifierMask = JavaNodeModifier.valueOf(modifiers);
String name = method.name;
if (Modifier.isStatic(modifierMask)) // static methods
{
if (Modifier.isFinal(modifierMask)) // static final
{
if (Modifier.isPublic(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_METHOD_PUBLIC_STATIC_FINAL,
ConventionDefaults.REGEXP_METHOD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "public static final method" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else if (Modifier.isProtected(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_METHOD_PROTECTED_STATIC_FINAL,
ConventionDefaults.REGEXP_METHOD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "protected static final method" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else if (Modifier.isPrivate(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_METHOD_PRIVATE_STATIC_FINAL,
ConventionDefaults.REGEXP_METHOD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "private static final method" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_METHOD_DEFAULT_STATIC_FINAL,
ConventionDefaults.REGEXP_METHOD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "static final method" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
}
else // static
{
if (Modifier.isPublic(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_METHOD_PUBLIC_STATIC,
ConventionDefaults.REGEXP_METHOD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "public static method" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else if (Modifier.isProtected(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_METHOD_PROTECTED_STATIC,
ConventionDefaults.REGEXP_METHOD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "protected static method" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else if (Modifier.isPrivate(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_METHOD_PRIVATE_STATIC,
ConventionDefaults.REGEXP_METHOD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "private static method" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_METHOD_DEFAULT_STATIC,
ConventionDefaults.REGEXP_METHOD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "static method" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
}
}
else // instance methods
{
if (Modifier.isPublic(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_METHOD_PUBLIC,
ConventionDefaults.REGEXP_METHOD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "public method" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else if (Modifier.isProtected(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_METHOD_PROTECTED,
ConventionDefaults.REGEXP_METHOD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "protected method" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else if (Modifier.isPrivate(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_METHOD_PRIVATE,
ConventionDefaults.REGEXP_METHOD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "private method" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_METHOD_DEFAULT,
ConventionDefaults.REGEXP_METHOD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "method" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
}
}
}
/**
* Checks, in case the given method node represents an overriden equals method,
* whether it substitutes an object.
*
* @param node a METHOD_DEF node.
* @param method the method object.
*/
private void checkObjectEquals(
AST node,
Method method)
{
if (isSubstituteEqualsMethod(method))
{
addIssue(node, STR_DONT_SUBSTITUTE_OBJECT_EQUALS, _args);
}
else if (isEqualsMethod(method))
{
checkEqualsReturnType(node, method);
}
}
/**
* Checks whether the given package name adheres to the naming convention.
*
* @param node a PACKAGE_DEF node.
*/
private void checkPackageName(AST node)
{
if (
_settings.getBoolean(
ConventionKeys.TIP_ADHERE_TO_NAMING_CONVENTION, false))
{
String name = JavaNodeHelper.getDottedName(JavaNodeHelper.getFirstChild(node, JavaTokenTypes.DOT));
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_PACKAGE, ConventionDefaults.REGEXP_PACKAGE));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "Package" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
}
/**
* Checks whether all given parameters represents interface (base) types.
*
* @param node a CTOR_DEF or METHOD_DEF node.
* @param type object representing a CTOR_DEF or METHOD_DEF.
*/
private void checkParameters(
AST node,
Constructor type)
{
if (!_settings.getBoolean(ConventionKeys.TIP_REFER_BY_INTERFACE, false))
{
return;
}
/**
* @todo add check for naming convention
*/
for (int i = 0, size = type.parameters.size(); i < size; i++)
{
Parameter parameter = (Parameter) type.parameters.get(i);
if (_favorableTypes.contains(parameter.typeName))
{
addIssue(node, STR_REFER_BY_INTERFACE, _args);
}
}
}
/**
* Checks whether the given return type represents an interface (base) type.
*
* @param node a METHOD_DEF node.
* @param method the method object.
*/
private void checkReturnType(
AST node,
Method method)
{
if (!_settings.getBoolean(ConventionKeys.TIP_REFER_BY_INTERFACE, false))
{
return;
}
if (method.hasReturnType())
{
String returnType = method.returnType;
if (_favorableTypes.contains(returnType))
{
addIssue(node, STR_REFER_BY_INTERFACE, _args);
}
}
}
/**
* Checks whether the given String literal contains a trailing comment that informs
* about I18N state.
*
* @param node a STRING_LITERAL node.
*
* @since 1.0b9
*/
private void checkStringLiteral(AST node)
{
if (_settings.getBoolean(ConventionKeys.TIP_STRING_LITERAL_I18N, false))
{
JavaNode n = (JavaNode) node;
CommonHiddenStreamToken comment = n.getCommentAfter();
if (comment == null)
{
_args[0] = String.valueOf(n.getStartColumn());
addIssue(node, STR_STRING_LITERAL_I18N, _args);
}
else
{
switch (comment.getType())
{
case JavaTokenTypes.ML_COMMENT :
if (comment.getText().indexOf("NOI18N" /* NOI18N */) == -1)
{
_args[0] = String.valueOf(n.getStartColumn());
addIssue(node, STR_STRING_LITERAL_I18N, _args);
}
break;
default :
_args[0] = String.valueOf(n.getStartColumn());
addIssue(node, STR_STRING_LITERAL_I18N, _args);
break;
}
}
}
}
/**
* Checks whether the given constructor or method node does throw a superclass
* exception.
*
* @param node a CTOR_DEF or METHOD_DEF node.
* @param type the constructor or method object.
*/
private void checkThrows(
AST node,
Constructor type)
{
boolean checkThrowException =
_settings.getBoolean(ConventionKeys.TIP_NEVER_THROW_EXCEPTION, false);
boolean checkThrowThrowable =
_settings.getBoolean(ConventionKeys.TIP_NEVER_THROW_THROWABLE, false);
if (!checkThrowException && !checkThrowThrowable)
{
return;
}
if (type.hasExceptions())
{
switch (node.getType())
{
case JavaTokenTypes.METHOD_DEF :
// user overrides finalizer, this is OK
if (isFinalizeMethod((Method) type))
{
return;
}
}
List exceptions = type.exceptions;
for (int i = 0, size = exceptions.size(); i < size; i++)
{
String name = (String) exceptions.get(i);
if (checkThrowException && STR_Exception.equals(name))
{
addIssue(node, STR_NEVER_THROW_EXCEPTION, _args);
}
else if (checkThrowThrowable && STR_Throwable.equals(name))
{
addIssue(node, STR_NEVER_THROW_THROWABLE, _args);
}
}
}
}
/**
* Checks the given variable name (either a field or local variable) for naming
* violations.
*
* @param node a VARIABLE_DEF node.
* @param name the name of the variable.
*/
private void checkVariableName(
AST node,
String name)
{
if (
_settings.getBoolean(
ConventionKeys.TIP_ADHERE_TO_NAMING_CONVENTION, false))
{
if (JavaNodeHelper.isLocalVariable(node))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_LOCAL_VARIABLE,
ConventionDefaults.REGEXP_LOCAL_VARIABLE));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "local variable" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else
{
AST modifiers = JavaNodeHelper.getFirstChild(node, JavaTokenTypes.MODIFIERS);
int modifierMask = JavaNodeModifier.valueOf(modifiers);
if (Modifier.isStatic(modifierMask)) // static fields
{
if (Modifier.isFinal(modifierMask)) // static final
{
if (Modifier.isPublic(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_FIELD_PUBLIC_STATIC_FINAL,
ConventionDefaults.REGEXP_FIELD_STATIC_FINAL));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "public static final field" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else if (Modifier.isProtected(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_FIELD_PROTECTED_STATIC_FINAL,
ConventionDefaults.REGEXP_FIELD_STATIC_FINAL));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "protected static final field" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else if (Modifier.isPrivate(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_FIELD_PRIVATE_STATIC_FINAL,
ConventionDefaults.REGEXP_FIELD_STATIC_FINAL));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "private static final field" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_FIELD_DEFAULT_STATIC_FINAL,
ConventionDefaults.REGEXP_FIELD_STATIC_FINAL));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "static final field" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
}
else // static
{
if (Modifier.isPublic(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_FIELD_PUBLIC_STATIC,
ConventionDefaults.REGEXP_FIELD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "public static field" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else if (Modifier.isProtected(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_FIELD_PROTECTED_STATIC,
ConventionDefaults.REGEXP_FIELD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "protected static field" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else if (Modifier.isPrivate(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_FIELD_PRIVATE_STATIC,
ConventionDefaults.REGEXP_FIELD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "private static field" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_FIELD_DEFAULT_STATIC,
ConventionDefaults.REGEXP_FIELD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "static field" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
}
}
else // instance fields
{
if (Modifier.isPublic(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_FIELD_PUBLIC,
ConventionDefaults.REGEXP_FIELD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "public field" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else if (Modifier.isProtected(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_FIELD_PROTECTED,
ConventionDefaults.REGEXP_FIELD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "protected field" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else if (Modifier.isPrivate(modifierMask))
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_FIELD_PRIVATE,
ConventionDefaults.REGEXP_FIELD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "private field" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
else
{
Pattern pattern =
getPattern(
_settings.get(
ConventionKeys.REGEXP_FIELD_DEFAULT,
ConventionDefaults.REGEXP_FIELD));
if (
!pattern.pattern().equals(EMPTY_STRING)
&& !pattern.matcher(name).matches())
{
_args[0] = "field" /* NOI18N */;
_args[1] = name;
_args[2] = pattern.pattern();
addIssue(node, STR_NAMING_CONVENTION, _args);
}
}
}
}
}
}
//~ Inner Classes --------------------------------------------------------------------
/**
* Represents a CTOR_DEF node.
*/
private static class Constructor
{
public static final String TYPE_VOID = "void" /* NOI18N */;
List exceptions = Collections.EMPTY_LIST; // List of <String>
List parameters = Collections.EMPTY_LIST; // List of <Parameter>
String name;
int modifierMask;
public Constructor(AST node)
{
for (
AST child = node.getFirstChild(); child != null;
child = child.getNextSibling())
{
switch (child.getType())
{
case JavaTokenTypes.MODIFIERS :
this.modifierMask = JavaNodeModifier.valueOf(child);
break;
case JavaTokenTypes.IDENT :
this.name = child.getText();
break;
case JavaTokenTypes.PARAMETERS :
AST parameter = child.getFirstChild();
if (parameter != null)
{
this.parameters = new ArrayList(5);
for (
AST pchild = parameter; pchild != null;
pchild = pchild.getNextSibling())
{
this.parameters.add(new Parameter(pchild));
}
}
break;
case JavaTokenTypes.LITERAL_throws :
this.exceptions = new ArrayList(4);
for (
AST exception = child.getFirstChild(); exception != null;
exception = exception.getNextSibling())
{
exceptions.add(exception.getText());
}
break;
}
}
}
private Constructor()
{
}
public List getExceptions()
{
return this.exceptions;
}
public String getName()
{
return this.name;
}
public int getParameterCount()
{
return this.parameters.size();
}
public List getParameters()
{
return this.parameters;
}
public boolean hasExceptions()
{
return !this.exceptions.isEmpty();
}
public boolean hasParameters()
{
return !this.parameters.isEmpty();
}
}
/**
* Represents a METHOD_DEF node.
*/
private static final class Method
extends Constructor
{
String returnType;
boolean isAbstract = true;
public Method(AST node)
{
for (
AST child = node.getFirstChild(); child != null;
child = child.getNextSibling())
{
switch (child.getType())
{
case JavaTokenTypes.MODIFIERS :
this.modifierMask = JavaNodeModifier.valueOf(child);
break;
case JavaTokenTypes.TYPE :
this.returnType = child.getFirstChild().getText();
break;
case JavaTokenTypes.IDENT :
this.name = child.getText();
break;
case JavaTokenTypes.PARAMETERS :
AST parameter = child.getFirstChild();
if (parameter != null)
{
this.parameters = new ArrayList(5);
for (
AST pchild = parameter; pchild != null;
pchild = pchild.getNextSibling())
{
this.parameters.add(new Parameter(pchild));
}
}
break;
case JavaTokenTypes.LITERAL_throws :
this.exceptions = new ArrayList(4);
for (
AST exception = child.getFirstChild(); exception != null;
exception = exception.getNextSibling())
{
exceptions.add(exception.getText());
}
break;
case JavaTokenTypes.SLIST :
this.isAbstract = false;
break;
}
}
}
public boolean isAbstract()
{
return this.isAbstract;
}
public String getReturnType()
{
return this.returnType;
}
public boolean hasReturnType()
{
return !TYPE_VOID.equals(this.returnType);
}
}
/**
* Represents a PARAMETER node.
*/
private static final class Parameter
{
String name;
String typeName;
int modifierMask;
public Parameter(AST node)
{
for (
AST child = node.getFirstChild(); child != null;
child = child.getNextSibling())
{
switch (child.getType())
{
case JavaTokenTypes.MODIFIERS :
this.modifierMask = JavaNodeModifier.valueOf(child);
break;
case JavaTokenTypes.TYPE :
this.typeName = child.getFirstChild().getText();
break;
case JavaTokenTypes.IDENT :
this.name = child.getText();
break;
}
}
}
public int getModifierMask()
{
return this.modifierMask;
}
public String getName()
{
return this.name;
}
public String getTypeName()
{
return this.typeName;
}
public String toString()
{
StringBuffer buf = new StringBuffer(50);
buf.append(Modifier.toString(this.modifierMask));
buf.append(' ');
buf.append(typeName);
buf.append(' ');
buf.append(name);
return buf.toString().trim();
}
}
}
The table below shows all metrics for CodeInspector.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 222.00 | Number of blocks | |
| BLOCK_COMMENT | 6.00 | Number of block comment lines | |
| COMMENTS | 251.00 | Comment lines | |
| COMMENT_DENSITY | 0.22 | Comment density | |
| COMPARISONS | 190.00 | Number of comparison operators | |
| CYCLOMATIC | 318.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 48.00 | Comments in declarations | |
| DOC_COMMENT | 226.00 | Number of javadoc comment lines | |
| ELOC | 1159.00 | Effective lines of code | |
| EXEC_COMMENTS | 12.00 | Comments in executable code | |
| EXITS | 90.00 | Procedure exits | |
| FUNCTIONS | 50.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 117.13 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 128.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 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 3.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 | 1.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 4.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 | 1.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 1.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 14.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 | 1.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 1.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 | 22.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 | 2.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 | 1.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 | 0.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 | 1.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 15.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 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 3.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 6.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 | 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 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 242.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 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 2.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 | 0.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 | 2.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 | 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 | 1.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 2245.00 | Number of lines in the source file | |
| LINE_COMMENT | 19.00 | Number of line comments | |
| LOC | 1652.00 | Lines of code | |
| LOGICAL_LINES | 567.00 | Number of statements | |
| LOOPS | 12.00 | Number of loops | |
| NEST_DEPTH | 7.00 | Maximum nesting depth | |
| OPERANDS | 2826.00 | Number of operands | |
| OPERATORS | 5355.00 | Number of operators | |
| PARAMS | 48.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 8181.00 | Halstead program length | |
| PROGRAM_VOCAB | 614.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 80.00 | Number of return points from functions | |
| SIZE | 76800.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 567.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 47.00 | Number of unique operators | |
| WHITESPACE | 342.00 | Number of whitespace lines | |