PreprocessorBuilder.java
| Index Score | ||
|---|---|---|
 |
 |
eclipseme.core.internal.preprocessor |
 |
 |
EclipseME |
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 | |
|---|---|---|
| DOC_COMMENT | Number of javadoc comment lines |  |
| COMMENTS | Comment lines | |
| EXITS | Procedure exits | |
| PARAMS | Number of formal parameter declarations | |
| SIZE | Size of the file in bytes | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LINES | Number of lines in the source file | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| DECL_COMMENTS | Comments in declarations | |
| RETURNS | Number of return points from functions | |
| OPERANDS | Number of operands | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| PROGRAM_LENGTH | Halstead program length | |
| BLOCKS | Number of blocks | |
| OPERATORS | Number of operators | |
| ELOC | Effective lines of code | |
| LOGICAL_LINES | Number of statements | |
| LOC | Lines of code | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| LINE_COMMENT | Number of line comments | |
| JAVA0031 | JAVA0031 Case statement not properly closed | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0109 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0160 | JAVA0160 Method does not throw specified exception | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0112 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| COMPARISONS | Number of comparison operators | |
| FUNCTIONS | Number of function declarations | |
| LOOPS | Number of loops | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
/**
* Copyright (c) 2003-2005 Craig Setera
* All Rights Reserved.
* Licensed under the Eclipse Public License - v 1.0
* For more information see http://www.eclipse.org/legal/epl-v10.html
*/
package eclipseme.core.internal.preprocessor;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.UnsupportedEncodingException;
import java.util.Map;
import org.eclipse.core.resources.IContainer;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceDelta;
import org.eclipse.core.resources.IResourceDeltaVisitor;
import org.eclipse.core.resources.IResourceVisitor;
import org.eclipse.core.resources.IncrementalProjectBuilder;
import org.eclipse.core.resources.ResourceAttributes;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IPackageFragmentRoot;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.Document;
import org.eclipse.jface.text.IDocument;
import antenna.preprocessor.v2.IPreprocessorListener;
import antenna.preprocessor.v2.Preprocessor;
import antenna.preprocessor.v2.Preprocessor.ILineFilter;
import antenna.preprocessor.v2.Preprocessor.ILogger;
import eclipseme.core.BuildLoggingConfiguration;
import eclipseme.core.console.BuildConsoleProxy;
import eclipseme.core.console.IBuildConsoleProxy;
import eclipseme.core.hook.sourceMapper.SourceMapperAccess;
import eclipseme.core.internal.EclipseMECorePlugin;
import eclipseme.core.internal.utils.Utils;
import eclipseme.core.model.IMidletSuiteProject;
import eclipseme.core.model.MidletSuiteFactory;
import eclipseme.core.model.SymbolDefinitionSet;
import eclipseme.core.persistence.PersistenceException;
/**
* An incremental builder implementation that provides preprocess
* support as defined for the Antenna Ant tools.<br/>
* <p>
The preprocessor supports the following directives inside a Java
source file. All directives must immediately follow a "//" comment that
starts at the beginning of a line (whitespace is allowed left of them, but
no Java code). That way, they don't interfere with normal Java compilation.
Directives must not span multiple lines of code.
<p />
<table class="color">
<tr>
<th width="30%">
Directive
</th>
<th>
Decription
</th>
</tr>
<tr>
<td>
#define <identifier>
</td>
<td>
Defines an identifier, thus making its value "true" when it is
referenced in further expressions.
</td>
</tr>
<tr>
<td>
#undefine <identifier>
</td>
<td>
Undefines an identifier, thus making its value "false" when it is
referenced in further expressions.
</td>
</tr>
<tr>
<td>
#ifdef <identifier>
</td>
<td rowspan="8">
The following lines are compiled only if the given identifier
is defined (or undefined, in the case of an "#ifndef"
directive). "#else" does exactly what your think it does. Each
directive must be ultimately closed by an "#endif" directive.
The "#elifdef" and "#elifndef" directives help to specify longer conditional
cascades without having to nest each level.
<p />
The "#if" and "#elif" directives even allow to use complex expressions.
These expressions are very much like Java boolean expressions. They
may consist of identifiers, parentheses and the usual "&&", "||",
"^", and "!" operators.
<p />
Please note that "#ifdef" and "#ifndef" don't
support complex expressions. They only expect a single argument - the
symbol to be checked.
</td>
</tr>
<tr>
<td>
#ifndef <identifier>
</td>
</tr>
<tr>
<td>
#else
</td>
</tr>
<tr>
<td>
#endif
</td>
</tr>
<tr>
<td>
#elifdef <identifier>
</td>
</tr>
<tr>
<td>
#elifndef <identifier>
</td>
</tr>
<tr>
<td>
#if <expression>
</td>
</tr>
<tr>
<td>
#elif <expression>
</td>
</tr>
<tr>
<td>
#include <filename>
</td>
<td rowspan="2">
Includes the given source file at the current position. Must
be terminated by "#endinclude" for technical reasons. The
filename may also be given as an Ant-style property (${name}).
The property needs to be defined in your build.xml file then. Note
that relative file names are interpreted as relative to the
build.xml file.
</td>
</tr>
<tr>
<td>
#endinclude
</td>
</tr>
</table>
* <p />
* Copyright (c) 2003-2005 Craig Setera<br>
* All Rights Reserved.<br>
* Licensed under the Eclipse Public License - v 1.0<p/>
* <br>
* $Revision: 1.6 $
* <br>
* $Date: 2006/12/18 02:13:46 $
* <br>
* @author Craig Setera
*/
public class PreprocessorBuilder extends IncrementalProjectBuilder {
/** A preprocessor problem marker */
public static final String PROBLEM_MARKER = "eclipseme.core.preprocessor.problemmarker";
// The subdirectory into which the processed output will go
public static final String PROCESSED_DIRECTORY = ".processed";
private static final String PROCESSED_PATH = "/" + PROCESSED_DIRECTORY;
/**
* Return an appropriate output file for the specified resource.
* This file is not guaranteed to exist.
*
* @param resource
* @return
*/
public static IFile getOutputFile(IResource resource) {
IPath projectRelativePath = new Path(PROCESSED_PATH).append(resource.getProjectRelativePath());
return resource.getProject().getFile(projectRelativePath);
}
/**
* Return the project that is to hold the preprocess output results for the
* specified project.
*
* @param project
* @return
*/
public static IProject getOutputProject(IProject project) {
String ppProjectName = "." + project.getName() + "_PP";
return ResourcesPlugin.getWorkspace().getRoot().getProject(ppProjectName);
}
/**
* Return a boolean indicating whether or not the specified
* resource has already been preprocessed and should be ignored
* for further processing.
*
* @param resource
* @return
*/
public static boolean isPreprocessed(IResource resource) {
IPath projectPath = resource.getProjectRelativePath();
return projectPath.segment(0).equals(PROCESSED_DIRECTORY);
}
/**
* Resource visitor for visiting java files for preprocessing.
*/
protected class ResourceVisitor implements IResourceVisitor {
protected SymbolDefinitionSet symbols;
protected IProgressMonitor monitor;
protected ResourceVisitor(SymbolDefinitionSet symbols, IProgressMonitor monitor) {
this.symbols = symbols;
this.monitor = monitor;
}
public boolean visit(IResource resource)
throws CoreException
{
if (shouldBeProcessed(resource, monitor)) {
preprocess(resource, symbols, monitor);
}
return true;
}
}
/**
* Resource delta visitor for visiting changed java files for
* preprocessing.
*/
private class ResourceDeltaVisitor
extends ResourceVisitor
implements IResourceDeltaVisitor
{
protected ResourceDeltaVisitor(SymbolDefinitionSet symbols, IProgressMonitor monitor) {
super(symbols, monitor);
}
public boolean visit(IResourceDelta delta)
throws CoreException
{
boolean value = false;
switch (delta.getKind()) {
case IResourceDelta.ADDED:
case IResourceDelta.CHANGED:
value = visit(delta.getResource());
break;
case IResourceDelta.REMOVED: {
IFile outputFile = getOutputFile(delta.getResource());
if (outputFile.exists()) {
outputFile.delete(true, monitor);
}
}
break;
default:
// Do nothing
}
return value;
}
}
private BuildLoggingConfiguration buildLoggingConfig;
// Tracker for a warning check
private boolean checkedForHook;
/**
* Construct a new builder instance.
*/
public PreprocessorBuilder() {
super();
buildLoggingConfig = BuildLoggingConfiguration.instance;
// During the first actual build, we will check to see
// if the hook has been installed. If not, the build
// will continue, but the user will be warned via the error
// log that it won't actually work.
checkedForHook = false;
}
/**
* @see org.eclipse.core.resources.IncrementalProjectBuilder#build(int, java.util.Map, org.eclipse.core.runtime.IProgressMonitor)
*/
protected IProject[] build(int kind, Map args, IProgressMonitor monitor)
throws CoreException
{
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreprocessorBuilder.build");
}
if (!checkedForHook) {
if (!SourceMapperAccess.isHookCodeInstalled()) {
EclipseMECorePlugin.log(
IStatus.WARNING,
"Preprocessor invoked, but hook is not installed. Consult the installation instructions for EclipseME.");
}
checkedForHook = true;
}
doPreprocessing(kind, args, monitor);
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreprocessorBuilder.build");
}
return null;
}
/**
* @see org.eclipse.core.resources.IncrementalProjectBuilder#clean(org.eclipse.core.runtime.IProgressMonitor)
*/
protected void clean(IProgressMonitor monitor)
throws CoreException
{
IProject srcProject = getProject();
IFolder folder = srcProject.getFolder(PROCESSED_PATH);
Utils.clearContainer(folder, monitor);
}
/**
* Clear previous preprocessor markers from the specified resource.
*
* @param resource
* @throws CoreException
*/
private void clearPreprocessorMarkers(IResource resource)
throws CoreException
{
IMarker[] markers = resource.findMarkers(PROBLEM_MARKER, true, IResource.DEPTH_ONE);
for (int i = 0; i < markers.length; i++) {
markers[i].delete();
}
}
/**
* Create the parent folders of this file.
*
* @param outputFile
* @param monitor
* @throws CoreException
*/
private void createParentFolders(IResource resource, IProgressMonitor monitor)
throws CoreException
{
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreprocessorBuilder.createParentFolders; resource = " + resource);
}
IContainer parent = resource.getParent();
if (parent.getType() == IResource.FOLDER) {
createParentFolders(parent, monitor);
IFolder folder = (IFolder) parent;
if (!folder.exists()) {
folder.create(true, true, monitor);
folder.setDerived(true);
}
}
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreprocessorBuilder.createParentFolders");
}
}
/**
* Do the preprocessing build.
*
* @param kind
* @param args
* @param monitor
* @throws CoreException
*/
private void doPreprocessing(int kind, Map args, IProgressMonitor monitor)
throws CoreException
{
// Collect the java files that were updated
IProject project = getProject();
SymbolDefinitionSet symbols = getProjectSymbolDefinitions(project);
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln(
"> PreprocessorBuilder.doPreprocessing; project = " +
project +
"; symbols = " +
((symbols == null) ? "none" : symbols.getName()));
}
// Wrap up the symbol definition set in another wrapper set. Changes
// made to the set while processing the source will not propagate
// to the base definition set
// symbols = new SymbolDefinitionSet(symbols);
// Traverse the changes in the resource delta, processing the
// resources along the way.
IResourceDelta delta = getDelta(project);
if (delta == null) {
ResourceVisitor visitor = new ResourceVisitor(symbols, monitor);
project.accept(visitor);
} else {
ResourceDeltaVisitor visitor = new ResourceDeltaVisitor(symbols, monitor);
delta.accept(visitor);
}
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreprocessorBuilder.doPreprocessing");
}
}
/**
* Get the content encoding for the specified file. If none is set,
* attempt to pick up the appropriate encoding for the underlying
* platform.
*
* @param file
* @return
* @throws CoreException
*/
private String getContentEncoding(IFile file)
throws CoreException
{
String encoding = file.getContentDescription().getCharset();
if (encoding == null) {
encoding = System.getProperty("file.encoding", "UTF-8");
}
return encoding;
}
/**
* Return a document instance based on the contents of the
* specified file.
*
* @param file
* @return
* @throws CoreException
* @throws IOException
*/
private IDocument getDocumentForFile(IFile file)
throws CoreException
{
String charset = file.getCharset(true);
InputStream contentStream = file.getContents();
BufferedReader reader = null;
try {
reader = new BufferedReader(new InputStreamReader(contentStream, charset));
} catch (UnsupportedEncodingException e) {
// Should not happen
}
String line = null;
StringWriter stringWriter = new StringWriter();
PrintWriter writer = new PrintWriter(stringWriter);
try {
while ((line = reader.readLine()) != null) {
writer.println(line);
}
} catch (IOException e) {
EclipseMECorePlugin.throwCoreException(IStatus.ERROR, -999, e);
} finally {
try { reader.close(); } catch (IOException e) { /* Munch */ }
}
return new Document(stringWriter.toString());
}
/**
* Return the symbols defined for the specified project.
*
* @param project
* @return
*/
private SymbolDefinitionSet getProjectSymbolDefinitions(IProject project) {
SymbolDefinitionSet symbols = null;
IMidletSuiteProject midletSuite = MidletSuiteFactory.getMidletSuiteProject(JavaCore.create(project));
try {
symbols = midletSuite.getEnabledSymbolDefinitionSet();
} catch (CoreException e) {
EclipseMECorePlugin.log(IStatus.ERROR, e);
} catch (PersistenceException e) {
EclipseMECorePlugin.log(IStatus.ERROR, e);
}
if (symbols == null) {
symbols = new SymbolDefinitionSet("__default" + System.currentTimeMillis());
}
return symbols;
}
/**
* Return a boolean indicating whether or not the specified resource
* is on the build path.
*
* @param resource
* @param monitor
* @return
*/
private boolean isOnBuildPath(IResource resource, IProgressMonitor monitor) {
boolean onBuildPath = false;
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreprocessorBuilder.isOnBuildPath; resource = " + resource);
}
IJavaElement javaElement = JavaCore.create((IFile) resource);
if (javaElement != null) {
IPackageFragmentRoot root =
(IPackageFragmentRoot) javaElement.getAncestor(IJavaElement.PACKAGE_FRAGMENT_ROOT);
onBuildPath = root.exists();
}
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreprocessorBuilder.isOnBuildPath; returning = " + onBuildPath);
}
return onBuildPath;
}
/**
* Preprocess the specified java resource.
*
* @param resource
* @param symbols
* @param monitor
* @throws CoreException
*/
protected void preprocess(final IResource resource, SymbolDefinitionSet symbols, IProgressMonitor monitor)
throws CoreException
{
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreprocessorBuilder.preprocess; resource = " + resource);
BuildConsoleProxy.instance.traceln("- PreprocessorBuilder.preprocess symbol set = " + symbols.getName());
}
// The document being processed... Used for offset conversions
final IDocument document = getDocumentForFile((IFile) resource);
// Clear the previous preprocessor errors
clearPreprocessorMarkers(resource);
ILogger logger = new ILogger() {
public void log(String message) {
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln(message);
}
}
};
ILineFilter filter = new ILineFilter() {
public String filter(String line) {
return line;
}
};
IPreprocessorListener listener = new IPreprocessorListener() {
public void error(Exception e, int lineNumber, int offset, int length) {
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.getConsoleWriter(IBuildConsoleProxy.ID_ERROR_STREAM).println("Preprocessor error: " + e);
}
createResourceMarker(resource, document, e.getMessage(), lineNumber, offset, length, true);
}
public void warning(String message, int lineNumber, int offset, int length) {
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.getConsoleWriter(IBuildConsoleProxy.ID_OUTPUT_STREAM).println("Preprocessor warning: " + message);
}
createResourceMarker(resource, document, message, lineNumber, offset, length, false);
}
};
IFile file = (IFile) resource;
File localFile = file.getLocation().toFile();
String charset = getContentEncoding(file);
InputStream is = file.getContents();
ByteArrayOutputStream bos = new ByteArrayOutputStream();
Preprocessor preprocessor = new Preprocessor(logger, filter);
preprocessor.setFile(localFile);
preprocessor.setListener(listener);
try {
preprocessor.addDefines(symbols.toString());
preprocessor.preprocess(is, bos, charset);
writeProcessedResults(resource, bos.toByteArray(), monitor);
} catch (Exception e1) {
EclipseMECorePlugin.throwCoreException(IStatus.ERROR, -999, e1);
} finally {
try { is.close(); } catch (IOException e) {}
}
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreprocessorBuilder.preprocess");
}
}
/**
* Create a new marker in the specified resource.
*
* @param resource
* @param document
* @param message
* @param lineNumber
* @param offset
* @param length
* @param error
* @throws CoreException
* @throws BadLocationException
*/
protected void createResourceMarker(
IResource resource,
IDocument document,
String message,
int lineNumber,
int offset,
int length,
boolean error)
{
int severity = error ? IMarker.SEVERITY_ERROR : IMarker.SEVERITY_WARNING;
try {
IMarker marker = resource.createMarker(PROBLEM_MARKER);
marker.setAttribute(IMarker.MESSAGE, message);
marker.setAttribute(IMarker.SEVERITY, severity);
int start = document.getLineOffset(lineNumber) + offset;
int end = start + length;
marker.setAttribute(IMarker.CHAR_START, start);
marker.setAttribute(IMarker.CHAR_END, end);
} catch (Exception e) {
EclipseMECorePlugin.log(IStatus.ERROR, e);
}
}
/**
* Set the specified file to be read-only or not based on the
* specified flag.
*
* @param outputFile
* @param readOnly
* @throws CoreException
*/
private void setReadOnly(IFile outputFile, boolean readOnly)
throws CoreException
{
ResourceAttributes attributes = new ResourceAttributes();
attributes.setReadOnly(readOnly);
outputFile.setResourceAttributes(attributes);
}
/**
* Return a boolean indicating whether the specified resource
* should be processed.
*
* @param resource
* @param monitor
* @return
* @throws CoreException
*/
private boolean shouldBeProcessed(IResource resource, IProgressMonitor monitor)
throws CoreException
{
return
(resource.getType() == IResource.FILE) &&
(resource.getName().endsWith(".java")) &&
!isPreprocessed(resource) &&
isOnBuildPath(resource, monitor);
}
/**
* Write out the results of the processing.
*
* @param resource
* @param symbols
* @param sourceDocument
* @param monitor
* @throws CoreException
*/
private void writeProcessedResults(
final IResource resource,
byte[] contents,
IProgressMonitor monitor)
throws CoreException
{
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreprocessorBuilder.writeProcessedResults");
}
ByteArrayInputStream is = new ByteArrayInputStream(contents);
final IFile outputFile = getOutputFile(resource);
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln("- PreprocessorBuilder.writeProcessedResults; outputFile = " + outputFile);
}
if (outputFile.exists()) {
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln("- PreprocessorBuilder.writeProcessedResults; outputFile exists, setting new contents");
}
setReadOnly(outputFile, false);
outputFile.setContents(is, true, false, monitor);
} else {
IContainer container = outputFile.getParent();
if (!container.exists()) {
createParentFolders(outputFile, monitor);
}
outputFile.create(is, false, monitor);
}
outputFile.setCharset("UTF-8", monitor);
outputFile.setDerived(true);
setReadOnly(outputFile, true);
// It seems this should not be necessary, but let's see if it
// helps on some problems we are seeing...
// outputFile.getProject().build(AUTO_BUILD, monitor);
if (buildLoggingConfig.isPreprocessorTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreprocessorBuilder.writeProcessedResults");
}
}
}
The table below shows all metrics for PreprocessorBuilder.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 77.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 321.00 | Comment lines | |
| COMMENT_DENSITY | 1.05 | Comment density | |
| COMPARISONS | 40.00 | Number of comparison operators | |
| CYCLOMATIC | 72.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 25.00 | Comments in declarations | |
| DOC_COMMENT | 301.00 | Number of javadoc comment lines | |
| ELOC | 305.00 | Effective lines of code | |
| EXEC_COMMENTS | 10.00 | Comments in executable code | |
| EXITS | 85.00 | Procedure exits | |
| FUNCTIONS | 26.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 75.36 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 106.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 | 1.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 | 1.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 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 1.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 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 2.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 1.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 | 2.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 3.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 1.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 3.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.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 | 1.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 2.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 | 5.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 | 1.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 | 4.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1541.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 | 3.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 | 1.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 | 2.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 | 791.00 | Number of lines in the source file | |
| LINE_COMMENT | 20.00 | Number of line comments | |
| LOC | 387.00 | Lines of code | |
| LOGICAL_LINES | 188.00 | Number of statements | |
| LOOPS | 2.00 | Number of loops | |
| NEST_DEPTH | 3.00 | Maximum nesting depth | |
| OPERANDS | 964.00 | Number of operands | |
| OPERATORS | 1616.00 | Number of operators | |
| PARAMS | 51.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2580.00 | Halstead program length | |
| PROGRAM_VOCAB | 392.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 55.00 | Number of return points from functions | |
| SIZE | 22977.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 339.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 53.00 | Number of unique operators | |
| WHITESPACE | 83.00 | Number of whitespace lines | |