Index.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.slide.index.lucene |
 |
 |
Jakarta Slide |
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 | |
|---|---|---|
| EXITS | Procedure exits |  |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| OPERANDS | Number of operands | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LOOPS | Number of loops | |
| EXEC_COMMENTS | Comments in executable code | |
| ELOC | Effective lines of code | |
| BLOCKS | Number of blocks | |
| LOGICAL_LINES | Number of statements | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LOC | Lines of code | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0123 | JAVA0123 Use all three components of for loop | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0143 | JAVA0143 Synchronized method | |
| CYCLOMATIC | Cyclomatic complexity | |
| PARAMS | Number of formal parameter declarations | |
| SIZE | Size of the file in bytes | |
| LINES | Number of lines in the source file | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| LINE_COMMENT | Number of line comments | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| FUNCTIONS | Number of function declarations | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| UNIQUE_OPERATORS | Number of unique operators | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0160 | JAVA0160 Method does not throw specified exception | |
| RETURNS | Number of return points from functions | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| COMPARISONS | Number of comparison operators | |
| JAVA0256 | JAVA0256 Assignment of external collection/array to field | |
| DOC_COMMENT | Number of javadoc comment lines | |
/*
* $Header$
* $Revision: 527546 $
* $Date: 2007-04-11 11:59:18 -0400 (Wed, 11 Apr 2007) $
*
* ====================================================================
*
* Copyright 1999-2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.slide.index.lucene;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.text.DecimalFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Locale;
import java.util.Set;
import java.util.StringTokenizer;
import org.apache.lucene.document.Document;
import org.apache.lucene.document.Field;
import org.apache.lucene.document.Field.Store;
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.index.IndexWriter;
import org.apache.lucene.index.Term;
import org.apache.lucene.search.BooleanQuery;
import org.apache.lucene.search.IndexSearcher;
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.FSDirectory;
import org.apache.slide.common.PropertyName;
import org.apache.slide.common.Uri;
import org.apache.slide.content.NodeProperty;
import org.apache.slide.content.NodeRevisionDescriptor;
import org.apache.slide.content.NodeRevisionNumber;
import org.apache.slide.extractor.ContentExtractor;
import org.apache.slide.extractor.ExtractorException;
import org.apache.slide.extractor.ExtractorManager;
import org.apache.slide.search.IndexException;
import org.apache.slide.util.logger.Logger;
/**
* Wrapper for Lucene index.
*/
public class Index {
public static final String KEY_FIELD_NAME = "SLIDE_KEY";
public static final String URI_FIELD_NAME = "SLIDE_URI";
public static final String REVISION_FIELD_NAME = "SLIDE_REVISION";
public static final String SCOPE_FIELD_NAME = "SLIDE_SCOPE";
public static final String DEPTH_FIELD_NAME = "SLIDE_DEPTH";
public static final String VERSION_FIELD_NAME = "SLIDE_VERSION";
public static final String IS_DEFINED_FIELD_NAME = "SLIDE_ISDEFINED";
public static final String CONTENT_FIELD_NAME = "SLIDE_CONTENT";
public static final String NULL_FIELD_NAME = "SLIDE_NULL";
protected static final SimpleDateFormat DATE_INDEX_FORMAT = new SimpleDateFormat(
"yyyy-MM-dd HH:mm", Locale.UK);
protected static final DecimalFormat INT_INDEX_FORMAT = new DecimalFormat(
"b0000000000000000000;a0000000000000000000");
public static final String DATE_LOWER_BOUND = DATE_INDEX_FORMAT
.format(new Date(0));
public static final String DATE_UPPER_BOUND = DATE_INDEX_FORMAT
.format(new Date(Long.MAX_VALUE));
public static final String INT_LOWER_BOUND = INT_INDEX_FORMAT
.format(Long.MIN_VALUE);
public static final String INT_UPPER_BOUND = INT_INDEX_FORMAT
.format(Long.MAX_VALUE);
public static final String STRING_UPPER_BOUND = "\uffff\uffff";
public static final String STRING_LOWER_BOUND = "";
protected static final String LOG_CHANNEL = Index.class.getName();
protected IndexConfiguration configuration;
protected JobRunner indexThread;
protected String indexName;
protected Logger logger;
protected LinkedList txnQueue = new LinkedList();
/**
* Counter for recently executed index jobs (insertions, deletions). Will be
* reseted after optimization.
*/
private int jobCounter = 0;
private boolean needsInitialization = false;
public Index(IndexConfiguration configuration, Logger logger, String name)
throws IndexException {
this.logger = logger;
this.configuration = configuration;
this.indexName = name;
File file = new File(this.configuration.getIndexPath());
if (!file.exists() && !file.mkdirs()) {
throw new IndexException(
"Error can't find or create index directory: "
+ this.configuration.getIndexPath());
}
try {
Directory directory = getDirectory();
if (IndexReader.indexExists(directory)) {
if (IndexReader.isLocked(directory)) {
IndexReader.unlock(directory);
}
} else {
this.needsInitialization = true;
IndexWriter writer = new IndexWriter(directory, configuration
.getAnalyzer(), true);
writer.close();
}
} catch (IOException e) {
throw new IndexException("Error while creating index: "
+ this.configuration.getIndexPath(), e);
}
// TODO make configurable
BooleanQuery.setMaxClauseCount(10000);
}
public IndexConfiguration getConfiguration() {
return this.configuration;
}
public Logger getLogger() {
return this.logger;
}
public boolean needsInitialization() {
return this.needsInitialization;
}
public void start() {
if (configuration.indexAsynchron) {
if (this.indexThread != null) {
// this really should be WARNING, but this can get called so
// many times
/* getLogger().log(
"Indexing thread has already been started! Not starting a new one!",
Logger.WARNING);
*/
} else {
this.indexThread = new JobRunner();
this.indexThread.setName("Indexing Thread (" + this.indexName + ")");
this.indexThread.setPriority(configuration.getPriority());
this.indexThread.start();
}
}
}
public void stop() {
if (this.indexThread != null) {
// stop the indexing thread
try {
this.indexThread.interrupt();
synchronized (this.txnQueue) {
this.txnQueue.notify();
}
this.indexThread.join();
} catch (InterruptedException e) {
//
}
// execute remaining indexing jobs
try {
for (Iterator i = this.txnQueue.iterator(); i.hasNext();) {
IndexTransaction txn = (IndexTransaction) i.next();
executeIndexTransaction(txn);
}
} catch (IndexException e) {
logger.log("Error while executing job", e, LOG_CHANNEL,
Logger.ERROR);
}
}
}
public IndexSearcher getSearcher() throws IOException {
// TODO can this be reused?
return new IndexSearcher(this.configuration.getIndexPath());
}
private Directory getDirectory() throws IOException {
// file system based directory
return FSDirectory.getDirectory(this.configuration.getIndexPath(),
false);
}
private Field unstoredString(String fieldName, String value) {
return new Field(fieldName, value, Store.NO, org.apache.lucene.document.Field.Index.UN_TOKENIZED);
}
private Field storedString(String fieldName, String value) {
return new Field(fieldName, value, Store.YES, org.apache.lucene.document.Field.Index.UN_TOKENIZED);
}
private Field textField(String fieldName, String value) {
return new Field(fieldName, value, Store.NO, org.apache.lucene.document.Field.Index.TOKENIZED);
}
private Field textField(String fieldName, Reader value) {
return new Field(fieldName, value);
}
/**
* Creates a lucene index document for a properties indexer.
*
* @param uri
* resource
* @param descriptor
* properties to be indexed
*/
private Document createLuceneDocument(String uri,
NodeRevisionDescriptor descriptor) {
Document doc = new Document();
doc.add(unstoredString(Index.KEY_FIELD_NAME, configuration.generateKey(
uri, descriptor.getRevisionNumber())));
doc.add(storedString(Index.URI_FIELD_NAME, uri));
doc.add(storedString(Index.REVISION_FIELD_NAME, descriptor
.getRevisionNumber().toString()));
// scopes
StringTokenizer tokenizer = new StringTokenizer(uri, "/");
StringBuffer buffer = new StringBuffer(uri.length());
doc.add(unstoredString(Index.SCOPE_FIELD_NAME, "/"));
int depth = 0;
for (; tokenizer.hasMoreTokens();) {
buffer.append("/").append(tokenizer.nextToken());
doc.add(unstoredString(Index.SCOPE_FIELD_NAME, buffer.toString()));
depth++;
}
doc.add(unstoredString(Index.DEPTH_FIELD_NAME, configuration
.intToIndexString(depth)));
// resource type
String rtype = descriptor.getResourceType();
for (Iterator i = configuration.knownResourceTypes(); i.hasNext();) {
String name = (String) i.next();
if (rtype.indexOf(name) != -1) {
doc.add(unstoredString(configuration.generateFieldName(
NodeProperty.DEFAULT_NAMESPACE, "resourcetype"), name));
}
}
// all other properties
for (Enumeration e = descriptor.enumerateProperties(); e
.hasMoreElements();) {
NodeProperty property = (NodeProperty) e.nextElement();
PropertyName propertyName = property.getPropertyName();
Object value = property.getValue();
if (value == null)
continue;
if (!configuration.isIndexedProperty(propertyName))
continue;
if (configuration.isStringProperty(propertyName)) {
doc
.add(unstoredString(configuration.generateFieldName(
property.getNamespace(), property.getName()),
value.toString()));
}
if (configuration.isDateProperty(propertyName)) {
Date date = IndexConfiguration.getDateValue(value);
if (date != null) {
doc.add(unstoredString(configuration.generateFieldName(
property.getNamespace(), property.getName()),
configuration.dateToIndexString(date)));
}
}
if (configuration.isIntProperty(propertyName)) {
try {
doc.add(unstoredString(configuration.generateFieldName(
property.getNamespace(), property.getName()),
configuration.intToIndexString(Long.parseLong(value
.toString()))));
} catch (NumberFormatException ex) {
// TODO log warning
}
}
if (configuration.isTextProperty(propertyName)) {
doc
.add(textField(configuration.generateFieldName(property
.getNamespace(), property.getName()), value
.toString()));
}
if (configuration.supportsIsDefined(propertyName)) {
doc.add(unstoredString(Index.IS_DEFINED_FIELD_NAME,
configuration.generateFieldName(
property.getNamespace(), property.getName())));
}
}
return doc;
}
/**
* Creates a lucene document for content indexing.
*/
private Document createLuceneDocument(String uri,
NodeRevisionDescriptor descriptor, InputStream content)
throws IndexException, ExtractorException {
Document doc = new Document();
doc.add(unstoredString(Index.KEY_FIELD_NAME, configuration.generateKey(
uri, descriptor.getRevisionNumber())));
doc.add(storedString(Index.URI_FIELD_NAME, uri));
doc.add(storedString(Index.REVISION_FIELD_NAME, descriptor
.getRevisionNumber().toString()));
// scopes
StringTokenizer tokenizer = new StringTokenizer(uri, "/");
StringBuffer buffer = new StringBuffer(uri.length());
doc.add(unstoredString(Index.SCOPE_FIELD_NAME, "/"));
int depth = 0;
for (; tokenizer.hasMoreTokens();) {
buffer.append("/").append(tokenizer.nextToken());
doc.add(unstoredString(Index.SCOPE_FIELD_NAME, buffer.toString()));
depth++;
}
doc.add(unstoredString(Index.DEPTH_FIELD_NAME, configuration
.intToIndexString(depth)));
List extractors = ExtractorManager.getInstance().getContentExtractors(
configuration.getNamespaceName(), uri, descriptor);
for (Iterator i = extractors.iterator(); i.hasNext();) {
ContentExtractor extractor = (ContentExtractor) i.next();
doc.add(textField(Index.CONTENT_FIELD_NAME, extractor
.extract(content)));
}
return doc;
}
/**
* Schedules an index transaction. If asynchron indexing is enabled, this
* adds the jobs to the indexing queue, otherwise the indexing is executed
* imediately.
*
* @param removeJobs
* Set of jobs for deleting objects from the index.
* @param addJobs
* Set of Jobs for adding new objects to the index.
* @throws IndexException
*/
public void scheduleIndexTransaction(Set removeJobs, Set addJobs)
throws IndexException {
if (configuration.isIndexAsynchron()) {
IndexTransaction txn = new IndexTransaction(removeJobs, addJobs);
synchronized (this.txnQueue) {
this.txnQueue.addLast(txn);
this.txnQueue.notify();
}
} else {
executeIndexTransaction(removeJobs, addJobs);
}
}
synchronized void executeIndexTransaction(IndexTransaction txn)
throws IndexException {
executeIndexTransaction(txn.removeJobs, txn.addJobs);
}
synchronized void executeIndexTransaction(Set removeJobs, Set addJobs)
throws IndexException {
IndexWriter writer = null;
IndexReader reader = null;
try {
// execute delete jobs
if (removeJobs.size() > 0) {
reader = IndexReader.open(getDirectory());
for (Iterator i = removeJobs.iterator(); i.hasNext();) {
IndexJob job = (IndexJob) i.next();
if (logger.isEnabled(LOG_CHANNEL, Logger.DEBUG)) {
logger.log("remove: " + job.key, LOG_CHANNEL,
Logger.DEBUG);
}
reader.deleteDocuments(new Term(Index.KEY_FIELD_NAME, job.getKey()));
this.jobCounter++;
}
reader.close();
reader = null;
}
// execute index jobs
if (addJobs.size() > 0
|| this.jobCounter >= configuration.getOptimizeThreshold()) {
writer = new IndexWriter(getDirectory(), configuration
.getAnalyzer(), false);
for (Iterator i = addJobs.iterator(); i.hasNext();) {
IndexJob job = (IndexJob) i.next();
Document doc;
if (job.content != null) {
if (logger.isEnabled(LOG_CHANNEL, Logger.DEBUG)) {
logger.log("index content: " + job.key,
LOG_CHANNEL, Logger.DEBUG);
}
try {
doc = createLuceneDocument(job.uri, job.descriptor,
job.content);
writer.addDocument(doc);
} catch (ExtractorException e) {
logger.log("Error while extracting content: "
+ job.uri + " (" + e.toString() + ")",
LOG_CHANNEL, Logger.WARNING);
}
} else {
if (logger.isEnabled(LOG_CHANNEL, Logger.DEBUG)) {
logger.log("index properties: " + job.key,
LOG_CHANNEL, Logger.DEBUG);
}
doc = createLuceneDocument(job.uri, job.descriptor);
writer.addDocument(doc);
}
this.jobCounter++;
}
if (this.jobCounter > configuration.getOptimizeThreshold()) {
writer.optimize();
logger.log("optimize", LOG_CHANNEL, Logger.DEBUG);
this.jobCounter = 0;
}
writer.close();
writer = null;
}
} catch (Exception e) {
throw new IndexException(e);
} finally {
try {
if (reader != null)
reader.close();
if (writer != null)
writer.close();
} catch (IOException e) {
logger.log("Exception after executeIndexTransaction", e,
LOG_CHANNEL, Logger.ERROR);
}
}
}
/**
* Creates an IndexJob for <em>property indexing</em>.
*/
public IndexJob createIndexJob(Uri uri, NodeRevisionDescriptor descriptor) {
return new IndexJob(uri, descriptor);
}
/**
* Creates an IndexJob for <em>content indexing</em>.
*/
public IndexJob createIndexJob(Uri uri, NodeRevisionDescriptor descriptor,
InputStream content) {
return new IndexJob(uri, descriptor, content);
}
/**
* Creates an IndexJob for <em>removing</em> of a resource.
*/
public IndexJob createDeleteJob(Uri uri, NodeRevisionNumber number) {
return new IndexJob(uri, number);
}
public class IndexJob {
protected String key;
protected String uri;
protected NodeRevisionDescriptor descriptor;
protected InputStream content;
protected String getKey() {
return key;
}
protected IndexJob(Uri uri, NodeRevisionNumber number) {
this.uri = uri.toString();
this.descriptor = null;
this.content = null;
this.key = configuration.generateKey(this.uri, number);
}
protected IndexJob(Uri uri, NodeRevisionDescriptor descriptor) {
this.uri = uri.toString();
this.descriptor = descriptor;
this.content = null;
this.key = configuration.generateKey(this.uri, descriptor
.getRevisionNumber());
}
protected IndexJob(Uri uri, NodeRevisionDescriptor descriptor,
InputStream content) {
this.uri = uri.toString();
this.descriptor = descriptor;
this.content = content;
this.key = configuration.generateKey(this.uri, descriptor
.getRevisionNumber());
}
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj instanceof IndexJob) {
return this.key.equals(((IndexJob) obj).key);
}
return false;
}
public int hashCode() {
return key.hashCode();
}
public String toString() {
return this.key;
}
}
private static class IndexTransaction {
Set removeJobs;
Set addJobs;
IndexTransaction(Set removeJobs, Set addJobs) {
this.removeJobs = removeJobs;
this.addJobs = addJobs;
}
}
/**
* Thread for executing index jobs scheduled in the queue.
*/
private class JobRunner extends Thread {
public void run() {
while (true) {
IndexTransaction txn = null;
synchronized (txnQueue) {
while (txnQueue.size() < 1) {
// if the job list is empty, test whether the runner is
// interruppted, if so leave, otherwise wait for next
// job
if (this.isInterrupted()) {
return;
} else {
try {
txnQueue.wait();
} catch (InterruptedException e) {
return;
}
}
}
// assert(Index.this.jobs.size() >= 1)
txn = (IndexTransaction) txnQueue.getFirst();
txnQueue.removeFirst();
}
try {
executeIndexTransaction(txn);
} catch (Exception e) {
logger.log("Error while executing job", e, LOG_CHANNEL,
Logger.ERROR);
}
}
}
}
}
The table below shows all metrics for Index.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 89.00 | Number of blocks | |
| BLOCK_COMMENT | 26.00 | Number of block comment lines | |
| COMMENTS | 86.00 | Comment lines | |
| COMMENT_DENSITY | 0.24 | Comment density | |
| COMPARISONS | 40.00 | Number of comparison operators | |
| CYCLOMATIC | 78.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 10.00 | Comments in declarations | |
| DOC_COMMENT | 41.00 | Number of javadoc comment lines | |
| ELOC | 359.00 | Effective lines of code | |
| EXEC_COMMENTS | 17.00 | Comments in executable code | |
| EXITS | 91.00 | Procedure exits | |
| FUNCTIONS | 29.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 80.72 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 77.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 | 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 | 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 | 5.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 | 6.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 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 2.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 | 10.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 5.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 | 2.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 15.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 11.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 3.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 | 4.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 | 2.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1367.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 | 1.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 | 1.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 | 5.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 2.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 | 606.00 | Number of lines in the source file | |
| LINE_COMMENT | 19.00 | Number of line comments | |
| LOC | 437.00 | Lines of code | |
| LOGICAL_LINES | 221.00 | Number of statements | |
| LOOPS | 10.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 1107.00 | Number of operands | |
| OPERATORS | 2004.00 | Number of operators | |
| PARAMS | 38.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3111.00 | Halstead program length | |
| PROGRAM_VOCAB | 385.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 39.00 | Number of return points from functions | |
| SIZE | 17913.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 336.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 49.00 | Number of unique operators | |
| WHITESPACE | 83.00 | Number of whitespace lines | |