TextBlock.java
| Index Score | ||
|---|---|---|
 |
 |
freemarker.core.ast |
 |
 |
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 | |
|---|---|---|
| JAVA0034 | JAVA0034 Missing braces in if statement |  |
| COMPARISONS | Number of comparison operators | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| CYCLOMATIC | Cyclomatic complexity | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| LOGICAL_LINES | Number of statements | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0171 | JAVA0171 Unused local variable | |
| BLOCKS | Number of blocks | |
| UNIQUE_OPERATORS | Number of unique operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| LOOPS | Number of loops | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| WHITESPACE | Number of whitespace lines | |
| DECL_COMMENTS | Comments in declarations | |
| DOC_COMMENT | Number of javadoc comment lines | |
| SIZE | Size of the file in bytes | |
| EXEC_COMMENTS | Comments in executable code | |
| RETURNS | Number of return points from functions | |
| COMMENTS | Comment lines | |
/*
* Copyright (C) 2003, 2008 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.core.ast;
import java.io.IOException;
import java.io.Writer;
import java.util.*;
import freemarker.template.Template;
import freemarker.core.Environment;
/**
* A TemplateElement representing a block of plain text.
* @version $Id: TextBlock.java,v 1.17 2004/01/06 17:06:42 szegedia Exp $
*/
public final class TextBlock extends TemplateElement {
static public final TextBlock EMPTY_BLOCK = new TextBlock("");
static {
EMPTY_BLOCK.ignore = true;
}
static private String rightTrim(String s) {
for (int i= s.length() -1; i>=0; i--) {
char c = s.charAt(i);
if (!isWhitespace(c)) {
return s.substring(0, i+1);
}
}
return "";
}
// We're using char[] instead of String for storing the text block because
// Writer.write(String) involves copying the String contents to a char[]
// using String.getChars(), and then calling Writer.write(char[]). By
// using Writer.write(char[]) directly, we avoid array copying on each
// write.
private char[] text;
private int type;
private boolean ignore;
public static final int PRINTABLE_TEXT = 0;
public static final int WHITE_SPACE = 1;
public static final int OPENING_WS = 2;
public static final int TRAILING_WS = 3;
public TextBlock(String text) {
this.text = text.toCharArray();
}
public void setLocation(Template template, int beginColumn, int beginLine, int endColumn, int endLine) {
super.setLocation(template, beginColumn, beginLine, endColumn, endLine);
boolean printable = false;
for (char c : text){
if (c != ' ' && c!='\t' && c!='\r' && c!='\n') printable = true;
}
if (printable) {
this.type = PRINTABLE_TEXT;
}
else {
char lastChar = text[text.length -1];
boolean containsEOL = (lastChar == '\n' || lastChar == '\r');
boolean containsStart = (beginColumn == 1);
if (containsEOL && containsStart) this.type = WHITE_SPACE;
else if (!containsEOL && !containsStart) this.type = WHITE_SPACE;
else if (containsEOL) this.type = TRAILING_WS;
else this.type = OPENING_WS;
}
this.text = null; // Now that we have location info, we don't need this. :-)
}
public String getText() {
return text != null ? new String(text) : getSource();
}
public void setText(String text) {
this.text = text.toCharArray();
}
public int getType() {
return type;
}
public void setIgnore(boolean ignore) {
this.ignore = ignore;
}
/**
* Simply outputs the text.
*/
public void execute(Environment env)
throws IOException
{
if (this.ignore) return;
Writer out = env.getOut();
if (text != null) {
out.write(text);
}
else {
template.writeTextAt(out, beginColumn, beginLine, endColumn, endLine);
}
}
public String getDescription() {
String s = new String(getText()).trim();
if (s.length() == 0) {
return "whitespace";
}
if (s.length() > 20) {
s = s.substring(0,20) + "...";
s = s.replace('\n', ' ');
s = s.replace('\r', ' ');
}
return "text block (" + s + ")";
}
public boolean isIgnorable() {
return ignore;
}
public boolean isWhitespace() {
if (text == null) return this.type != PRINTABLE_TEXT;
for (char c : text) {
if (!isWhitespace(c)) return false;
}
return true;
}
static private List<TextBlock> breakSingleLineIntoBlocks(String input, Template template, int column, int line) {
List<TextBlock> result = new ArrayList<TextBlock>();
char lastChar = input.charAt(input.length()-1);
boolean spansRight = (lastChar == '\r' || lastChar == '\n');
boolean spansLeft = (column == 1);
boolean spansEntireLine = spansRight && spansLeft;
boolean boundedBothSides = !spansRight && !spansLeft;
if (spansEntireLine || boundedBothSides
|| (spansLeft && !isWhitespace(input.charAt(0)))
)
{
TextBlock tb = new TextBlock(input);
tb.setLocation(template, column, line, column + input.length() -1, line);
result.add(tb);
return result;
}
if (spansLeft) {
String printablePart = leftTrim(input);
String openingWS = input.substring(0, input.length() - printablePart.length());
if (openingWS.length() >0) {
TextBlock tb = new TextBlock(openingWS);
tb.setLocation(template, column, line, openingWS.length(), line);
result.add(tb);
}
if (printablePart.length() >0) {
TextBlock tb = new TextBlock(printablePart);
tb.setLocation(template, column + openingWS.length(), line, column + input.length() -1, line);
result.add(tb);
}
return result;
}
// Remaining case is a line that has trailing WS.
String startingPart = rightTrim(input);
String trailingWS = input.substring(startingPart.length());
if (startingPart.length() >0) {
TextBlock tb = new TextBlock(startingPart);
tb.setLocation(template, column, line, column + startingPart.length() -1, line);
result.add(tb);
}
if (trailingWS.length()>0) {
TextBlock tb = new TextBlock(trailingWS);
tb.setLocation(template, column + startingPart.length(), line, column + input.length() -1, line);
result.add(tb);
}
return result;
}
static public List<TextBlock> breakIntoBlocksLineByLine(String input, Template template, int beginColumn, int beginLine) {
List<String> lines = lines(input);
List<TextBlock> result = new ArrayList<TextBlock>();
for (String line : lines) {
String ltrim = leftTrim(line);
int initWSLength = line.length() - ltrim.length();
if (initWSLength >0) {
TextBlock tb = new TextBlock(line.substring(0, initWSLength));
tb.setLocation(template, beginColumn, beginLine, beginColumn+initWSLength-1, beginLine);
beginColumn += initWSLength;
tb.type = TextBlock.OPENING_WS;
result.add(tb);
}
if (ltrim.length() >0) {
String trimmed = rightTrim(ltrim);
int trailingWSLength = ltrim.length() - trimmed.length();
if (trimmed.length() >0) {
TextBlock tb = new TextBlock(trimmed);
tb.setLocation(template, beginColumn, beginLine, beginColumn + trimmed.length() -1, beginLine);
tb.type = TextBlock.PRINTABLE_TEXT;
result.add(tb);
beginColumn += trimmed.length();
}
if (trailingWSLength>0) {
String trailingWS = ltrim.substring(trimmed.length());
TextBlock tb = new TextBlock(trailingWS);
tb.setLocation(template, beginColumn, beginLine, beginColumn + trailingWSLength-1, beginLine);
tb.type = TextBlock.TRAILING_WS;
result.add(tb);
}
}
beginColumn = 1;
beginLine++;
}
return result;
}
static public List<TextBlock> breakIntoBlocks(String input, Template template, int beginColumn, int beginLine) {
int numLines = countLines(input);
if (numLines == 1) {
return breakSingleLineIntoBlocks(input, template, beginColumn, beginLine);
}
String firstLine = firstLine(input);
String lastLine = lastLine(input);
String middleLines = input.substring(firstLine.length(), input.length() - lastLine.length());
List<TextBlock> result = new ArrayList<TextBlock>();
// If the first line spans from column 1, we don't need to break it up. Otherwise we do.
if (beginColumn == 1) {
middleLines = input.substring(0, firstLine.length() + middleLines.length());
}
else {
String firstPart = rightTrim(firstLine);
String trailingWS = firstLine.substring(firstPart.length());
if (firstPart.length() >0) {
TextBlock tb = new TextBlock(firstPart);
int type = firstPart.trim().length() == 0 ? WHITE_SPACE : PRINTABLE_TEXT;
tb.setLocation(template, beginColumn, beginLine, beginColumn + firstPart.length() -1, beginLine);
result.add(tb);
}
if (trailingWS.length() >0) {
TextBlock tb = new TextBlock(trailingWS);
tb.setLocation(template, beginColumn + firstPart.length(), beginLine, beginColumn + firstLine.length() -1, beginLine);
result.add(tb);
}
}
// Now the middle lines, the ones in between the first and last line, are just all added as regular text
// If the first line spans from the left, we prepend that.
// If the last line spans to the end, we're cool. Also, if the last line has no opening whitespace, we are finished.
boolean mergeLastLine = lastLine.endsWith("\n") || lastLine.endsWith("\r") || !isWhitespace(lastLine.charAt(0));
if (mergeLastLine) {
if (beginColumn ==1) {
middleLines = input;
} else {
middleLines = input.substring(firstLine.length());
}
}
if (middleLines.length() > 0) {
TextBlock tb = new TextBlock(middleLines);
int startingLine = beginLine;
int startingColumn = 1;
if (beginColumn != 1) ++startingLine;
int endColumn = mergeLastLine ? lastLine.length() : lastLine(middleLines).length();
int endingLine = beginLine + numLines -1;
if (!mergeLastLine) endingLine--;
tb.setLocation(template, 1, startingLine, endColumn, endingLine);
result.add(tb);
}
if (!mergeLastLine) {
String printablePart = leftTrim(lastLine);
String openingWS= lastLine.substring(0, lastLine.length() - printablePart.length());
if (openingWS.length() >0) {
TextBlock tb = new TextBlock(openingWS);
tb.setLocation(template, 1, beginLine + numLines -1, openingWS.length(), beginLine + numLines -1);
result.add(tb);
}
if (printablePart.length()>0) {
TextBlock tb = new TextBlock(printablePart);
tb.setLocation(template, 1 + openingWS.length(), beginLine + numLines -1, lastLine.length(), beginLine + numLines -1);
result.add(tb);
}
} // Now we really are finished!
return result;
}
static private boolean isWhitespace(char c) {
return c == '\n' || c == '\r' || c == '\t' || c == ' ';
}
static private int countLines(String input) {
int result = 0;
char lastChar = 0;
for (int i=0; i<input.length();i++) {
char c = input.charAt(i);
if (c=='\r') ++result;
else if (c=='\n' && lastChar != '\r') ++result;
lastChar = c;
}
if (lastChar != '\n' && lastChar != '\r') ++result;
return result;
}
static private String firstLine(String input) {
for (int i=0; i<input.length(); i++) {
char c = input.charAt(i);
if (c == '\n') {
return input.substring(0, i+1);
}
if (c=='\r') {
if (input.length() == i+1) {
return input;
}
int endLine = (input.charAt(i+1) == '\n') ? i+1 : i;
return input.substring(0, endLine +1);
}
}
return input;
}
static private String lastLine(String input) {
int lineLength = input.length();
if (lineLength <2) return input;
int startBackTrack = lineLength-1;
char lastChar = input.charAt(startBackTrack);
if (lastChar == '\r' || lastChar=='\n') startBackTrack--;
if (lastChar =='\n') {
if (input.charAt(startBackTrack) == '\r') startBackTrack--;
}
for (int i=startBackTrack; i>=0; i--) {
char c = input.charAt(i);
if (c == '\n' || c=='\r') {
return input.substring(i+1);
}
}
return input;
}
static private List<String> lines(String input) {
List<String> result = new ArrayList<String>();
while (input.length() >0) {
String line = firstLine(input);
result.add(line);
input = input.substring(line.length());
}
return result;
}
static private String leftTrim(String s) {
for (int i=0; i<s.length(); i++) {
char c = s.charAt(i);
if (!isWhitespace(c)) {
return s.substring(i);
}
}
return "";
}
}
The table below shows all metrics for TextBlock.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 65.00 | Number of blocks | |
| BLOCK_COMMENT | 51.00 | Number of block comment lines | |
| COMMENTS | 68.00 | Comment lines | |
| COMMENT_DENSITY | 0.28 | Comment density | |
| COMPARISONS | 96.00 | Number of comparison operators | |
| CYCLOMATIC | 95.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 4.00 | Comments in declarations | |
| DOC_COMMENT | 7.00 | Number of javadoc comment lines | |
| ELOC | 239.00 | Effective lines of code | |
| EXEC_COMMENTS | 5.00 | Comments in executable code | |
| EXITS | 24.00 | Procedure exits | |
| FUNCTIONS | 20.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 126.54 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 64.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 | 16.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 | 1.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 | 11.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 | 2.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 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 1.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 5.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 8.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 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 3.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 772.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 | 2.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 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 | 1.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 | 401.00 | Number of lines in the source file | |
| LINE_COMMENT | 10.00 | Number of line comments | |
| LOC | 306.00 | Lines of code | |
| LOGICAL_LINES | 180.00 | Number of statements | |
| LOOPS | 6.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 906.00 | Number of operands | |
| OPERATORS | 1596.00 | Number of operators | |
| PARAMS | 28.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2502.00 | Halstead program length | |
| PROGRAM_VOCAB | 229.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 36.00 | Number of return points from functions | |
| SIZE | 13739.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 179.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 50.00 | Number of unique operators | |
| WHITESPACE | 27.00 | Number of whitespace lines | |