StringFunctions.java
| Index Score | ||
|---|---|---|
 |
 |
freemarker.core.builtins |
 |
 |
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 | |
|---|---|---|
| JAVA0071 | JAVA0071 Strings compared with == |  |
| RETURNS | Number of return points from functions | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| BLOCKS | Number of blocks | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| COMPARISONS | Number of comparison operators | |
| SIZE | Size of the file in bytes | |
| LOC | Lines of code | |
| ELOC | Effective lines of code | |
| JAVA0010 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| OPERANDS | Number of operands | |
| LOGICAL_LINES | Number of statements | |
| EXITS | Procedure exits | |
| LINES | Number of lines in the source file | |
| FUNCTIONS | Number of function declarations | |
| JAVA0084 | JAVA0084 Should use compound assignment operator | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0150 | JAVA0150 java.lang.Error (or subclass) thrown | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| PROGRAM_VOLUME | Halstead program volume | |
| 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 | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| COMMENTS | Comment lines | |
/*
* 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.core.builtins;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.StringTokenizer;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import freemarker.core.Environment;
import freemarker.core.InvalidReferenceException;
import freemarker.core.ast.BuiltInExpression;
import freemarker.core.ast.NonNumericalException;
import freemarker.core.ast.TemplateNode;
import freemarker.template.*;
import freemarker.template.utility.StringUtil;
/**
* Implementations of ?substring and other
* standard functions that operate on strings
*/
public class StringFunctions extends BuiltIn {
static private HashMap<String, Pattern> patternLookup = new HashMap<String, Pattern>();
static private LinkedList<String> patterns = new LinkedList<String>();
static private final int PATTERN_CACHE_SIZE=100;
static Pattern getPattern(String patternString, String flagString) throws TemplateModelException {
int flags = 0;
String patternKey = patternString + (char) 0 + flagString;
Pattern result = patternLookup.get(patternKey);
if (result != null) {
return result;
}
if (flagString == null || flagString.length() == 0) {
try {
result = Pattern.compile(patternString);
} catch (PatternSyntaxException e) {
throw new TemplateModelException(e);
}
}
else {
if (flagString.indexOf('i') >=0) {
flags = flags | Pattern.CASE_INSENSITIVE;
}
if (flagString.indexOf('m') >=0) {
flags = flags | Pattern.MULTILINE;
}
if (flagString.indexOf('c') >=0) {
flags = flags | Pattern.COMMENTS;
}
if (flagString.indexOf('s') >=0) {
flags = flags | Pattern.DOTALL;
}
try {
result = Pattern.compile(patternString, flags);
} catch (PatternSyntaxException e) {
throw new TemplateModelException(e);
}
}
synchronized (patterns) {
patterns.add(patternKey);
patternLookup.put(patternKey, result);
if (patterns.size() > PATTERN_CACHE_SIZE) {
Object first = patterns.removeFirst();
patterns.remove(first);
}
}
return result;
}
public TemplateModel get(TemplateModel target, String builtInName, Environment env, BuiltInExpression callingExpression) throws TemplateException {
if (builtInName == "number" && target instanceof TemplateNumberModel) return target;
if (builtInName == "groups") {
if (target instanceof RegexMatchModel) {
return ((RegexMatchModel) target).getGroups();
}
if (target instanceof RegexMatchModel.Match) {
return ((RegexMatchModel.Match) target).subs;
}
else {
throw TemplateNode.invalidTypeException(target, callingExpression.getTarget(), env, "regular expression matcher");
}
}
else try {
String string = ((TemplateScalarModel) target).getAsString();
return getStringFunction(string, builtInName, env, callingExpression);
} catch (ClassCastException cce) {
throw TemplateNode.invalidTypeException(target, callingExpression.getTarget(), env, "string");
} catch (NullPointerException npe) {
throw new InvalidReferenceException("String is undefined", env);
}
}
private TemplateModel getStringFunction(final String string, final String builtInName,
final Environment env, final BuiltInExpression callingExpression) throws TemplateException {
if (builtInName == "length") {
return new SimpleNumber(Integer.valueOf(string.length()));
}
if (builtInName == "number") {
try {
return new SimpleNumber(env.getArithmeticEngine().toNumber(string));
}
catch(NumberFormatException nfe) {
String mess = "Error: " + callingExpression.getStartLocation()
+ "\nExpecting a number here, found: " + string;
throw new NonNumericalException(mess, env);
}
}
if (builtInName == "starts_with" || builtInName == "ends_with") {
return new StartsOrEndsWithMethod(string, callingExpression);
}
if (builtInName == "substring") {
return new SubstringMethod(string, callingExpression);
}
if (builtInName == "replace") {
return new ReplaceMethod(string);
}
if (builtInName == "split") {
return new SplitMethod(string);
}
if (builtInName == "matches") {
return new MatcherBuilder(string);
}
if (builtInName == "index_of" || builtInName == "last_index_of") {
return new IndexOfMethod(string, callingExpression);
}
if (builtInName == "contains") {
return new ContainsMethod(string);
}
if (builtInName == "left_pad") {
return new LeftPadMethod(string);
}
if (builtInName == "right_pad") {
return new RightPadMethod(string);
}
if (builtInName == "word_list") {
StringTokenizer st = new StringTokenizer(string);
SimpleSequence result = new SimpleSequence();
while (st.hasMoreTokens()) {
result.add(st.nextToken());
}
return result;
}
if (builtInName == "url") {
return new urlBIResult(string, env);
}
throw new InternalError("Cannot deal with built-in ?" + builtInName);
}
static class ReplaceMethod implements TemplateMethodModel {
String string;
ReplaceMethod(String string) {
this.string = string;
}
public Object exec(List args) throws TemplateModelException {
int numArgs = args.size();
if (numArgs < 2 || numArgs >3 ) {
throw new TemplateModelException(
"?replace(...) needs 2 or 3 arguments.");
}
String first = (String) args.get(0);
String second = (String) args.get(1);
String flags = numArgs >2 ? (String) args.get(2) : "";
boolean caseInsensitive = flags.indexOf('i') >=0;
boolean useRegexp = flags.indexOf('r') >=0;
boolean firstOnly = flags.indexOf('f') >=0;
String result = null;
if (!useRegexp) {
result = StringUtil.replace(string, first, second, caseInsensitive, firstOnly);
} else {
Pattern pattern = getPattern(first, flags);
Matcher matcher = pattern.matcher(string);
result = firstOnly ? matcher.replaceFirst(second) : matcher.replaceAll(second);
}
return new SimpleScalar(result);
}
}
static class SubstringMethod implements TemplateMethodModelEx {
String string;
BuiltInExpression callingExpression;
SubstringMethod(String string, BuiltInExpression callingExpression) {
this.string = string;
this.callingExpression = callingExpression;
}
public Object exec(java.util.List args) throws TemplateModelException {
int argCount = args.size(), left=0, right=0;
if (argCount != 1 && argCount != 2) {
throw new TemplateModelException("Error: +getStartLocation() + \nExpecting 1 or 2 numerical arguments here");
}
try {
TemplateNumberModel tnm = (TemplateNumberModel) args.get(0);
left = tnm.getAsNumber().intValue();
if (argCount == 2) {
tnm = (TemplateNumberModel) args.get(1);
right = tnm.getAsNumber().intValue();
}
} catch (ClassCastException cce) {
String mess = "Error: " + callingExpression.getStartLocation() + "\nExpecting numerical argument here";
throw new TemplateModelException(mess);
}
if (argCount == 1) {
return new SimpleScalar(string.substring(left));
}
return new SimpleScalar(string.substring(left, right));
}
}
static class SplitMethod implements TemplateMethodModel {
private String string;
SplitMethod(String string) {
this.string = string;
}
public Object exec(List args) throws TemplateModelException {
int numArgs = args.size();
if (numArgs < 1 || numArgs >2 ) {
throw new TemplateModelException(
"?replace(...) needs 1 or 2 arguments.");
}
String splitString = (String) args.get(0);
String flags = numArgs >1 ? (String) args.get(1) : "";
boolean caseInsensitive = flags.indexOf('i') >=0;
boolean useRegexp = flags.indexOf('r') >=0;
String[] result = null;
if (!useRegexp) {
result = StringUtil.split(string, splitString, caseInsensitive);
} else {
Pattern pattern = getPattern(splitString, flags);
result = pattern.split(string);
}
return ObjectWrapper.DEFAULT_WRAPPER.wrap(result);
}
}
static class MatcherBuilder implements TemplateMethodModel {
String matchString;
MatcherBuilder(String matchString) {
this.matchString = matchString;
}
public Object exec(List args) throws TemplateModelException {
int numArgs = args.size();
if (numArgs == 0) {
throw new TemplateModelException("Expecting at least one argument");
}
if (numArgs > 2) {
throw new TemplateModelException("Expecting at most two argumnets");
}
String patternString = (String) args.get(0);
String flagString = (numArgs >1) ? (String) args.get(1) : "";
Pattern pattern = getPattern(patternString, flagString);
Matcher matcher = pattern.matcher(matchString);
return new RegexMatchModel(matcher, matchString);
}
}
static class RegexMatchModel
implements TemplateBooleanModel, TemplateCollectionModel, TemplateSequenceModel {
Matcher matcher;
String input;
final boolean matches;
TemplateSequenceModel groups;
private ArrayList<TemplateModel> data;
RegexMatchModel(Matcher matcher, String input) {
this.matcher = matcher;
this.input = input;
this.matches = matcher.matches();
}
public boolean getAsBoolean() {
return matches;
}
public TemplateModel get(int i) throws TemplateModelException {
if (data == null) initSequence();
return data.get(i);
}
public int size() throws TemplateModelException {
if (data == null) initSequence();
return data.size();
}
private void initSequence() throws TemplateModelException {
data = new ArrayList<TemplateModel>();
TemplateModelIterator it = iterator();
while (it.hasNext()) {
data.add(it.next());
}
}
public TemplateModel getGroups() {
if (groups == null) {
groups = new TemplateSequenceModel() {
public int size() throws TemplateModelException {
try {
return matcher.groupCount() + 1;
}
catch (Exception e) {
throw new TemplateModelException(e);
}
}
public TemplateModel get(int i) throws TemplateModelException {
try {
return new SimpleScalar(matcher.group(i));
}
catch (Exception e) {
throw new TemplateModelException(e);
}
}
};
}
return groups;
}
public TemplateModelIterator iterator() {
matcher.reset();
return new TemplateModelIterator() {
boolean hasFindInfo = matcher.find();
public boolean hasNext() {
return hasFindInfo;
}
public TemplateModel next() throws TemplateModelException {
if (!hasNext()) throw new TemplateModelException("No more matches");
Match result = new Match();
hasFindInfo = matcher.find();
return result;
}
};
}
class Match implements TemplateScalarModel {
String match;
SimpleSequence subs = new SimpleSequence();
Match() {
match = input.substring(matcher.start(), matcher.end());
for (int i=0; i< matcher.groupCount() + 1; i++) {
subs.add(matcher.group(i));
}
}
public String getAsString() {
return match;
}
}
}
static class LeftPadMethod implements TemplateMethodModelEx {
private String string;
LeftPadMethod(String s) {
this.string = s;
}
public Object exec(List args) throws TemplateModelException {
Object obj;
int ln = args.size();
if (ln == 0) {
throw new TemplateModelException(
"?left_pad(...) expects at least 1 argument.");
}
if (ln > 2) {
throw new TemplateModelException(
"?left_pad(...) expects at most 2 arguments.");
}
obj = args.get(0);
if (!(obj instanceof TemplateNumberModel)) {
throw new TemplateModelException(
"?left_pad(...) expects a number as "
+ "its 1st argument.");
}
int width = ((TemplateNumberModel) obj).getAsNumber().intValue();
if (ln > 1) {
obj = args.get(1);
if (!(obj instanceof TemplateScalarModel)) {
throw new TemplateModelException(
"?left_pad(...) expects a string as "
+ "its 2nd argument.");
}
String filling = ((TemplateScalarModel) obj).getAsString();
try {
return new SimpleScalar(StringUtil.leftPad(string, width, filling));
} catch (IllegalArgumentException e) {
if (filling.length() == 0) {
throw new TemplateModelException(
"The 2nd argument of ?left_pad(...) "
+ "can't be a 0 length string.");
} else {
throw new TemplateModelException(
"Error while executing the ?left_pad(...) "
+ "built-in.", e);
}
}
} else {
return new SimpleScalar(StringUtil.leftPad(string, width));
}
}
}
static class RightPadMethod implements TemplateMethodModelEx {
private String string;
private RightPadMethod(String string) {
this.string = string;
}
public Object exec(List args) throws TemplateModelException {
Object obj;
int ln = args.size();
if (ln == 0) {
throw new TemplateModelException(
"?right_pad(...) expects at least 1 argument.");
}
if (ln > 2) {
throw new TemplateModelException(
"?right_pad(...) expects at most 2 arguments.");
}
obj = args.get(0);
if (!(obj instanceof TemplateNumberModel)) {
throw new TemplateModelException(
"?right_pad(...) expects a number as "
+ "its 1st argument.");
}
int width = ((TemplateNumberModel) obj).getAsNumber().intValue();
if (ln > 1) {
obj = args.get(1);
if (!(obj instanceof TemplateScalarModel)) {
throw new TemplateModelException(
"?right_pad(...) expects a string as "
+ "its 2nd argument.");
}
String filling = ((TemplateScalarModel) obj).getAsString();
try {
return new SimpleScalar(StringUtil.rightPad(string, width, filling));
} catch (IllegalArgumentException e) {
if (filling.length() == 0) {
throw new TemplateModelException(
"The 2nd argument of ?right_pad(...) "
+ "can't be a 0 length string.");
} else {
throw new TemplateModelException(
"Error while executing the ?right_pad(...) "
+ "built-in.", e);
}
}
} else {
return new SimpleScalar(StringUtil.rightPad(string, width));
}
}
}
static class urlBIResult implements TemplateScalarModel, TemplateMethodModel {
private final String target;
private final Environment env;
private String cachedResult;
private urlBIResult(String target, Environment env) {
this.target = target;
this.env = env;
}
public String getAsString() throws TemplateModelException {
if (cachedResult == null) {
String cs = env.getEffectiveURLEscapingCharset();
if (cs == null) {
throw new TemplateModelException(
"To do URL encoding, the framework that encloses "
+ "FreeMarker must specify the output encoding "
+ "or the URL encoding charset, so ask the "
+ "programmers to fix it. Or, as a last chance, "
+ "you can set the url_encoding_charset setting in "
+ "the template, e.g. "
+ "<#setting url_escaping_charset='ISO-8859-1'>, or "
+ "give the charset explicitly to the buit-in, e.g. "
+ "foo?url('ISO-8859-1').");
}
try {
cachedResult = StringUtil.URLEnc(target, cs);
} catch (UnsupportedEncodingException e) {
throw new TemplateModelException(
"Failed to execute URL encoding.", e);
}
}
return cachedResult;
}
public Object exec(List args) throws TemplateModelException {
if (args.size() != 1) {
throw new TemplateModelException("The \"url\" built-in "
+ "needs exactly 1 parameter, the charset.");
}
try {
return new SimpleScalar(
StringUtil.URLEnc(target, (String) args.get(0)));
} catch (UnsupportedEncodingException e) {
throw new TemplateModelException(
"Failed to execute URL encoding.", e);
}
}
}
static class StartsOrEndsWithMethod implements TemplateMethodModelEx {
private String string;
BuiltInExpression callingExpression;
boolean isEndsWith;
private StartsOrEndsWithMethod(String string, BuiltInExpression callingExpression) {
this.string = string;
this.callingExpression = callingExpression;
isEndsWith = callingExpression.getName() == "ends_with";
}
public Object exec(List args) throws TemplateModelException {
String sub;
if (args.size() != 1) {
throw new TemplateModelException(
"?" + callingExpression.getName()+ "(...) expects exactly 1 argument.");
}
Object obj = args.get(0);
if (!(obj instanceof TemplateScalarModel)) {
throw new TemplateModelException(
"?"+ callingExpression.getName() + "(...) expects a string argument");
}
sub = ((TemplateScalarModel) obj).getAsString();
boolean result = isEndsWith ? string.endsWith(sub) : string.startsWith(sub);
return result ? TemplateBooleanModel.TRUE : TemplateBooleanModel.FALSE;
}
}
static class IndexOfMethod implements TemplateMethodModelEx {
private String s;
BuiltInExpression callingExpression;
IndexOfMethod(String s, BuiltInExpression callingExpression) {
this.s = s;
this.callingExpression = callingExpression;
}
public Object exec(List args) throws TemplateModelException {
Object obj;
String sub;
int fidx;
int ln = args.size();
if (ln == 0) {
throw new TemplateModelException(
"?index_of(...) expects at least one argument.");
}
if (ln > 2) {
throw new TemplateModelException(
"?index_of(...) expects at most two arguments.");
}
obj = args.get(0);
if (!(obj instanceof TemplateScalarModel)) {
throw new TemplateModelException(
"?" + callingExpression.getName() + "(...) expects a string as "
+ "its first argument.");
}
sub = ((TemplateScalarModel) obj).getAsString();
if (ln > 1) {
obj = args.get(1);
if (!(obj instanceof TemplateNumberModel)) {
throw new TemplateModelException(
"?" + callingExpression.getName() + "(...) expects a number as "
+ "its second argument.");
}
fidx = ((TemplateNumberModel) obj).getAsNumber().intValue();
} else {
fidx = 0;
}
int index;
if (callingExpression.getName() == "last_index_of") {
if (ln >1)
index = s.lastIndexOf(sub, fidx);
else
index = s.lastIndexOf(sub);
} else {
index = s.indexOf(sub, fidx);
}
return new SimpleNumber(index);
}
}
static class ContainsMethod implements TemplateMethodModelEx {
private String s;
private ContainsMethod(String s) {
this.s = s;
}
public Object exec(List args) throws TemplateModelException {
Object obj;
String sub;
int ln = args.size();
if (ln != 1) {
throw new TemplateModelException(
"?contains(...) expects one argument.");
}
obj = args.get(0);
if (!(obj instanceof TemplateScalarModel)) {
throw new TemplateModelException(
"?contains(...) expects a string as "
+ "its first argument.");
}
sub = ((TemplateScalarModel) obj).getAsString();
return
(s.indexOf(sub) != -1) ?
TemplateBooleanModel.TRUE :
TemplateBooleanModel.FALSE;
}
}
}
The table below shows all metrics for StringFunctions.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 132.00 | Number of blocks | |
| BLOCK_COMMENT | 51.00 | Number of block comment lines | |
| COMMENTS | 55.00 | Comment lines | |
| COMMENT_DENSITY | 0.12 | Comment density | |
| COMPARISONS | 82.00 | Number of comparison operators | |
| CYCLOMATIC | 129.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 2.00 | Comments in declarations | |
| DOC_COMMENT | 4.00 | Number of javadoc comment lines | |
| ELOC | 443.00 | Effective lines of code | |
| EXEC_COMMENTS | 0.00 | Comments in executable code | |
| EXITS | 64.00 | Procedure exits | |
| FUNCTIONS | 37.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 82.20 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 154.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 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 4.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 | 7.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 | 1.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 | 3.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 19.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 | 4.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 | 3.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 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 1.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 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 | 1.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 | 1.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 358.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 1.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 | 9.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 | 699.00 | Number of lines in the source file | |
| LINE_COMMENT | 0.00 | Number of line comments | |
| LOC | 571.00 | Lines of code | |
| LOGICAL_LINES | 244.00 | Number of statements | |
| LOOPS | 3.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 1195.00 | Number of operands | |
| OPERATORS | 2233.00 | Number of operators | |
| PARAMS | 38.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3428.00 | Halstead program length | |
| PROGRAM_VOCAB | 430.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 116.00 | Number of return points from functions | |
| SIZE | 26348.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 378.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 52.00 | Number of unique operators | |
| WHITESPACE | 73.00 | Number of whitespace lines | |