IndexTreeBuilder.java
| Index Score | ||
|---|---|---|
 |
 |
com.espertech.esper.filter |
 |
 |
Esper |
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 | |
|---|---|---|
| EXEC_COMMENTS | Comments in executable code |  |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LINE_COMMENT | Number of line comments | |
| EXITS | Procedure exits | |
| SIZE | Size of the file in bytes | |
| JAVA0075 | JAVA0075 Method parameter hides field | |
| LOGICAL_LINES | Number of statements | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| OPERATORS | Number of operators | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERANDS | Number of operands | |
| JAVA0065 | JAVA0065 Unnecessary final modifier for method in final class | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| LOC | Lines of code | |
| LOOPS | Number of loops | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0009 | JAVA0009 Protected member in final class | |
| FUNCTIONS | Number of function declarations | |
| ELOC | Effective lines of code | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/**************************************************************************************
* Copyright (C) 2006 Esper Team. All rights reserved. *
* http://esper.codehaus.org *
* ---------------------------------------------------------------------------------- *
* The software in this package is published under the terms of the GPL license *
* a copy of which has been included with this distribution in the license.txt file. *
**************************************************************************************/
package com.espertech.esper.filter;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.List;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import com.espertech.esper.collection.Pair;
import com.espertech.esper.event.EventType;
import com.espertech.esper.util.ExecutionPathDebugLog;
/**
* Builder manipulates a tree structure consisting of {@link FilterHandleSetNode} and {@link FilterParamIndexBase} instances.
* Filters can be added to a top node (an instance of FilterHandleSetNode) via the add method. This method returns
* an instance of {@link IndexTreePath} which represents the tree path (list of indizes) that the filter callback was
* added to. To remove filters the same IndexTreePath instance must be passed in.
* <p>The implementation is designed to be multithread-safe in conjunction with the node classes manipulated by this class.
*/
public final class IndexTreeBuilder
{
private EventType eventType;
private SortedSet<FilterValueSetParam> remainingParameters;
private FilterHandle filterCallback;
private long currentThreadId;
/**
* Constructor.
*/
public IndexTreeBuilder()
{
}
/**
* Add a filter callback according to the filter specification to the top node returning
* information to be used to remove the filter callback.
* @param filterValueSet is the filter definition
* @param filterCallback is the callback to be added
* @param topNode node to be added to any subnode beneath it
* @return an encapsulation of information need to allow for safe removal of the filter tree.
*/
public final IndexTreePath add( FilterValueSet filterValueSet,
FilterHandle filterCallback,
FilterHandleSetNode topNode)
{
this.eventType = filterValueSet.getEventType();
this.remainingParameters = copySortParameters(filterValueSet.getParameters());
this.filterCallback = filterCallback;
this.currentThreadId = Thread.currentThread().getId();
if ((ExecutionPathDebugLog.isDebugEnabled) && (log.isDebugEnabled()))
{
log.debug(".add (" + currentThreadId + ") Adding filter callback, " +
" topNode=" + topNode +
" filterCallback=" + this.filterCallback);
}
IndexTreePath treePathInfo = new IndexTreePath();
addToNode(topNode, treePathInfo);
this.remainingParameters = null;
this.filterCallback = null;
return treePathInfo;
}
/**
* Remove an filterCallback from the given top node. The IndexTreePath instance passed in must be the
* same as obtained when the same filterCallback was added.
* @param filterCallback filter callback to be removed
* @param treePathInfo encapsulates information need to allow for safe removal of the filterCallback
* @param topNode The top tree node beneath which the filterCallback was added
*/
public final void remove(
FilterHandle filterCallback,
IndexTreePath treePathInfo,
FilterHandleSetNode topNode)
{
this.remainingParameters = null;
this.filterCallback = filterCallback;
this.currentThreadId = Thread.currentThread().getId();
if ((ExecutionPathDebugLog.isDebugEnabled) && (log.isDebugEnabled()))
{
log.debug(".remove (" + currentThreadId + ") Removing filterCallback " +
" from treepath=" + treePathInfo.toString() +
" topNode=" + topNode +
" filterCallback=" + filterCallback);
}
removeFromNode(topNode, treePathInfo);
this.filterCallback = null;
}
/**
* Add to the current node building up the tree path information.
* @param currentNode is the node to add to
* @param treePathInfo is filled with information about which indizes were chosen to add the filter to
*/
private void addToNode(FilterHandleSetNode currentNode, IndexTreePath treePathInfo)
{
if ((ExecutionPathDebugLog.isDebugEnabled) && (log.isDebugEnabled()))
{
log.debug(".addToNode (" + currentThreadId + ") Adding filterCallback, node=" + currentNode +
" remainingParameters=" + printRemainingParameters());
}
// If no parameters are specified, add to current node, and done
if (remainingParameters.isEmpty())
{
currentNode.getNodeRWLock().writeLock().lock();
currentNode.add(filterCallback);
currentNode.getNodeRWLock().writeLock().unlock();
return;
}
// Need to find an existing index that matches one of the filter parameters
currentNode.getNodeRWLock().readLock().lock();
Pair<FilterValueSetParam, FilterParamIndexBase> pair = IndexHelper.findIndex(remainingParameters, currentNode.getIndizes());
// Found an index matching a filter parameter
if (pair != null)
{
remainingParameters.remove(pair.getFirst());
Object filterForValue = pair.getFirst().getFilterForValue();
FilterParamIndexBase index = pair.getSecond();
treePathInfo.add(index, filterForValue);
addToIndex(index, filterForValue, treePathInfo);
currentNode.getNodeRWLock().readLock().unlock();
return;
}
currentNode.getNodeRWLock().readLock().unlock();
// An index for any of the filter parameters was not found, create one
currentNode.getNodeRWLock().writeLock().lock();
pair = IndexHelper.findIndex(remainingParameters, currentNode.getIndizes());
// Attempt to find an index again this time under a write lock
if (pair != null)
{
remainingParameters.remove(pair.getFirst());
Object filterForValue = pair.getFirst().getFilterForValue();
FilterParamIndexBase index = pair.getSecond();
treePathInfo.add(index, filterForValue);
addToIndex(index, filterForValue, treePathInfo);
currentNode.getNodeRWLock().writeLock().unlock();
return;
}
// No index found that matches any parameters, create a new one
// Pick the next parameter for an index
FilterValueSetParam parameterPickedForIndex = remainingParameters.first();
remainingParameters.remove(parameterPickedForIndex);
FilterParamIndexBase index = IndexFactory.createIndex(eventType, parameterPickedForIndex.getPropertyName(),
parameterPickedForIndex.getFilterOperator());
currentNode.getIndizes().add(index);
treePathInfo.add(index, parameterPickedForIndex.getFilterForValue());
addToIndex(index, parameterPickedForIndex.getFilterForValue(), treePathInfo);
currentNode.getNodeRWLock().writeLock().unlock();
}
// Remove an filterCallback from the current node, return true if the node is the node is empty now
private boolean removeFromNode(FilterHandleSetNode currentNode,
IndexTreePath treePathInfo)
{
Pair<FilterParamIndexBase, Object> nextPair = treePathInfo.removeFirst();
// No remaining filter parameters
if (nextPair == null)
{
currentNode.getNodeRWLock().writeLock().lock();
boolean isRemoved = currentNode.remove(filterCallback);
boolean isEmpty = currentNode.isEmpty();
if (!isRemoved)
{
log.warn(".removeFromNode (" + currentThreadId + ") Could not find the filterCallback to be removed within the supplied node , node=" +
currentNode + " filterCallback=" + filterCallback);
}
currentNode.getNodeRWLock().writeLock().unlock();
return isEmpty;
}
// Remove from index
FilterParamIndexBase nextIndex = nextPair.getFirst();
Object filteredForValue = nextPair.getSecond();
currentNode.getNodeRWLock().writeLock().lock();
boolean isEmpty = removeFromIndex(nextIndex, treePathInfo, filteredForValue);
if (!isEmpty)
{
currentNode.getNodeRWLock().writeLock().unlock();
return false;
}
// Remove the index if the index is now empty
if (nextIndex.size() == 0)
{
boolean isRemoved = currentNode.remove(nextIndex);
if (!isRemoved)
{
log.warn(".removeFromNode (" + currentThreadId + ") Could not find the index in index list for removal, index=" +
nextIndex.toString() + " filterCallback=" + filterCallback);
currentNode.getNodeRWLock().writeLock().unlock();
return false;
}
}
boolean isEmptyNode = currentNode.isEmpty();
currentNode.getNodeRWLock().writeLock().unlock();
return isEmptyNode;
}
// Remove filterCallback from index, returning true if index empty after removal
private boolean removeFromIndex(FilterParamIndexBase index,
IndexTreePath treePathInfo,
Object filterForValue)
{
index.getReadWriteLock().writeLock().lock();
EventEvaluator eventEvaluator = index.get(filterForValue);
if (eventEvaluator == null)
{
log.warn(".removeFromIndex (" + currentThreadId + ") Could not find the filterCallback value in index, index=" +
index.toString() + " value=" + filterForValue.toString() + " filterCallback=" + filterCallback);
index.getReadWriteLock().writeLock().unlock();
return false;
}
if (eventEvaluator instanceof FilterHandleSetNode)
{
FilterHandleSetNode node = (FilterHandleSetNode) eventEvaluator;
boolean isEmpty = removeFromNode(node, treePathInfo);
if (isEmpty)
{
// Since we are holding a write lock to this index, there should not be a chance that
// another thread had been adding anything to this FilterHandleSetNode
index.remove(filterForValue);
}
int size = index.size();
index.getReadWriteLock().writeLock().unlock();
return (size == 0);
}
FilterParamIndexBase nextIndex = (FilterParamIndexBase) eventEvaluator;
Pair<FilterParamIndexBase, Object> nextPair = treePathInfo.removeFirst();
if (nextPair == null)
{
log.fatal(".removeFromIndex Expected an inner index to this index, this=" + this.toString());
index.getReadWriteLock().writeLock().unlock();
assert false;
return false;
}
if (nextPair.getFirst() != nextIndex)
{
log.fatal(".removeFromIndex Expected an index for filterCallback that differs from the found index, this=" + this.toString() +
" expected=" + nextPair.getFirst());
index.getReadWriteLock().writeLock().unlock();
assert false;
return false;
}
Object nextExpressionValue = nextPair.getSecond();
boolean isEmpty = removeFromIndex(nextPair.getFirst(), treePathInfo, nextExpressionValue);
if (isEmpty)
{
// Since we are holding a write lock to this index, there should not be a chance that
// another thread had been adding anything to this FilterHandleSetNode
index.remove(filterForValue);
}
int size = index.size();
index.getReadWriteLock().writeLock().unlock();
return (size == 0);
}
/**
* Add to an index the value to filter for.
* @param index is the index to add to
* @param filterForValue is the filter parameter value to add
* @param treePathInfo is the specification to fill on where is was added
*/
private void addToIndex(FilterParamIndexBase index,
Object filterForValue,
IndexTreePath treePathInfo)
{
if ((ExecutionPathDebugLog.isDebugEnabled) && (log.isDebugEnabled()))
{
log.debug(".addToIndex (" + currentThreadId + ") Adding to index " +
index.toString() +
" expressionValue=" + filterForValue);
}
index.getReadWriteLock().readLock().lock();
EventEvaluator eventEvaluator = index.get(filterForValue);
// The filter parameter value already existed in bean, add and release locks
if (eventEvaluator != null)
{
boolean added = addToEvaluator(eventEvaluator, treePathInfo);
if (added)
{
index.getReadWriteLock().readLock().unlock();
return;
}
}
index.getReadWriteLock().readLock().unlock();
// new filter parameter value, need a write lock
index.getReadWriteLock().writeLock().lock();
eventEvaluator = index.get(filterForValue);
// It may exist now since another thread could have added the entry
if (eventEvaluator != null)
{
boolean added = addToEvaluator(eventEvaluator, treePathInfo);
if (added)
{
index.getReadWriteLock().writeLock().unlock();
return;
}
// The found eventEvaluator must be converted to a new FilterHandleSetNode
FilterParamIndexBase nextIndex = (FilterParamIndexBase) eventEvaluator;
FilterHandleSetNode newNode = new FilterHandleSetNode();
newNode.add(nextIndex);
index.put(filterForValue, newNode);
addToNode(newNode, treePathInfo);
index.getReadWriteLock().writeLock().unlock();
return;
}
// The index does not currently have this filterCallback value,
// if there are no remaining parameters, create a node
if (remainingParameters.isEmpty())
{
FilterHandleSetNode node = new FilterHandleSetNode();
addToNode(node, treePathInfo);
index.put(filterForValue, node);
index.getReadWriteLock().writeLock().unlock();
return;
}
// If there are remaining parameters, create a new index for the next parameter
FilterValueSetParam parameterPickedForIndex = remainingParameters.first();
remainingParameters.remove(parameterPickedForIndex);
FilterParamIndexBase nextIndex = IndexFactory.createIndex(eventType, parameterPickedForIndex.getPropertyName(),
parameterPickedForIndex.getFilterOperator());
index.put(filterForValue, nextIndex);
treePathInfo.add(nextIndex, parameterPickedForIndex.getFilterForValue());
addToIndex(nextIndex, parameterPickedForIndex.getFilterForValue(), treePathInfo);
index.getReadWriteLock().writeLock().unlock();
}
/**
* Add filter callback to an event evaluator, which could be either an index node or a set node.
* @param eventEvaluator to add the filterCallback to.
* @param treePathInfo is for holding the information on where the add occured
* @return boolean indicating if the eventEvaluator was successfully added
*/
private boolean addToEvaluator(EventEvaluator eventEvaluator, IndexTreePath treePathInfo)
{
if (eventEvaluator instanceof FilterHandleSetNode)
{
FilterHandleSetNode node = (FilterHandleSetNode) eventEvaluator;
addToNode(node, treePathInfo);
return true;
}
// Check if the next index matches any of the remaining filterCallback parameters
FilterParamIndexBase nextIndex = (FilterParamIndexBase) eventEvaluator;
FilterValueSetParam parameter = IndexHelper.findParameter(remainingParameters, nextIndex);
if (parameter != null)
{
remainingParameters.remove(parameter);
treePathInfo.add(nextIndex, parameter.getFilterForValue());
addToIndex(nextIndex, parameter.getFilterForValue(), treePathInfo);
return true;
}
// This eventEvaluator does not work with any of the remaining filter parameters
return false;
}
/**
* Copy the parameter list - this also sorts the parameter list.
* @param parameters is a list of filter parameters
* @return sorted set of filter parameters
*/
protected static SortedSet<FilterValueSetParam> copySortParameters(List<FilterValueSetParam> parameters)
{
SortedSet<FilterValueSetParam> copy = new TreeSet<FilterValueSetParam>(new FilterValueSetParamComparator());
for (FilterValueSetParam parameter : parameters)
{
copy.add(parameter);
}
if (copy.size() != parameters.size())
{
throw new IllegalArgumentException("Filter parameters not unique by property name and filter operator");
}
return copy;
}
private String printRemainingParameters()
{
StringBuilder buffer = new StringBuilder();
int count = 0;
for (FilterValueSetParam parameter : remainingParameters)
{
buffer.append(" param(").append(count).append(')');
buffer.append(" property=").append(parameter.getPropertyName());
buffer.append(" operator=").append(parameter.getFilterOperator());
buffer.append(" value=").append(parameter.getFilterForValue());
count++;
}
return buffer.toString();
}
private static final Log log = LogFactory.getLog(IndexTreeBuilder.class);
}
The table below shows all metrics for IndexTreeBuilder.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 38.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 79.00 | Comment lines | |
| COMMENT_DENSITY | 0.35 | Comment density | |
| COMPARISONS | 28.00 | Number of comparison operators | |
| CYCLOMATIC | 40.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 11.00 | Comments in declarations | |
| DOC_COMMENT | 54.00 | Number of javadoc comment lines | |
| ELOC | 224.00 | Effective lines of code | |
| EXEC_COMMENTS | 19.00 | Comments in executable code | |
| EXITS | 60.00 | Procedure exits | |
| FUNCTIONS | 10.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 70.95 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 47.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.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 | 1.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 | 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 | 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 | 1.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 | 2.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 2.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 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 | 0.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 | 2.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.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 | 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 | 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 | 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 | 456.00 | Number of lines in the source file | |
| LINE_COMMENT | 25.00 | Number of line comments | |
| LOC | 302.00 | Lines of code | |
| LOGICAL_LINES | 161.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 3.00 | Maximum nesting depth | |
| OPERANDS | 706.00 | Number of operands | |
| OPERATORS | 1353.00 | Number of operators | |
| PARAMS | 19.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2059.00 | Halstead program length | |
| PROGRAM_VOCAB | 239.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 28.00 | Number of return points from functions | |
| SIZE | 19035.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 199.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 40.00 | Number of unique operators | |
| WHITESPACE | 75.00 | Number of whitespace lines | |