SequenceFunctions.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 | |
|---|---|---|
| RETURNS | Number of return points from functions |  |
| JAVA0071 | JAVA0071 Strings compared with == | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| BLOCKS | Number of blocks | |
| CYCLOMATIC | Cyclomatic complexity | |
| COMPARISONS | Number of comparison operators | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| JAVA0010 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| OPERATORS | Number of operators | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| SIZE | Size of the file in bytes | |
| PROGRAM_LENGTH | Halstead program length | |
| LOOPS | Number of loops | |
| OPERANDS | Number of operands | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LOGICAL_LINES | Number of statements | |
| LINES | Number of lines in the source file | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0150 | JAVA0150 java.lang.Error (or subclass) thrown | |
| UNIQUE_OPERATORS | Number of unique operators | |
| NEST_DEPTH | Maximum nesting depth | |
| 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 | |
| JAVA0179 | JAVA0179 Local variable hides visible field | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| DECL_COMMENTS | Comments in declarations | |
| DOC_COMMENT | Number of javadoc comment lines | |
| FUNCTIONS | Number of function 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.text.Collator;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
import java.util.List;
import freemarker.core.Environment;
import freemarker.core.ast.ArithmeticEngine;
import freemarker.core.ast.BuiltInExpression;
import freemarker.core.ast.TemplateNode;
import freemarker.template.*;
import freemarker.template.utility.StringUtil;
/**
* Implementations of builtins for standard functions that operate on sequences
*/
public class SequenceFunctions extends BuiltIn {
static final int KEY_TYPE_STRING = 1;
static final int KEY_TYPE_NUMBER = 2;
static final int KEY_TYPE_DATE = 3;
public TemplateModel get(TemplateModel target, String builtInName,
Environment env, BuiltInExpression callingExpression)
throws TemplateException {
if (!(target instanceof TemplateSequenceModel)) {
if (builtInName == "seq_contains" && target instanceof TemplateCollectionModel) {
// Hacky special case
return new SequenceContainsFunction(target, env, callingExpression);
}
throw TemplateNode.invalidTypeException(target,
callingExpression.getTarget(), env, "sequence");
}
TemplateSequenceModel sequence = (TemplateSequenceModel) target;
return getSequenceFunction(sequence, builtInName, env,
callingExpression);
}
private TemplateModel getSequenceFunction(TemplateSequenceModel sequence,
String builtInName, Environment env,
BuiltInExpression callingExpression) throws TemplateException {
if (builtInName == "first") {
return sequence.size() > 0 ? sequence.get(0) : null;
}
if (builtInName == "last") {
return sequence.size() > 0 ? sequence.get(sequence.size() - 1)
: null;
}
if (builtInName == "reverse") {
return new ReverseSequence(sequence);
}
if (builtInName == "sort") {
return sort(sequence, null);
}
if (builtInName == "sort_by") {
return new SortByMethod(sequence);
}
if (builtInName == "chunk") {
return new ChunkFunction(sequence);
}
if (builtInName == "seq_contains") {
return new SequenceContainsFunction(sequence, env, callingExpression);
}
if (builtInName == "seq_index_of" || builtInName == "seq_last_index_of") {
return new SequenceIndexOf(sequence, env, callingExpression);
}
throw new InternalError("Cannot deal with built-in ?" + builtInName);
}
static class ReverseSequence implements TemplateSequenceModel {
private final TemplateSequenceModel seq;
ReverseSequence(TemplateSequenceModel seq) {
this.seq = seq;
}
public int size() throws TemplateModelException {
return seq.size();
}
public TemplateModel get(int index) throws TemplateModelException {
return seq.get(seq.size() - 1 - index);
}
}
static class ChunkFunction implements TemplateMethodModelEx {
private final TemplateSequenceModel tsm;
private ChunkFunction(TemplateSequenceModel tsm) {
this.tsm = tsm;
}
public Object exec(List args) throws TemplateModelException {
int numArgs = args.size();
if (numArgs != 1 && numArgs != 2) {
throw new TemplateModelException(
"?chunk(...) expects 1 or 2 arguments.");
}
Object chunkSize = args.get(0);
if (!(chunkSize instanceof TemplateNumberModel)) {
throw new TemplateModelException(
"?chunk(...) expects a number as "
+ "its 1st argument.");
}
return new ChunkedSequence(tsm, ((TemplateNumberModel) chunkSize)
.getAsNumber().intValue(),
numArgs > 1 ? (TemplateModel) args.get(1) : null);
}
}
static class ChunkedSequence implements TemplateSequenceModel {
private final TemplateSequenceModel wrappedTsm;
private final int chunkSize;
private final TemplateModel fillerItem;
private final int numberOfChunks;
private ChunkedSequence(TemplateSequenceModel wrappedTsm,
int chunkSize, TemplateModel fillerItem)
throws TemplateModelException {
if (chunkSize < 1) {
throw new TemplateModelException(
"The 1st argument to ?chunk(...) must be at least 1.");
}
this.wrappedTsm = wrappedTsm;
this.chunkSize = chunkSize;
this.fillerItem = fillerItem;
numberOfChunks = (wrappedTsm.size() + chunkSize - 1) / chunkSize;
}
public TemplateModel get(final int chunkIndex)
throws TemplateModelException {
if (chunkIndex >= numberOfChunks) {
return null;
}
return new TemplateSequenceModel() {
private final int baseIndex = chunkIndex * chunkSize;
public TemplateModel get(int relIndex)
throws TemplateModelException {
int absIndex = baseIndex + relIndex;
if (absIndex < wrappedTsm.size()) {
return wrappedTsm.get(absIndex);
} else {
return absIndex < numberOfChunks * chunkSize ? fillerItem
: null;
}
}
public int size() throws TemplateModelException {
return fillerItem != null
|| chunkIndex + 1 < numberOfChunks ? chunkSize
: wrappedTsm.size() - baseIndex;
}
};
}
public int size() throws TemplateModelException {
return numberOfChunks;
}
}
static TemplateSequenceModel sort(TemplateSequenceModel seq, String[] keys)
throws TemplateModelException {
int i;
int keyCnt;
int ln = seq.size();
if (ln == 0) {
return seq;
}
List<Object> res = new ArrayList<Object>(ln);
Object item;
item = seq.get(0);
if (keys != null) {
keyCnt = keys.length;
if (keyCnt == 0) {
keys = null;
} else {
for (i = 0; i < keyCnt; i++) {
if (!(item instanceof TemplateHashModel)) {
throw new TemplateModelException(
"sorting failed: "
+ (i == 0 ? "You can't use ?sort_by when the "
+ "sequence items are not hashes."
: "The subvariable "
+ StringUtil
.jQuote(keys[i - 1])
+ " is not a hash, so ?sort_by "
+ "can't proceed by getting the "
+ StringUtil
.jQuote(keys[i])
+ " subvariable."));
}
item = ((TemplateHashModel) item).get(keys[i]);
if (item == null) {
throw new TemplateModelException(
"sorting failed: "
+ "The "
+ StringUtil.jQuote(keys[i])
+ " subvariable "
+ (keyCnt == 1 ? "was not found."
: "(specified by ?sort_by argument number "
+ (i + 1)
+ ") was not found."));
}
}
}
} else {
keyCnt = 0;
}
int keyType;
if (item instanceof TemplateScalarModel) {
keyType = KEY_TYPE_STRING;
} else if (item instanceof TemplateNumberModel) {
keyType = KEY_TYPE_NUMBER;
} else if (item instanceof TemplateDateModel) {
keyType = KEY_TYPE_DATE;
} else {
throw new TemplateModelException(
"sorting failed: "
+ "Values used for sorting must be numbers, strings, or date/time values.");
}
if (keys == null) {
if (keyType == KEY_TYPE_STRING) {
for (i = 0; i < ln; i++) {
item = seq.get(i);
try {
res.add(new KVP(((TemplateScalarModel) item)
.getAsString(), item));
} catch (ClassCastException e) {
if (!(item instanceof TemplateScalarModel)) {
throw new TemplateModelException(
"Failure of ?sort built-in: "
+ "All values in the sequence must be "
+ "strings, because the first value "
+ "was a string. "
+ "The value at index " + i
+ " is not string.");
} else {
throw e;
}
}
}
} else if (keyType == KEY_TYPE_NUMBER) {
for (i = 0; i < ln; i++) {
item = seq.get(i);
try {
res.add(new KVP(((TemplateNumberModel) item)
.getAsNumber(), item));
} catch (ClassCastException e) {
if (!(item instanceof TemplateNumberModel)) {
throw new TemplateModelException(
"sorting failed: "
+ "All values in the sequence must be "
+ "numbers, because the first value "
+ "was a number. "
+ "The value at index " + i
+ " is not number.");
} else {
throw e;
}
}
}
} else if (keyType == KEY_TYPE_DATE) {
for (i = 0; i < ln; i++) {
item = seq.get(i);
try {
res.add(new KVP(((TemplateDateModel) item).getAsDate(),
item));
} catch (ClassCastException e) {
if (!(item instanceof TemplateNumberModel)) {
throw new TemplateModelException(
"sorting failed: "
+ "All values in the sequence must be "
+ "date/time values, because the first "
+ "value was a date/time. "
+ "The value at index " + i
+ " is not date/time.");
} else {
throw e;
}
}
}
} else {
throw new RuntimeException("FreeMarker bug: Bad key type");
}
} else {
for (i = 0; i < ln; i++) {
item = seq.get(i);
Object key = item;
for (int j = 0; j < keyCnt; j++) {
try {
key = ((TemplateHashModel) key).get(keys[j]);
} catch (ClassCastException e) {
if (!(key instanceof TemplateHashModel)) {
throw new TemplateModelException(
"sorting failed: "
+ "Problem with the sequence item at index "
+ i
+ ": "
+ "Can't get the "
+ StringUtil.jQuote(keys[j])
+ " subvariable, because the value is not a hash.");
} else {
throw e;
}
}
if (key == null) {
throw new TemplateModelException(
"sorting failed "
+ "Problem with the sequence item at index "
+ i + ": " + "The "
+ StringUtil.jQuote(keys[j])
+ " subvariable was not found.");
}
}
if (keyType == KEY_TYPE_STRING) {
try {
res.add(new KVP(((TemplateScalarModel) key)
.getAsString(), item));
} catch (ClassCastException e) {
if (!(key instanceof TemplateScalarModel)) {
throw new TemplateModelException(
"sorting failed: "
+ "All key values in the sequence must be "
+ "date/time values, because the first key "
+ "value was a date/time. The key value at "
+ "index " + i
+ " is not a date/time.");
} else {
throw e;
}
}
} else if (keyType == KEY_TYPE_NUMBER) {
try {
res.add(new KVP(((TemplateNumberModel) key)
.getAsNumber(), item));
} catch (ClassCastException e) {
if (!(key instanceof TemplateNumberModel)) {
throw new TemplateModelException(
"sorting failed: "
+ "All key values in the sequence must be "
+ "numbers, because the first key "
+ "value was a number. The key value at "
+ "index " + i
+ " is not a number.");
}
}
} else if (keyType == KEY_TYPE_DATE) {
try {
res.add(new KVP(((TemplateDateModel) key).getAsDate(),
item));
} catch (ClassCastException e) {
if (!(key instanceof TemplateDateModel)) {
throw new TemplateModelException(
"sorting failed: "
+ "All key values in the sequence must be "
+ "dates, because the first key "
+ "value was a date. The key value at "
+ "index " + i + " is not a date.");
}
}
} else {
throw new RuntimeException("FreeMarker bug: Bad key type");
}
}
}
Comparator cmprtr;
if (keyType == KEY_TYPE_STRING) {
cmprtr = new LexicalKVPComparator(Environment
.getCurrentEnvironment().getCollator());
} else if (keyType == KEY_TYPE_NUMBER) {
cmprtr = new NumericalKVPComparator(Environment
.getCurrentEnvironment().getArithmeticEngine());
} else if (keyType == KEY_TYPE_DATE) {
cmprtr = DateKVPComparator.INSTANCE;
} else {
throw new RuntimeException("FreeMarker bug: Bad key type");
}
try {
Collections.sort(res, cmprtr);
} catch (ClassCastException exc) {
throw new TemplateModelException("Unexpected error while sorting:" + exc, exc);
}
for (i = 0; i < ln; i++) {
res.set(i, ((KVP) res.get(i)).value);
}
return new TemplateModelListSequence(res);
}
static class KVP {
private KVP(Object key, Object value) {
this.key = key;
this.value = value;
}
private Object key;
private Object value;
}
static class NumericalKVPComparator implements Comparator {
private ArithmeticEngine ae;
private NumericalKVPComparator(ArithmeticEngine ae) {
this.ae = ae;
}
public int compare(Object arg0, Object arg1) {
try {
return ae.compareNumbers(
(Number) ((KVP) arg0).key,
(Number) ((KVP) arg1).key);
} catch (TemplateException e) {
throw new ClassCastException(
"Failed to compare numbers: " + e);
}
}
}
static class LexicalKVPComparator implements Comparator {
private Collator collator;
LexicalKVPComparator(Collator collator) {
this.collator = collator;
}
public int compare(Object arg0, Object arg1) {
return collator.compare(
((KVP) arg0).key, ((KVP) arg1).key);
}
}
static class DateKVPComparator implements Comparator {
static final DateKVPComparator INSTANCE = new DateKVPComparator();
public int compare(Object arg0, Object arg1) {
return ((Date) ((KVP) arg0).key).compareTo(
(Date) ((KVP) arg1).key);
}
}
static class SortByMethod implements TemplateMethodModelEx {
TemplateSequenceModel seq;
SortByMethod(TemplateSequenceModel seq) {
this.seq = seq;
}
public Object exec(List params)
throws TemplateModelException {
if (params.size() == 0) {
throw new TemplateModelException(
"?sort_by(key) needs exactly 1 argument.");
}
String[] subvars;
Object obj = params.get(0);
if (obj instanceof TemplateScalarModel) {
subvars = new String[]{((TemplateScalarModel) obj).getAsString()};
} else if (obj instanceof TemplateSequenceModel) {
TemplateSequenceModel seq = (TemplateSequenceModel) obj;
int ln = seq.size();
subvars = new String[ln];
for (int i = 0; i < ln; i++) {
Object item = seq.get(i);
try {
subvars[i] = ((TemplateScalarModel) item)
.getAsString();
} catch (ClassCastException e) {
if (!(item instanceof TemplateScalarModel)) {
throw new TemplateModelException(
"The argument to ?sort_by(key), when it "
+ "is a sequence, must be a sequence of "
+ "strings, but the item at index " + i
+ " is not a string." );
}
}
}
} else {
throw new TemplateModelException(
"The argument to ?sort_by(key) must be a string "
+ "(the name of the subvariable), or a sequence of "
+ "strings (the \"path\" to the subvariable).");
}
return sort(seq, subvars);
}
}
/*
* WARNING! This algorithm is duplication of ComparisonExpression.isTrue(...).
* Thus, if you update this method, then you have to update that too!
*/
public static boolean modelsEqual(TemplateModel model1, TemplateModel model2,
Environment env, Template template)
throws TemplateModelException {
int comp = -1;
if(model1 instanceof TemplateNumberModel && model2 instanceof TemplateNumberModel) {
Number first = ((TemplateNumberModel) model1).getAsNumber();
Number second = ((TemplateNumberModel) model2).getAsNumber();
ArithmeticEngine ae =
env != null
? env.getArithmeticEngine()
: template.getArithmeticEngine();
try {
comp = ae.compareNumbers(first, second);
} catch (TemplateException ex) {
throw new TemplateModelException(ex);
}
}
else if(model1 instanceof TemplateDateModel && model2 instanceof TemplateDateModel) {
TemplateDateModel ltdm = (TemplateDateModel)model1;
TemplateDateModel rtdm = (TemplateDateModel)model2;
int ltype = ltdm.getDateType();
int rtype = rtdm.getDateType();
if(ltype != rtype) {
throw new TemplateModelException(
"Can not compare dates of different type. Left date is of "
+ TemplateDateModel.TYPE_NAMES.get(ltype)
+ " type, right date is of "
+ TemplateDateModel.TYPE_NAMES.get(rtype) + " type.");
}
if(ltype == TemplateDateModel.UNKNOWN) {
throw new TemplateModelException(
"Left date is of UNKNOWN type, and can not be compared.");
}
if(rtype == TemplateDateModel.UNKNOWN) {
throw new TemplateModelException(
"Right date is of UNKNOWN type, and can not be compared.");
}
Date first = ltdm.getAsDate();
Date second = rtdm.getAsDate();
comp = first.compareTo(second);
}
else if(model1 instanceof TemplateScalarModel && model2 instanceof TemplateScalarModel) {
String first = ((TemplateScalarModel) model1).getAsString();
String second = ((TemplateScalarModel) model2).getAsString();
Collator collator;
if(env == null) {
collator = Collator.getInstance(template.getLocale());
} else {
collator = env.getCollator();
}
comp = collator.compare(first, second);
}
else if(model1 instanceof TemplateBooleanModel && model2 instanceof TemplateBooleanModel) {
boolean first = ((TemplateBooleanModel)model1).getAsBoolean();
boolean second = ((TemplateBooleanModel)model2).getAsBoolean();
comp = (first ? 1 : 0) - (second ? 1 : 0);
}
return (comp == 0);
}
static class SequenceContainsFunction implements TemplateMethodModelEx {
TemplateSequenceModel sequence;
TemplateCollectionModel collection;
Environment env;
BuiltInExpression callingExpression;
SequenceContainsFunction(TemplateModel seqModel, Environment env, BuiltInExpression callingExpression) {
this.env = env;
this.callingExpression = callingExpression;
if (seqModel instanceof TemplateSequenceModel) {
sequence = (TemplateSequenceModel) seqModel;
}
else if (seqModel instanceof TemplateCollectionModel) {
collection = (TemplateCollectionModel) seqModel;
}
}
public TemplateModel exec(List args) throws TemplateModelException {
if (args.size() != 1) {
throw new TemplateModelException("Expecting exactly one argument for ?seq_contains(...)");
}
TemplateModel compareToThis = (TemplateModel) args.get(0);
if (collection != null) {
TemplateModelIterator tmi = collection.iterator();
while (tmi.hasNext()) {
if (modelsEqual(tmi.next(), compareToThis, env, callingExpression.getTemplate())) {
return TemplateBooleanModel.TRUE;
}
}
return TemplateBooleanModel.FALSE;
}
else {
for (int i=0; i<sequence.size(); i++) {
if (modelsEqual(sequence.get(i), compareToThis, env, callingExpression.getTemplate())) {
return TemplateBooleanModel.TRUE;
}
}
return TemplateBooleanModel.FALSE;
}
}
}
static class SequenceIndexOf implements TemplateMethodModelEx {
TemplateSequenceModel sequence;
BuiltInExpression callingExpression;
Environment env;
SequenceIndexOf(TemplateSequenceModel sequence, Environment env, BuiltInExpression callingExpression) {
this.sequence = sequence;
this.env = env;
this.callingExpression = callingExpression;
}
public TemplateModel exec(List args) throws TemplateModelException {
int argc = args.size();
int startIndex = 0;
if (argc != 1 && argc != 2) {
throw new TemplateModelException("Expecting one or two arguments for ?" + callingExpression.getName());
}
TemplateModel compareToThis = (TemplateModel) args.get(0);
if (argc == 2) {
try {
startIndex = ((TemplateNumberModel)args.get(1)).getAsNumber().intValue();
} catch (ClassCastException cce) {
throw new TemplateModelException("Expecting number as second argument to ?" + callingExpression.getName());
}
}
boolean reverse = callingExpression.getName() == "seq_last_index_of";
if (reverse) {
sequence = new ReverseSequence(sequence);
if (argc == 2) {
startIndex = sequence.size() - 1 - startIndex;
}
}
for (int i=startIndex; i<sequence.size(); i++) {
if (modelsEqual(sequence.get(i), compareToThis, env, callingExpression.getTemplate())) {
int result = reverse ? sequence.size() - i -1 : i;
return new SimpleNumber(result);
}
}
return new SimpleNumber(-1);
}
}
}
The table below shows all metrics for SequenceFunctions.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 141.00 | Number of blocks | |
| BLOCK_COMMENT | 55.00 | Number of block comment lines | |
| COMMENTS | 59.00 | Comment lines | |
| COMMENT_DENSITY | 0.12 | Comment density | |
| COMPARISONS | 85.00 | Number of comparison operators | |
| CYCLOMATIC | 133.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 3.00 | Comments in declarations | |
| DOC_COMMENT | 3.00 | Number of javadoc comment lines | |
| ELOC | 473.00 | Effective lines of code | |
| EXEC_COMMENTS | 1.00 | Comments in executable code | |
| EXITS | 35.00 | Procedure exits | |
| FUNCTIONS | 26.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 87.01 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 170.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 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 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 | 12.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 11.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 2.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 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1996.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 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 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 | 7.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 1.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 | 712.00 | Number of lines in the source file | |
| LINE_COMMENT | 1.00 | Number of line comments | |
| LOC | 589.00 | Lines of code | |
| LOGICAL_LINES | 217.00 | Number of statements | |
| LOOPS | 11.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 1140.00 | Number of operands | |
| OPERATORS | 2244.00 | Number of operators | |
| PARAMS | 43.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3384.00 | Halstead program length | |
| PROGRAM_VOCAB | 370.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 127.00 | Number of return points from functions | |
| SIZE | 24454.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 321.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 49.00 | Number of unique operators | |
| WHITESPACE | 64.00 | Number of whitespace lines | |