PostParseVisitor.java
| Index Score | ||
|---|---|---|
 |
 |
freemarker.template |
 |
 |
FreeMarker |
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 | |
|---|---|---|
| CYCLOMATIC | Cyclomatic complexity |  |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| COMPARISONS | Number of comparison operators | |
| BLOCKS | Number of blocks | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LOOPS | Number of loops | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERANDS | Number of operands | |
| EXITS | Procedure exits | |
| FUNCTIONS | Number of function declarations | |
| LOC | Lines of code | |
| SIZE | Size of the file in bytes | |
| ELOC | Effective lines of code | |
| LOGICAL_LINES | Number of statements | |
| PARAMS | Number of formal parameter declarations | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LINES | Number of lines in the source file | |
| RETURNS | Number of return points from functions | |
| JAVA0123 | JAVA0123 Use all three components of for loop | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| UNIQUE_OPERATORS | Number of unique operators | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| DOC_COMMENT | Number of javadoc comment lines | |
| DECL_COMMENTS | Comments in declarations | |
| COMMENTS | Comment lines | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* Copyright (c) 2007 The Visigoth Software Society. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowledgement:
* "This product includes software developed by the
* Visigoth Software Society (http://www.visigoths.org/)."
* Alternately, this acknowledgement may appear in the software itself,
* if and wherever such third-party acknowledgements normally appear.
*
* 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
* project contributors may be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact visigoths@visigoths.org.
*
* 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
* nor may "FreeMarker" or "Visigoth" appear in their names
* without prior written permission of the Visigoth Software Society.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Visigoth Software Society. For more
* information on the Visigoth Software Society, please see
* http://www.visigoths.org/
*/
package freemarker.template;
import freemarker.core.Configurable;
import freemarker.core.ast.*;
import freemarker.core.parser.ParseException;
import freemarker.core.parser.ParsingProblem;
import freemarker.template.utility.DeepUnwrap;
import java.util.*;
/**
* A class that visits the AST after the parsing step proper,
* and makes various checks and adjustments.
* @author revusky
*/
public class PostParseVisitor extends ASTVisitor {
private Template template;
private List<EscapeBlock> escapes = new ArrayList<EscapeBlock>();
public PostParseVisitor(Template template) {
this.template = template;
}
private Expression escapedExpression(Expression exp) {
if(escapes.isEmpty()) {
return exp;
}
EscapeBlock lastEscape = escapes.get(escapes.size() -1);
return lastEscape.doEscape(exp);
}
public void visit(TemplateHeaderElement header) {
if (header == null) return;
for (Map.Entry<String, Expression> entry : header.getParams().entrySet()) {
String key = entry.getKey();
try {
if (key.equals("strip_whitespace")) {
template.setStripWhitespace(header.getBooleanParameter("strip_whitespace"));
}
else if (key.equals("ns_prefixes")) {
TemplateHashModelEx prefixMap = (TemplateHashModelEx) header.getParameter("ns_prefixes");
TemplateCollectionModel keys = prefixMap.keys();
for (TemplateModelIterator it = keys.iterator(); it.hasNext();) {
String prefix = ((TemplateScalarModel) it.next()).getAsString();
TemplateModel valueModel = prefixMap.get(prefix);
String nsURI = ((TemplateScalarModel) valueModel).getAsString();
template.addPrefixNSMapping(prefix, nsURI);
}
}
else if (key.equals("attributes")) {
TemplateHashModelEx attributeMap = (TemplateHashModelEx) header.getParameter("attributes");
TemplateCollectionModel keys = attributeMap.keys();
for (TemplateModelIterator it = keys.iterator(); it.hasNext();) {
String attName = ((TemplateScalarModel) it.next()).getAsString();
Object attValue = DeepUnwrap.unwrap(attributeMap.get(attName));
template.setCustomAttribute(attName, attValue);
}
}
else if (key.equals("strict_vars")) {
boolean strictVariableDeclaration = header.getBooleanParameter("strict_vars");
template.setStrictVariableDeclaration(strictVariableDeclaration);
}
else if (!key.equals("strip_text") && !key.equals("encoding")) {
ParsingProblem problem = new ParsingProblem("Unknown ftl header parameter: " + entry.getKey(), header);
template.addParsingProblem(problem);
}
} catch (Exception e) {
ParsingProblem problem = new ParsingProblem(e.getMessage(), header);
template.addParsingProblem(problem);
}
}
}
public void visit(Include node) {
if (template.strictVariableDeclaration() && !node.useFreshNamespace()) {
ParsingProblem problem = new ParsingProblem("The legacy #include instruction is not permitted in strict_vars mode. Use #embed or possibly #import.", node);
template.addParsingProblem(problem);
}
super.visit(node);
}
public void visit(InvalidExpression node) {
template.addParsingProblem(new ParsingProblem(node.getMessage() + " " + node.getSource(), node));
}
public void visit(UnclosedElement node) {
template.addParsingProblem(new ParsingProblem(node.getDescription(), node));
}
public void visit(AndExpression node) {
visit(node.left);
checkLiteralInBooleanContext(node.left);
visit(node.right);
checkLiteralInBooleanContext(node.right);
}
public void visit(AssignmentInstruction node) {
super.visit(node);
if (template.strictVariableDeclaration()) {
if (node.type == AssignmentInstruction.NAMESPACE) {
ParsingProblem problem = new ParsingProblem("The assign directive is deprecated and cannot be used in strict_vars mode. See the var and set directives.", node);
template.addParsingProblem(problem);
}
if (node.type == AssignmentInstruction.LOCAL) {
ParsingProblem problem = new ParsingProblem("The local directive is deprecated and cannot be used in strict_vars mode. See the var and set directives.", node);
template.addParsingProblem(problem);
}
}
if (node.type == AssignmentInstruction.LOCAL) {
Macro macro = getContainingMacro(node);
if (macro == null) {
ParsingProblem problem = new ParsingProblem("The local directive can only be used inside a function or macro.", node);
template.addParsingProblem(problem);
}
else for (String varname : node.getVarNames()) {
if (!macro.declaresVariable(varname)) {
macro.declareVariable(varname);
}
}
}
}
public void visit(BlockAssignment node) {
super.visit(node);
if (template.strictVariableDeclaration()) {
if (node.type == AssignmentInstruction.NAMESPACE) {
ParsingProblem problem = new ParsingProblem("The assign directive is deprecated and cannot be used in strict_vars mode. See the var and set directives.", node);
template.addParsingProblem(problem);
}
if (node.type == AssignmentInstruction.LOCAL) {
ParsingProblem problem = new ParsingProblem("The local directive is deprecated and cannot be used in strict_vars mode. See the var and set directives.", node);
template.addParsingProblem(problem);
}
}
if (node.type == AssignmentInstruction.LOCAL) {
Macro macro = getContainingMacro(node);
if (macro == null) {
template.addParsingProblem(new ParsingProblem("The local directive can only be used inside a function or macro.", node));
} else {
if (!macro.declaresVariable(node.varName)) {
macro.declareVariable(node.varName);
}
}
}
}
public void visit(BuiltInExpression node) {
super.visit(node);
if (node.findImplementation()==null) {
ParsingProblem problem = new ParsingProblem("Unknown builtin: " + node.getName(), node);
template.addParsingProblem(problem);
}
}
public void visit(Interpolation node) {
super.visit(node);
markAsProducingOutput(node);
Expression escapedExpression = escapedExpression(node.expression);
node.setEscapedExpression(escapedExpression);
checkLiteralInScalarContext(escapedExpression);
}
public void visit(IfBlock node) {
if (node.getChildCount() == 1) {
ConditionalBlock cblock = (ConditionalBlock) node.getChildAt(0);
cblock.setIsSimple(true);
cblock.setLocation(node.getTemplate(), cblock, node);
node.getParent().replace(node, cblock);
visit(cblock);
} else {
super.visit(node);
}
}
public void visit(EscapeBlock node) {
Expression escapedExpression = escapedExpression(node.expr);
node.setEscapedExpression(escapedExpression);
escapes.add(node);
super.visit(node);
escapes.remove(escapes.size() -1);
}
public void visit(Macro node) {
String macroName = node.getName();
if (template.strictVariableDeclaration() && template.declaresVariable(macroName)) {
ParsingProblem problem = new ParsingProblem("You already have declared a variable (or declared another macro) as " + macroName + ". You cannot reuse the variable name in the same template.", node);
template.addParsingProblem(problem);
}
if (template.strictVariableDeclaration()) {
template.declareVariable(macroName);
TemplateElement parent=node.getParent();
while (parent != null) {
parent = parent.getParent();
if (parent != null && !(parent instanceof EscapeBlock) && !(parent instanceof NoEscapeBlock) && !(parent instanceof MixedContent)) {
ParsingProblem problem = new ParsingProblem("Macro " + macroName + " is within a " + parent.getDescription() + ". It must be a top-level element.");
template.addParsingProblem(problem);
}
}
}
template.addMacro(node);
super.visit(node);
}
public void visit(NoEscapeBlock node) {
TemplateElement parent = node;
while (parent != null && !(parent instanceof EscapeBlock)) {
parent = parent.getParent();
}
if (parent == null) {
template.addParsingProblem(new ParsingProblem("The noescape directive only makes sense inside an escape block.", node));
}
EscapeBlock last = escapes.remove(escapes.size() -1);
super.visit(node);
escapes.add(last);
}
public void visit(IteratorBlock node) {
node.declareVariable(node.indexName);
node.declareVariable(node.indexName + "_has_next");
node.declareVariable(node.indexName + "_index");
super.visit(node);
}
public void visit(MixedContent node) {
if (node.getChildCount() == 1 && node.getParent() != null) {
node.getParent().replace(node, node.getChildAt(0));
}
super.visit(node);
}
public void visit(FallbackInstruction node) {
super.visit(node);
if (getContainingMacro(node) == null) {
template.addParsingProblem(new ParsingProblem("The fallback directive can only be used inside a macro", node));
}
}
public void visit(BreakInstruction node) {
super.visit(node);
TemplateElement parent = node;
while (parent != null && !(parent instanceof SwitchBlock) && !(parent instanceof IteratorBlock)) {
parent = parent.getParent();
}
if (parent == null) {
template.addParsingProblem(new ParsingProblem("The break directive can only be used within a loop or a switch-case construct.", node));
}
}
public void visit(BodyInstruction node) {
super.visit(node);
Macro macro = getContainingMacro(node);
if (macro == null) {
template.addParsingProblem(new ParsingProblem("The nested directive can only be used inside a function or macro.", node));
}
}
public void visit(ReturnInstruction node) {
super.visit(node);
TemplateElement parent = node;
while (parent != null && !(parent instanceof Macro)) {
parent = parent.getParent();
}
if (parent == null) {
template.addParsingProblem(new ParsingProblem("The return directive can only be used inside a function or macro.", node));
} else {
Macro macro = (Macro) parent;
if (!macro.isFunction() && node.returnExp != null) {
template.addParsingProblem(new ParsingProblem("Can only return a value from a function, not a macro", node));
}
else if (macro.isFunction() && node.returnExp == null) {
template.addParsingProblem(new ParsingProblem("A function must return a value.", node));
}
}
}
public void visit(VarDirective node) {
TemplateElement parent = node.getParent();
while (parent instanceof MixedContent
|| parent instanceof EscapeBlock
|| parent instanceof NoEscapeBlock
|| parent instanceof TrimBlock) {
parent = parent.getParent();
}
for (String key : node.getVariables().keySet()) {
if (parent == null) {
template.declareVariable(key);
} else {
if (parent.declaresVariable(key)) {
String msg = "The variable " + key + " has already been declared in this block.";
if (parent instanceof Macro) {
String macroName = ((Macro) parent).getName();
msg = "The variable " + key + " has already been declared in macro " + macroName + ".";
}
template.addParsingProblem(new ParsingProblem(msg, node));
}
parent.declareVariable(key);
}
}
}
public void visit(OOParamElement node) {
TemplateElement parent = node.getParent();
while (parent instanceof MixedContent
|| parent instanceof EscapeBlock
|| parent instanceof NoEscapeBlock
|| parent instanceof TrimBlock) {
parent = parent.getParent();
}
if (!(parent instanceof UnifiedCall) && !(parent instanceof OOParamElement)) {
String msg = "A #param directive must be directly nested in a macro invocation or in another #param directive.";
template.addParsingProblem(new ParsingProblem(msg, node));
} else {
parent.declareVariable(node.getName());
}
}
public void visit(SwitchBlock node) {
super.visit(node);
boolean foundDefaultCase = false;
for (TemplateNode te : node.getCases()) {
if (((Case) te).isDefault) {
if (foundDefaultCase) {
template.addParsingProblem(new ParsingProblem("You can only have one default case in a switch construct.", node));
}
foundDefaultCase = true;
}
}
}
public void visit(TextBlock node) {
int type = node.getType();
if (type == TextBlock.PRINTABLE_TEXT) {
for (int i = node.getBeginLine(); i<=node.getEndLine(); i++) {
boolean inMacro = getContainingMacro(node) != null;
if (i >0) {//REVISIT THIS
template.markAsOutputtingLine(i, inMacro);
}
}
} else if (type == TextBlock.WHITE_SPACE) {
}
}
public void visit(OrExpression node) {
visit(node.left);
checkLiteralInBooleanContext(node.left);
visit(node.right);
checkLiteralInBooleanContext(node.right);
}
public void visit(ArithmeticExpression node) {
visit(node.left);
checkLiteralInNumericalContext(node.left);
visit(node.right);
checkLiteralInNumericalContext(node.right);
}
public void visit(ComparisonExpression node) {
visit(node.left);
checkLiteralInScalarContext(node.left);
visit(node.right);
checkLiteralInScalarContext(node.right);
}
public void visit(NumericalOutput node) {
super.visit(node);
try {
node.parseFormat();
} catch (Exception e) {
String msg = e.getMessage();
ParsingProblem problem = new ParsingProblem(msg, node);
template.addParsingProblem(problem);
}
markAsProducingOutput(node);
checkLiteralInNumericalContext(node.expression);
}
public void visit(Dot node) {
super.visit(node);
TemplateModel target = node.target.literalValue();
if (target != null && !(target instanceof TemplateHashModel)) {
template.addParsingProblem(new ParsingProblem("Expression " + node.target.getSource() + " is not a hash type.", node.target));
}
}
public void visit(DynamicKeyName node) {
super.visit(node);
TemplateModel target = node.target.literalValue();
if (target != null && !(target instanceof TemplateHashModel) && !(target instanceof TemplateSequenceModel)) {
String msg = "Expression: " + node.target.getSource() + " is not a hash or sequence type.";
template.addParsingProblem(new ParsingProblem(msg, node.target));
}
if (!(node.nameExpression instanceof Range)) {
checkLiteralInScalarContext(node.nameExpression);
}
}
public void visit(HashLiteral node) {
for (Expression key : node.getKeys()) {
checkLiteralInStringContext(key);
}
super.visit(node);
}
public void visit(StringLiteral node) {
if (!node.isRaw()) {
try {
node.checkInterpolation();
} catch (ParseException pe) {
String msg = "Error in string " + node.getStartLocation();
msg += "\n" + pe.getMessage();
template.addParsingProblem(new ParsingProblem(msg, node));
}
}
}
public void visit(LibraryLoad node) {
String namespaceName = node.namespace;
if (template.strictVariableDeclaration() &&
template.declaresVariable(namespaceName)) {
String msg = "The variable "+namespaceName + " is already declared and should not be used as a namespace name to import.";
template.addParsingProblem(new ParsingProblem(msg, node));
}
template.declareVariable(namespaceName);
super.visit(node);
}
public void visit(Range node) {
super.visit(node);
checkLiteralInNumericalContext(node.left);
if (node.right != null) {
checkLiteralInNumericalContext(node.right);
}
}
public void visit(UnaryPlusMinusExpression node) {
checkLiteralInNumericalContext(node.target);
super.visit(node);
}
public void visit(TrimInstruction node) {
for (int i = node.getBeginLine(); i<= node.getEndLine(); i++) {
if (node.left)
template.setLineSaysLeftTrim(i);
if (node.right)
template.setLineSaysRightTrim(i);
if (!(node.left || node.right))
template.setLineSaysNoTrim(i);
}
}
public void visit(TrimBlock node) {
int beginLine = node.getBeginLine();
int endLine = node.getEndLine();
if (node.right) {
template.setLineSaysRightTrim(beginLine++);
}
if (node.left) {
template.setLineSaysLeftTrim(endLine--);
}
for (int i= beginLine; i<=endLine; i++) {
if (node.left) {
template.setLineSaysLeftTrim(i);
}
if (node.right) {
template.setLineSaysRightTrim(i);
}
if (!node.left && !node.right) {
template.setLineSaysNoTrim(i);
}
}
super.visit(node);
}
public void visit(PropertySetting node) {
String key = node.key;
if (!key.equals(Configurable.LOCALE_KEY) &&
!key.equals(Configurable.NUMBER_FORMAT_KEY) &&
!key.equals(Configurable.TIME_FORMAT_KEY) &&
!key.equals(Configurable.DATE_FORMAT_KEY) &&
!key.equals(Configurable.DATETIME_FORMAT_KEY) &&
!key.equals(Configurable.TIME_ZONE_KEY) &&
!key.equals(Configurable.BOOLEAN_FORMAT_KEY) &&
!key.equals(Configurable.URL_ESCAPING_CHARSET_KEY))
{
ParsingProblem problem = new ParsingProblem("Invalid setting name, or it is not allowed to change the "
+ "value of the setting with FTL: "
+ key, node);
template.addParsingProblem(problem);
}
}
private void checkLiteralInBooleanContext(Expression exp) {
TemplateModel value = exp.literalValue();
if (value != null && !(value instanceof TemplateBooleanModel)) {
String msg;
if (value == TemplateModel.INVALID_EXPRESSION) {
msg = "Invalid expression: " + exp.getSource();
} else {
msg = "Expression: " + exp.getSource() + " is not a boolean (true/false) value.";
}
template.addParsingProblem(new ParsingProblem(msg, exp));
}
}
private void checkLiteralInStringContext(Expression exp) {
TemplateModel value = exp.literalValue();
if (value != null && !(value instanceof TemplateScalarModel)) {
String msg;
if (value == TemplateModel.INVALID_EXPRESSION) {
msg = "Invalid expression: " + exp.getSource();
} else {
msg = "Expression: " + exp.getSource() + " is not a string.";
}
template.addParsingProblem(new ParsingProblem(msg, exp));
}
}
private void checkLiteralInNumericalContext(Expression exp) {
TemplateModel value = exp.literalValue();
if (value != null && !(value instanceof TemplateNumberModel)) {
String msg;
if (value == TemplateModel.INVALID_EXPRESSION) {
msg = "Invalid expression: " + exp.getSource();
} else {
msg = "Expression: " + exp.getSource() + " is not a numerical value.";
}
template.addParsingProblem(new ParsingProblem(msg, exp));
}
}
private void checkLiteralInScalarContext(Expression exp) {
TemplateModel value = exp.literalValue();
if (value != null && !(value instanceof TemplateScalarModel)
&& !(value instanceof TemplateNumberModel)
&& !(value instanceof TemplateDateModel))
{
String msg;
if (value == TemplateModel.INVALID_EXPRESSION) {
msg = "Invalid expression: " + exp.getSource();
} else {
msg = "Expression: " + exp.getSource() + " is not a string, date, or number.";
}
template.addParsingProblem(new ParsingProblem(msg, exp));
}
}
static Macro getContainingMacro(TemplateNode node) {
TemplateNode parent = node;
while (parent != null && !(parent instanceof Macro)) {
parent = parent.getParentNode();
}
return (Macro) parent;
}
private void markAsProducingOutput(TemplateNode node) {
for (int i= node.getBeginLine(); i<=node.getEndLine(); i++) {
boolean inMacro = getContainingMacro(node) != null;
template.markAsOutputtingLine(i, inMacro);
}
}
public String firstLine(TemplateNode node) {
String line = template.getLine(node.getBeginLine());
if (node.getBeginLine() == node.getEndLine()) {
line = line.substring(0, node.getEndColumn());
}
return line.substring(node.getBeginColumn() -1);
}
public String lastLine(TemplateNode node) {
String line = template.getLine(node.getEndLine());
line = line.substring(0, node.getEndColumn());
if (node.getBeginLine() == node.getEndLine()) {
line = line.substring(node.getBeginColumn() -1);
}
return line;
}
}
The table below shows all metrics for PostParseVisitor.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 143.00 | Number of blocks | |
| BLOCK_COMMENT | 51.00 | Number of block comment lines | |
| COMMENTS | 56.00 | Comment lines | |
| COMMENT_DENSITY | 0.14 | Comment density | |
| COMPARISONS | 103.00 | Number of comparison operators | |
| CYCLOMATIC | 160.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 2.00 | Comments in declarations | |
| DOC_COMMENT | 5.00 | Number of javadoc comment lines | |
| ELOC | 390.00 | Effective lines of code | |
| EXEC_COMMENTS | 0.00 | Comments in executable code | |
| EXITS | 83.00 | Procedure exits | |
| FUNCTIONS | 47.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 70.08 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 96.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 1.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 5.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 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 | 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 | 5.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 | 2.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 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 2.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 | 16.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1160.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 | 2.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 4.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 | 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 | 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 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 638.00 | Number of lines in the source file | |
| LINE_COMMENT | 0.00 | Number of line comments | |
| LOC | 523.00 | Lines of code | |
| LOGICAL_LINES | 237.00 | Number of statements | |
| LOOPS | 13.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 1324.00 | Number of operands | |
| OPERATORS | 2461.00 | Number of operators | |
| PARAMS | 47.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3785.00 | Halstead program length | |
| PROGRAM_VOCAB | 491.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 49.00 | Number of return points from functions | |
| SIZE | 22946.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 444.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 47.00 | Number of unique operators | |
| WHITESPACE | 59.00 | Number of whitespace lines | |