ASTReference.java

Index Score
org.apache.velocity.runtime.parser.node
Apache Velocity Engine

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.

MetricDescription
EXEC_COMMENTSComments in executable code
JAVA0034JAVA0034 Missing braces in if statement
BLOCK_COMMENTNumber of block comment lines
JAVA0126JAVA0126 Method declares unchecked exception in throws
COMMENTSComment lines
SIZESize of the file in bytes
COMPARISONSNumber of comparison operators
LINESNumber of lines in the source file
RETURNSNumber of return points from functions
LOCLines of code
JAVA0144JAVA0144 Line exceeds maximum M characters
CYCLOMATICCyclomatic complexity
INTERFACE_COMPLEXITYInterface complexity
JAVA0049JAVA0049 Nested block at depth N (maximum: M)
ELOCEffective lines of code
OPERATORSNumber of operators
PROGRAM_LENGTHHalstead program length
BLOCKSNumber of blocks
OPERANDSNumber of operands
JAVA0110JAVA0110 Incorrect javadoc: no @return tag
LOGICAL_LINESNumber of statements
UNIQUE_OPERATORSNumber of unique operators
EXITSProcedure exits
JAVA0117JAVA0117 Missing javadoc: method 'method'
JAVA0115JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
WHITESPACENumber of whitespace lines
JAVA0166JAVA0166 Generic exception caught
PROGRAM_VOCABHalstead program vocabulary
NEST_DEPTHMaximum nesting depth
PROGRAM_VOLUMEHalstead program volume
UNIQUE_OPERANDSNumber of unique operands
LINE_COMMENTNumber of line comments
DOC_COMMENTNumber of javadoc comment lines
LOOPSNumber of loops
JAVA0287JAVA0287 Unnecessary null check
DECL_COMMENTSComments in declarations
JAVA0100JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0108JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0145JAVA0145 Tab character used in source file
package org.apache.velocity.runtime.parser.node; /* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ import java.io.IOException; import java.io.Writer; import java.lang.reflect.InvocationTargetException; import org.apache.velocity.app.event.EventHandlerUtil; import org.apache.velocity.context.Context; import org.apache.velocity.context.InternalContextAdapter; import org.apache.velocity.exception.MethodInvocationException; import org.apache.velocity.exception.TemplateInitException; import org.apache.velocity.runtime.RuntimeConstants; import org.apache.velocity.runtime.parser.Parser; import org.apache.velocity.runtime.parser.Token; import org.apache.velocity.util.introspection.Info; import org.apache.velocity.util.introspection.VelPropertySet; /** * This class is responsible for handling the references in * VTL ($foo). * * Please look at the Parser.jjt file which is * what controls the generation of this class. * * @author <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> * @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> * @author <a href="mailto:Christoph.Reck@dlr.de">Christoph Reck</a> * @author <a href="mailto:kjohnson@transparent.com>Kent Johnson</a> * @version $Id: ASTReference.java 686428 2008-08-16 00:54:35Z nbubna $ */ public class ASTReference extends SimpleNode { /* Reference types */ private static final int NORMAL_REFERENCE = 1; private static final int FORMAL_REFERENCE = 2; private static final int QUIET_REFERENCE = 3; private static final int RUNT = 4; private int referenceType; private String nullString; private String rootString; private boolean escaped = false; private boolean computableReference = true; private boolean logOnNull = true; private String escPrefix = ""; private String morePrefix = ""; private String identifier = ""; private String literal = null; private int numChildren = 0; protected Info uberInfo; /** * @param id */ public ASTReference(int id) { super(id); } /** * @param p * @param id */ public ASTReference(Parser p, int id) { super(p, id); } /** * @see org.apache.velocity.runtime.parser.node.SimpleNode#jjtAccept(org.apache.velocity.runtime.parser.node.ParserVisitor, java.lang.Object) */ public Object jjtAccept(ParserVisitor visitor, Object data) { return visitor.visit(this, data); } /** * @see org.apache.velocity.runtime.parser.node.SimpleNode#init(org.apache.velocity.context.InternalContextAdapter, java.lang.Object) */ public Object init(InternalContextAdapter context, Object data) throws TemplateInitException { /* * init our children */ super.init(context, data); /* * the only thing we can do in init() is getRoot() * as that is template based, not context based, * so it's thread- and context-safe */ rootString = getRoot(); numChildren = jjtGetNumChildren(); /* * and if appropriate... */ if (numChildren > 0 ) { identifier = jjtGetChild(numChildren - 1).getFirstToken().image; } /* * make an uberinfo - saves new's later on */ uberInfo = new Info(context.getCurrentTemplateName(), getLine(),getColumn()); /* * track whether we log invalid references */ logOnNull = rsvc.getBoolean(RuntimeConstants.RUNTIME_LOG_REFERENCE_LOG_INVALID, true); return data; } /** * Returns the 'root string', the reference key * @return the root string. */ public String getRootString() { return rootString; } /** * gets an Object that 'is' the value of the reference * * @param o unused Object parameter * @param context context used to generate value * @return The execution result. * @throws MethodInvocationException */ public Object execute(Object o, InternalContextAdapter context) throws MethodInvocationException { if (referenceType == RUNT) return null; /* * get the root object from the context */ Object result = getVariableValue(context, rootString); if (result == null) { return EventHandlerUtil.invalidGetMethod(rsvc, context, "$" + rootString, null, null, uberInfo); } /* * Iteratively work 'down' (it's flat...) the reference * to get the value, but check to make sure that * every result along the path is valid. For example: * * $hashtable.Customer.Name * * The $hashtable may be valid, but there is no key * 'Customer' in the hashtable so we want to stop * when we find a null value and return the null * so the error gets logged. */ try { Object previousResult = result; int failedChild = -1; for (int i = 0; i < numChildren; i++) { previousResult = result; result = jjtGetChild(i).execute(result,context); if (result == null) { failedChild = i; break; } } if (result == null) { if (failedChild == -1) { result = EventHandlerUtil.invalidGetMethod(rsvc, context, "$" + rootString, previousResult, null, uberInfo); } else { StringBuffer name = new StringBuffer("$").append(rootString); for (int i = 0; i <= failedChild; i++) { Node node = jjtGetChild(i); if (node instanceof ASTMethod) { name.append(".").append(((ASTMethod) node).getMethodName()).append("()"); } else { name.append(".").append(node.getFirstToken().image); } } if (jjtGetChild(failedChild) instanceof ASTMethod) { String methodName = ((ASTMethod) jjtGetChild(failedChild)).getMethodName(); result = EventHandlerUtil.invalidMethod(rsvc, context, name.toString(), previousResult, methodName, uberInfo); } else { String property = jjtGetChild(failedChild).getFirstToken().image; result = EventHandlerUtil.invalidGetMethod(rsvc, context, name.toString(), previousResult, property, uberInfo); } } } return result; } catch(MethodInvocationException mie) { /* * someone tossed their cookies */ log.error("Method " + mie.getMethodName() + " threw exception for reference $" + rootString + " in template " + context.getCurrentTemplateName() + " at " + " [" + this.getLine() + "," + this.getColumn() + "]"); mie.setReferenceName(rootString); throw mie; } } /** * gets the value of the reference and outputs it to the * writer. * * @param context context of data to use in getting value * @param writer writer to render to * @return True if rendering was successful. * @throws IOException * @throws MethodInvocationException */ public boolean render(InternalContextAdapter context, Writer writer) throws IOException, MethodInvocationException { if (referenceType == RUNT) { if (context.getAllowRendering()) { writer.write(rootString); } return true; } Object value = execute(null, context); String localNullString = null; /* * if this reference is escaped (\$foo) then we want to do one of two things : 1) if this is * a reference in the context, then we want to print $foo 2) if not, then \$foo (its * considered schmoo, not VTL) */ if (escaped) { localNullString = getNullString(context); if (value == null) { if (context.getAllowRendering()) { writer.write(escPrefix); writer.write("\\"); writer.write(localNullString); } } else { if (context.getAllowRendering()) { writer.write(escPrefix); writer.write(localNullString); } } return true; } /* * the normal processing * * if we have an event cartridge, get a new value object */ value = EventHandlerUtil.referenceInsert(rsvc, context, literal(), value); String toString = null; if (value != null) { toString = value.toString(); } if (value == null || toString == null) { /* * write prefix twice, because it's schmoo, so the \ don't escape each other... */ if (context.getAllowRendering()) { if (localNullString == null) localNullString = getNullString(context); writer.write(escPrefix); writer.write(escPrefix); writer.write(morePrefix); writer.write(localNullString); } if (logOnNull && referenceType != QUIET_REFERENCE && log.isDebugEnabled()) { log.debug("Null reference [template '" + context.getCurrentTemplateName() + "', line " + this.getLine() + ", column " + this.getColumn() + "] : " + this.literal() + " cannot be resolved."); } return true; } else { /* * non-null processing */ if (context.getAllowRendering()) { writer.write(escPrefix); writer.write(morePrefix); writer.write(toString); } return true; } } /** * This method helps to implement the "render literal if null" functionality. * * VelocimacroProxy saves references to macro arguments (AST nodes) so that if we have a macro * #foobar($a $b) then there is key "$a.literal" which points to the literal presentation of the * argument provided to variable $a. If the value of $a is null, we render the string that was * provided as the argument. * * @param context * @return */ private String getNullString(InternalContextAdapter context) { Object callingArgument = context.get(".literal." + nullString); if (callingArgument != null) return ((Node) callingArgument).literal(); else return nullString; } /** * Computes boolean value of this reference * Returns the actual value of reference return type * boolean, and 'true' if value is not null * * @param context context to compute value with * @return True if evaluation was ok. * @throws MethodInvocationException */ public boolean evaluate(InternalContextAdapter context) throws MethodInvocationException { Object value = execute(null, context); if (value == null) { return false; } else if (value instanceof Boolean) { if (((Boolean) value).booleanValue()) return true; else return false; } else if (value.toString() == null) { return false; } else return true; } /** * @see org.apache.velocity.runtime.parser.node.SimpleNode#value(org.apache.velocity.context.InternalContextAdapter) */ public Object value(InternalContextAdapter context) throws MethodInvocationException { return (computableReference ? execute(null, context) : null); } /** * Sets the value of a complex reference (something like $foo.bar) * Currently used by ASTSetReference() * * @see ASTSetDirective * * @param context context object containing this reference * @param value Object to set as value * @return true if successful, false otherwise * @throws MethodInvocationException */ public boolean setValue( InternalContextAdapter context, Object value) throws MethodInvocationException { if (jjtGetNumChildren() == 0) { context.put(rootString, value); return true; } /* * The rootOfIntrospection is the object we will * retrieve from the Context. This is the base * object we will apply reflection to. */ Object result = getVariableValue(context, rootString); if (result == null) { String msg = "reference set : template = " + context.getCurrentTemplateName() + " [line " + getLine() + ",column " + getColumn() + "] : " + literal() + " is not a valid reference."; log.error(msg); return false; } /* * How many child nodes do we have? */ for (int i = 0; i < numChildren - 1; i++) { result = jjtGetChild(i).execute(result, context); if (result == null) { String msg = "reference set : template = " + context.getCurrentTemplateName() + " [line " + getLine() + ",column " + getColumn() + "] : " + literal() + " is not a valid reference."; log.error(msg); return false; } } /* * We support two ways of setting the value in a #set($ref.foo = $value ) : * 1) ref.setFoo( value ) * 2) ref,put("foo", value ) to parallel the get() map introspection */ try { VelPropertySet vs = rsvc.getUberspect().getPropertySet(result, identifier, value, uberInfo); if (vs == null) return false; vs.invoke(result, value); } catch(InvocationTargetException ite) { /* * this is possible */ throw new MethodInvocationException( "ASTReference : Invocation of method '" + identifier + "' in " + result.getClass() + " threw exception " + ite.getTargetException().toString(), ite.getTargetException(), identifier, context.getCurrentTemplateName(), this.getLine(), this.getColumn()); } /** * pass through application level runtime exceptions */ catch( RuntimeException e ) { throw e; } catch(Exception e) { /* * maybe a security exception? */ log.error("ASTReference setValue() : exception : " + e + " template = " + context.getCurrentTemplateName() + " [" + this.getLine() + "," + this.getColumn() + "]"); return false; } return true; } private String getRoot() { Token t = getFirstToken(); /* * we have a special case where something like * $(\\)*!, where the user want's to see something * like $!blargh in the output, but the ! prevents it from showing. * I think that at this point, this isn't a reference. */ /* so, see if we have "\\!" */ int slashbang = t.image.indexOf("\\!"); if (slashbang != -1) { /* * lets do all the work here. I would argue that if this occurrs, * it's not a reference at all, so preceeding \ characters in front * of the $ are just schmoo. So we just do the escape processing * trick (even | odd) and move on. This kind of breaks the rule * pattern of $ and # but '!' really tosses a wrench into things. */ /* * count the escapes : even # -> not escaped, odd -> escaped */ int i = 0; int len = t.image.length(); i = t.image.indexOf('$'); if (i == -1) { /* yikes! */ log.error("ASTReference.getRoot() : internal error : " + "no $ found for slashbang."); computableReference = false; nullString = t.image; return nullString; } while (i < len && t.image.charAt(i) != '\\') { i++; } /* ok, i is the first \ char */ int start = i; int count = 0; while (i < len && t.image.charAt(i++) == '\\') { count++; } /* * now construct the output string. We really don't care about * leading slashes as this is not a reference. It's quasi-schmoo */ nullString = t.image.substring(0,start); // prefix up to the first nullString += t.image.substring(start, start + count-1 ); // get the slashes nullString += t.image.substring(start+count); // and the rest, including the /* * this isn't a valid reference, so lets short circuit the value * and set calcs */ computableReference = false; return nullString; } /* * we need to see if this reference is escaped. if so * we will clean off the leading \'s and let the * regular behavior determine if we should output this * as \$foo or $foo later on in render(). Lazyness.. */ escaped = false; if (t.image.startsWith("\\")) { /* * count the escapes : even # -> not escaped, odd -> escaped */ int i = 0; int len = t.image.length(); while (i < len && t.image.charAt(i) == '\\') { i++; } if ((i % 2) != 0) escaped = true; if (i > 0) escPrefix = t.image.substring(0, i / 2 ); t.image = t.image.substring(i); } /* * Look for preceeding stuff like '#' and '$' * and snip it off, except for the * last $ */ int loc1 = t.image.lastIndexOf('$'); /* * if we have extra stuff, loc > 0 * ex. '#$foo' so attach that to * the prefix. */ if (loc1 > 0) { morePrefix = morePrefix + t.image.substring(0, loc1); t.image = t.image.substring(loc1); } /* * Now it should be clean. Get the literal in case this reference * isn't backed by the context at runtime, and then figure out what * we are working with. */ // FIXME: this is the key to render nulls as literals, we need to look at context(refname+".literal") nullString = literal(); if (t.image.startsWith("$!")) { referenceType = QUIET_REFERENCE; /* * only if we aren't escaped do we want to null the output */ if (!escaped) nullString = ""; if (t.image.startsWith("$!{")) { /* * ex : $!{provider.Title} */ return t.next.image; } else { /* * ex : $!provider.Title */ return t.image.substring(2); } } else if (t.image.equals("${")) { /* * ex : ${provider.Title} */ referenceType = FORMAL_REFERENCE; return t.next.image; } else if (t.image.startsWith("$")) { /* * just nip off the '$' so we have * the root */ referenceType = NORMAL_REFERENCE; return t.image.substring(1); } else { /* * this is a 'RUNT', which can happen in certain circumstances where * the parser is fooled into believeing that an IDENTIFIER is a real * reference. Another 'dreaded' MORE hack :). */ referenceType = RUNT; return t.image; } } /** * @param context * @param variable * @return The evaluated value of the variable. * @throws MethodInvocationException */ public Object getVariableValue(Context context, String variable) throws MethodInvocationException { return context.get(variable); } /** * Routine to allow the literal representation to be * externally overridden. Used now in the VM system * to override a reference in a VM tree with the * literal of the calling arg to make it work nicely * when calling arg is null. It seems a bit much, but * does keep things consistant. * * Note, you can only set the literal once... * * @param literal String to render to when null */ public void setLiteral(String literal) { /* * do only once */ if( this.literal == null) this.literal = literal; } /** * Override of the SimpleNode method literal() * Returns the literal representation of the * node. Should be something like * $<token>. * @return A literal string. */ public String literal() { if (literal != null) return literal; // this value could be cached in this.literal but it increases memory usage return super.literal(); } }

The table below shows all metrics for ASTReference.java.

MetricValueDescription
BLOCKS66.00Number of blocks
BLOCK_COMMENT164.00Number of block comment lines
COMMENTS276.00Comment lines
COMMENT_DENSITY 1.00Comment density
COMPARISONS71.00Number of comparison operators
CYCLOMATIC74.00Cyclomatic complexity
DECL_COMMENTS17.00Comments in declarations
DOC_COMMENT110.00Number of javadoc comment lines
ELOC276.00Effective lines of code
EXEC_COMMENTS40.00Comments in executable code
EXITS48.00Procedure exits
FUNCTIONS15.00Number of function declarations
HALSTEAD_DIFFICULTY95.90Halstead difficulty
HALSTEAD_EFFORT 0.00Halstead effort
INTERFACE_COMPLEXITY75.00Interface complexity
JAVA0001 0.00JAVA0001 Package name does not contain only lower case letters
JAVA0002 0.00JAVA0002 Package name does not begin with a top level domain name or country code
JAVA0003 0.00JAVA0003 Minimize use of on-demand (.*) imports
JAVA0004 0.00JAVA0004 Unnecessary import from java.lang
JAVA0005 0.00JAVA0005 Imports not in specified order
JAVA0006 0.00JAVA0006 Empty finally block
JAVA0007 0.00JAVA0007 Should not declare public field
JAVA0008 0.00JAVA0008 Empty catch block
JAVA0009 0.00JAVA0009 Protected member in final class
JAVA0010 0.00JAVA0010 Non-instantiable class does not contain a non-private static member
JAVA0011 0.00JAVA0011 Abstract class does not contain an abstract method
JAVA0012 0.00JAVA0012 Non-constructor method with same name as declaring class
JAVA0013 0.00JAVA0013 Non-blank final field is not static
JAVA0014 0.00JAVA0014 Class with only static members has non-private constructor
JAVA0015 0.00JAVA0015 Package class contains public nested type
JAVA0016 0.00JAVA0016 Abstract class contains public constructor
JAVA0017 0.00JAVA0017 Class name does not have required form
JAVA0018 0.00JAVA0018 Method name does not have required form
JAVA0019 0.00JAVA0019 Interface name does not have required form
JAVA0020 0.00JAVA0020 Field name does not have required form
JAVA0021 0.00JAVA0021 Interface method name does not have required form
JAVA0022 0.00JAVA0022 Static final field name does not have required form
JAVA0023 0.00JAVA0023 Empty finalize method
JAVA0024 0.00JAVA0024 Empty class
JAVA0025 0.00JAVA0025 Method override is empty
JAVA0026 0.00JAVA0026 Finalize method with parameters
JAVA0029 0.00JAVA0029 Private method not used
JAVA0030 0.00JAVA0030 Private field not used
JAVA0031 0.00JAVA0031 Case statement not properly closed
JAVA0032 0.00JAVA0032 Switch statement missing default
JAVA0033 0.00JAVA0033 default: not last case in switch statement
JAVA003413.00JAVA0034 Missing braces in if statement
JAVA0035 0.00JAVA0035 Missing braces in for statement
JAVA0036 0.00JAVA0036 Missing braces in while statement
JAVA0038 0.00JAVA0038 Non-case label in switch statement
JAVA0039 0.00JAVA0039 Break statement with label
JAVA0040 0.00JAVA0040 Switch statement contains N cases (maximum: M)
JAVA0041 0.00JAVA0041 Nested synchronized block
JAVA0042 0.00JAVA0042 Empty synchronized statement
JAVA0043 0.00JAVA0043 Inner class does not use outer class
JAVA0044 0.00JAVA0044 Serializable class with no instance variables
JAVA0045 0.00JAVA0045 Serializable class with only transient fields
JAVA0046 0.00JAVA0046 Name of class not derived from Exception ends with 'Exception'
JAVA0047 0.00JAVA0047 Serializable class derives from invalid base class
JAVA0048 0.00JAVA0048 Name of class derived from Exception does not end with 'Exception'
JAVA0049 2.00JAVA0049 Nested block at depth N (maximum: M)
JAVA0050 0.00JAVA0050 Class derives from java.lang.Error
JAVA0051 0.00JAVA0051 Class derives from java.lang.RuntimeException
JAVA0052 0.00JAVA0052 Class derives from java.lang.Throwable
JAVA0053 0.00JAVA0053 Unused label
JAVA0054 0.00JAVA0054 Inheritance depth N exceeds maximum M
JAVA0055 0.00JAVA0055 Class should be interface
JAVA0056 0.00JAVA0056 Unnecessary abstract modifier for interface or annotation
JAVA0057 0.00JAVA0057 Unnecessary default constructor
JAVA0058 0.00JAVA0058 Constructor calls super()
JAVA0059 0.00JAVA0059 Method override only calls super()
JAVA0061 0.00JAVA0061 Inaccessible member in anonymous class
JAVA0062 0.00JAVA0062 Public class missing public member or protected constructor
JAVA0063 0.00JAVA0063 Identifier name should not contain '$'
JAVA0064 0.00JAVA0064 N variations of identifier name (maximum: M)
JAVA0065 0.00JAVA0065 Unnecessary final modifier for method in final class
JAVA0066 0.00JAVA0066 Unnecessary modifier for interface nested type
JAVA0067 0.00JAVA0067 Array descriptor on identifier name
JAVA0068 0.00JAVA0068 Modifiers not declared in recommended order
JAVA0071 0.00JAVA0071 Strings compared with ==
JAVA0073 0.00JAVA0073 Integer division in floating-point context
JAVA0074 0.00JAVA0074 Use of Object.notify()
JAVA0075 0.00JAVA0075 Method parameter hides field
JAVA0076 0.00JAVA0076 Use of magic number
JAVA0077 0.00JAVA0077 Private field not used in declaring class
JAVA0078 0.00JAVA0078 Floating point values compared with ==
JAVA0079 0.00JAVA0079 Use of instance to reference static member
JAVA0080 0.00JAVA0080 Import declaration not used
JAVA0081 0.00JAVA0081 Boolean literal in comparison
JAVA0082 0.00JAVA0082 Unnecessary widening cast
JAVA0083 0.00JAVA0083 Unnecessary instanceof test
JAVA0084 1.00JAVA0084 Should use compound assignment operator
JAVA0085 0.00JAVA0085 Use of sun.* class
JAVA0087 0.00JAVA0087 Use of Thread.sleep()
JAVA0089 0.00JAVA0089 Use of restricted package
JAVA0092 0.00JAVA0092 Use of restricted type
JAVA0093 0.00JAVA0093 Redundant assignment
JAVA0094 0.00JAVA0094 Field hides a superclass field
JAVA0095 0.00JAVA0095 Uninitialized private field
JAVA0096 0.00JAVA0096 Field in nested class hides outer field
JAVA0098 0.00JAVA0098 Minimize use of implicit field initializers
JAVA0100 1.00JAVA0100 Class contains N non-final fields (maximum: M)
JAVA0101 0.00JAVA0101 Unnecessary modifier for field in interface
JAVA0102 0.00JAVA0102 Last statement in finalize() not super.finalize()
JAVA0103 0.00JAVA0103 Explicit call to finalize()
JAVA0104 0.00JAVA0104 finalize() only calls super.finalize()
JAVA0105 0.00JAVA0105 Duplicate import declaration
JAVA0106 0.00JAVA0106 Unnecessary import from current package
JAVA0108 0.00JAVA0108 Incorrect javadoc: no @param tag for 'parameter'
JAVA0109 0.00JAVA0109 Incorrect javadoc: no parameter 'parameter'
JAVA0110 3.00JAVA0110 Incorrect javadoc: no @return tag
JAVA0111 0.00JAVA0111 Incorrect javadoc: @return tag for void method
JAVA0112 0.00JAVA0112 Incorrect javadoc: no exception 'exception' in throws
JAVA0113 0.00JAVA0113 Incorrect javadoc: no @author tag
JAVA0114 0.00JAVA0114 Incorrect javadoc: no @version tag
JAVA0115 2.00JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception'
JAVA0116 0.00JAVA0116 Missing javadoc: field 'field'
JAVA0117 0.00JAVA0117 Missing javadoc: method 'method'
JAVA0118 0.00JAVA0118 Missing javadoc: type 'type'
JAVA0119 0.00JAVA0119 Control variable changed within body of for loop
JAVA0123 0.00JAVA0123 Use all three components of for loop
JAVA0125 0.00JAVA0125 Continue statement with label
JAVA0126 7.00JAVA0126 Method declares unchecked exception in throws
JAVA0128 0.00JAVA0128 Public constructor in non-public class
JAVA0130 0.00JAVA0130 Non-static method does not use instance fields
JAVA0131 0.00JAVA0131 Compatible method does not override base
JAVA0132 0.00JAVA0132 Method overload with compatible signature
JAVA0133 0.00JAVA0133 Non-synchronized method overrides synchronized method
JAVA0135 0.00JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method'
JAVA0136 0.00JAVA0136 N methods defined in class (maximum: M)
JAVA0137 0.00JAVA0137 Non-abstract class missing constructor
JAVA0138 0.00JAVA0138 N parameters defined for method (maximum: M)
JAVA0139 0.00JAVA0139 Definition of main other than public static void main(java.lang.String[])
JAVA0141 0.00JAVA0141 Unnecessary modifier for method in interface
JAVA0143 0.00JAVA0143 Synchronized method
JAVA0144 3.00JAVA0144 Line exceeds maximum M characters
JAVA0145 0.00JAVA0145 Tab character used in source file
JAVA0150 0.00JAVA0150 java.lang.Error (or subclass) thrown
JAVA0153 0.00JAVA0153 Inefficient conversion of integer to string
JAVA0159 0.00JAVA0159 Inefficient conversion of string to integer
JAVA0160 0.00JAVA0160 Method does not throw specified exception
JAVA0161 0.00JAVA0161 Conditional wait() not in loop
JAVA0163 0.00JAVA0163 Empty statement
JAVA0165 0.00JAVA0165 Conflicting return statement in finally block
JAVA0166 2.00JAVA0166 Generic exception caught
JAVA0167 0.00JAVA0167 ThreadDeath not rethrown
JAVA0169 0.00JAVA0169 Unnecessary catch block: exception 'exception'
JAVA0170 0.00JAVA0170 Caught exception not derived from java.lang.Exception
JAVA0171 0.00JAVA0171 Unused local variable
JAVA0173 0.00JAVA0173 Unused method parameter
JAVA0174 0.00JAVA0174 Assigned local variable never used
JAVA0175 0.00JAVA0175 Successive assignment to variable
JAVA0176 0.00JAVA0176 Local variable name does not have required form
JAVA0177 0.00JAVA0177 Variable declaration missing initializer
JAVA0179 0.00JAVA0179 Local variable hides visible field
JAVA0233 0.00JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID'
JAVA0234 0.00JAVA0234 Class is Serializable but does not define serialVersionUID
JAVA0235 0.00JAVA0235 Class defines serialVersionUID but does not implement Serializable
JAVA0236 0.00JAVA0236 Attempt to clone an object which does not implement Cloneable
JAVA0237 0.00JAVA0237 Class implements Cloneable but does not have public clone method
JAVA0238 0.00JAVA0238 Clone method does not call super.clone()
JAVA0239 0.00JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable
JAVA0240 0.00JAVA0240 Serializable class which declares readObject or writeObject but not both
JAVA0241 0.00JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class
JAVA0242 0.00JAVA0242 Transient field in non-Serializable class
JAVA0243 0.00JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected
JAVA0244 0.00JAVA0244 Field or method name in subclass differs only by case from inherited field or method
JAVA0245 0.00JAVA0245 JUnit TestCase with non-trivial constructor
JAVA0246 0.00JAVA0246 JUnit assertXXX statement missing message parameter
JAVA0247 0.00JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method
JAVA0248 0.00JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature
JAVA0249 0.00JAVA0249 JUnit TestCase 'suite()' should be declared static
JAVA0250 0.00JAVA0250 JUnit TestCase declares testXXX method with incorrect signature
JAVA0251 0.00JAVA0251 Use '%n' for line breaks in printf/format for platform independence
JAVA0252 0.00JAVA0252 'enum' is a Java 1.5 reserved word
JAVA0253 0.00JAVA0253 Not all enum constants consumed in switch statement
JAVA0254 0.00JAVA0254 Use enhanced for loop construct instead of Iterator
JAVA0255 0.00JAVA0255 Result of method invocation not used
JAVA0256 0.00JAVA0256 Assignment of external collection/array to field
JAVA0257 0.00JAVA0257 Use of 'Constant Interface' anti-pattern
JAVA0258 0.00JAVA0258 Implement Iterable for foreach compatibility
JAVA0259 0.00JAVA0259 Return of collection/array field
JAVA0260 0.00JAVA0260 Use 'enum' instead of Enumerated Type pattern
JAVA0261 0.00JAVA0261 Use specialized Enum collection types
JAVA0262 0.00JAVA0262 Use of char in integer context
JAVA0263 0.00JAVA0263 Long literal ends with 'l' instead of 'L'
JAVA0264 0.00JAVA0264 Integer math in long context - check for overflow
JAVA0265 0.00JAVA0265 Use of Throwable.printStackTrace()
JAVA0266 0.00JAVA0266 Use of System.out
JAVA0267 0.00JAVA0267 Use of System.err
JAVA0269 0.00JAVA0269 Contents of StringBuffer never used
JAVA0270 0.00JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array
JAVA0271 0.00JAVA0271 Minimize use of on-demand (.*) static imports
JAVA0272 0.00JAVA0272 Thread.run() called
JAVA0273 0.00JAVA0273 Non-final derivative of Thread calls start() in constructor
JAVA0274 0.00JAVA0274 Serializable class has a synchronized readObject()
JAVA0275 0.00JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods
JAVA0276 0.00JAVA0276 Unnecessary use of String constructor
JAVA0277 0.00JAVA0277 Iterator.next() implementation does not throw NoSuchElementException
JAVA0278 0.00JAVA0278 Unnecessary use of Boolean constructor
JAVA0279 0.00JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method
JAVA0280 0.00JAVA0280 IllegalMonitorStateException caught
JAVA0281 0.00JAVA0281 Iterator.next() not called in loop
JAVA0282 0.00JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext()
JAVA0283 0.00JAVA0283 Control variable not updated in loop body
JAVA0284 0.00JAVA0284 Explicit garbage collection
JAVA0285 0.00JAVA0285 Dereference of potentially null variable
JAVA0286 0.00JAVA0286 Dereference of null variable
JAVA0287 1.00JAVA0287 Unnecessary null check
JAVA0288 0.00JAVA0288 Inconsistent null check
LINES807.00Number of lines in the source file
LINE_COMMENT 2.00Number of line comments
LOC410.00Lines of code
LOGICAL_LINES165.00Number of statements
LOOPS 6.00Number of loops
NEST_DEPTH 6.00Maximum nesting depth
OPERANDS760.00Number of operands
OPERATORS1439.00Number of operators
PARAMS19.00Number of formal parameter declarations
PROGRAM_LENGTH2199.00Halstead program length
PROGRAM_VOCAB263.00Halstead program vocabulary
PROGRAM_VOLUME 0.00Halstead program volume
RETURNS56.00Number of return points from functions
SIZE24286.00Size of the file in bytes
UNIQUE_OPERANDS210.00Number of unique operands
UNIQUE_OPERATORS53.00Number of unique operators
WHITESPACE121.00Number of whitespace lines