PreverificationBuilder.java
| Index Score | ||
|---|---|---|
 |
 |
eclipseme.core.internal.preverification.builder |
 |
 |
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 | |
|---|---|---|
| EXEC_COMMENTS | Comments in executable code |  |
| EXITS | Procedure exits | |
| LINE_COMMENT | Number of line comments | |
| RETURNS | Number of return points from functions | |
| SIZE | Size of the file in bytes | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| COMPARISONS | Number of comparison operators | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| OPERATORS | Number of operators | |
| UNIQUE_OPERANDS | Number of unique operands | |
| BLOCKS | Number of blocks | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LOGICAL_LINES | Number of statements | |
| ELOC | Effective lines of code | |
| LINES | Number of lines in the source file | |
| CYCLOMATIC | Cyclomatic complexity | |
| LOC | Lines of code | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| DECL_COMMENTS | Comments in declarations | |
| COMMENTS | Comment lines | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| LOOPS | Number of loops | |
| JAVA0076 | JAVA0076 Use of magic number | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0008 | JAVA0008 Empty catch block | |
| JAVA0265 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0163 | JAVA0163 Empty statement | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| UNIQUE_OPERATORS | Number of unique operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0112 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0087 | JAVA0087 Use of Thread.sleep() | |
| FUNCTIONS | Number of function declarations | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
/**
* 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.preverification.builder;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Properties;
import java.util.jar.Attributes;
import java.util.jar.Manifest;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IncrementalProjectBuilder;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Status;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.IStreamListener;
import org.eclipse.debug.core.model.IProcess;
import org.eclipse.debug.core.model.IStreamMonitor;
import org.eclipse.debug.core.model.IStreamsProxy;
import org.eclipse.jdt.core.IClasspathEntry;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.JavaModelException;
import de.schlichtherle.io.ArchiveException;
import de.schlichtherle.io.File;
import de.schlichtherle.io.FileOutputStream;
import eclipseme.core.BuildLoggingConfiguration;
import eclipseme.core.IEclipseMECoreConstants;
import eclipseme.core.console.BuildConsoleProxy;
import eclipseme.core.console.IBuildConsoleProxy;
import eclipseme.core.internal.EclipseMECorePlugin;
import eclipseme.core.internal.PreferenceAccessor;
import eclipseme.core.internal.packaging.DeployedJADWriter;
import eclipseme.core.internal.packaging.ObfuscatorTool;
import eclipseme.core.internal.preverifier.PreverificationUtils;
import eclipseme.core.internal.utils.AbstractClasspathEntryVisitor;
import eclipseme.core.internal.utils.ColonDelimitedProperties;
import eclipseme.core.internal.utils.Utils;
import eclipseme.core.model.ApplicationDescriptor;
import eclipseme.core.model.IJADConstants;
import eclipseme.core.model.IMidletSuiteProject;
import eclipseme.core.model.MidletSuiteFactory;
import eclipseme.core.model.Version;
import eclipseme.core.model.ApplicationDescriptor.MidletDefinition;
import eclipseme.preverifier.results.PreverificationError;
/**
* Provides an incremental project builder implementation
* to do a J2ME preverification of classes. It is imperative
* that this builder follow the standard Java builder. The
* standard Java builder will generate the standard compiled
* class. The preverifier will then preverify that generated
* class.
* <p />
* Copyright (c) 2003-2007 Craig Setera<br>
* All Rights Reserved.<br>
* Licensed under the Eclipse Public License - v 1.0<p/>
* <br>
* $Revision: 1.16 $
* <br>
* $Date: 2006/11/26 21:42:00 $
* <br>
* @author Craig Setera
*/
public class PreverificationBuilder extends IncrementalProjectBuilder {
public static final String ARG_UPDATE_VERSION = "_update_version";
public static final String ARG_DO_PACKAGE = "_do_package";
public static final String ARG_DO_OBFUSCATION = "_do_obfuscation";
private static BuildLoggingConfiguration buildLoggingConfig = BuildLoggingConfiguration.instance;
// Tracks the TrueZip File instances that point to the deployed jar files
private static Map runtimeJars = new HashMap(5);
/**
* Clean the output of the specified project.
* @param project
* @param cleanDeployed Whether or not to clean the deployed directory too.
* @param monitor
*
* @throws JavaModelException
* @throws CoreException
*/
public static void cleanProject(IProject project, boolean cleanDeployed, IProgressMonitor monitor)
throws JavaModelException, CoreException
{
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.cleanProject project = " + project);
}
IJavaProject javaProject = JavaCore.create(project);
BuildInfo buildInfo =
new BuildInfo(IncrementalProjectBuilder.CLEAN_BUILD, new HashMap(), javaProject);
// Clear and remove the old verified directory and runtime folders
IFolder oldVerifiedFolder = project.getFolder(EclipseMECorePlugin.getVerifiedOutputDirectoryName());
if (oldVerifiedFolder.exists()) {
Utils.clearContainer(oldVerifiedFolder, monitor);
oldVerifiedFolder.delete(true, monitor);
}
IFolder oldRuntimeFolder = project.getFolder(IEclipseMECoreConstants.TEMP_FOLDER_NAME).getFolder("runtime");
if (oldRuntimeFolder.exists()) {
Utils.clearContainer(oldRuntimeFolder, monitor);
oldRuntimeFolder.delete(true, monitor);
}
// Clear the classes and libraries
IFolder classesPreverifyFolder = buildInfo.getVerifiedClassesFolder(monitor);
Utils.clearContainer(classesPreverifyFolder, monitor);
IFolder libsPreverifyFolder = buildInfo.getVerifiedLibsFolder(monitor);
Utils.clearContainer(libsPreverifyFolder, monitor);
// Delete the runtime JAR file
IFolder runtimeFolder = buildInfo.getRuntimeFolder(monitor);
if (runtimeFolder.exists()) {
deleteRuntimeJar(project, monitor);
Utils.clearContainer(runtimeFolder, monitor);
}
// We also delete the deployed folder
if (cleanDeployed) {
IFolder deploymentFolder = getDeploymentFolder(project, monitor);
if (deploymentFolder.exists()) {
Utils.clearContainer(deploymentFolder, monitor);
}
}
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.cleanProject project = " + project);
}
}
/**
* Return the File instance for the runtime jar file in the specified project.
*
* @param project
* @return
*/
public static File getRuntimeJar(IProject project, IProgressMonitor monitor)
throws CoreException
{
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.getRuntimeJar project = " + project);
}
File runtimeJar = (File) runtimeJars.get(project);
if (runtimeJar == null) {
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("- PreverificationBuilder.getRuntimeJar JAR file not in cache");
}
IFolder tempFolder = project.getFolder(IEclipseMECoreConstants.TEMP_FOLDER_NAME);
IFolder runtimeFolder = tempFolder.getFolder(IEclipseMECoreConstants.EMULATION_FOLDER_NAME);
createFolders(runtimeFolder, monitor);
IJavaProject javaProject = JavaCore.create(project);
IMidletSuiteProject midletSuite =
MidletSuiteFactory.getMidletSuiteProject(javaProject);
runtimeJar = new File(runtimeFolder.getLocation().toFile(), midletSuite.getJarFilename());
runtimeJar.mkdir();
runtimeFolder.refreshLocal(IResource.DEPTH_ONE, monitor);
runtimeJars.put(project, runtimeJar);
}
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.getRuntimeJar project = " + project);
}
return runtimeJar;
}
/**
* Delete the deployed jar file instance being cached (if found).
*
* @param project
* @param monitor
* @throws CoreException
*/
private static void deleteRuntimeJar(IProject project, IProgressMonitor monitor)
throws CoreException
{
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.deleteRuntimeJar project = " + project);
}
File runtimeJar = (File) runtimeJars.remove(project);
if ((runtimeJar != null) && (runtimeJar.exists())) {
try {
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("- PreverificationBuilder.deleteRuntimeJar jar = " + runtimeJar);
}
// Release the initial locks on the jar file and flush the
// current buffered information
File.umount(runtimeJar, true, true, true, true);
// Delete the contents of the JAR file... this is necessary
// before TrueZip will allow us to delete the top level jar
// file. While it might be possible to get to a standard
// java.io.File object to avoid this handling, this approach
// helps to make sure that TrueZip has consistent information
// about what is on the file system.
runtimeJar.deleteAll();
// Now that the contents of the jar file are gone, TrueZip will
// allow us to completely delete the file, finally releasing the
// locks on that file.
runtimeJar.delete();
IFolder tempFolder = project.getFolder(IEclipseMECoreConstants.TEMP_FOLDER_NAME);
IFolder runtimeFolder = tempFolder.getFolder(IEclipseMECoreConstants.EMULATION_FOLDER_NAME);
runtimeFolder.refreshLocal(1, monitor);
} catch (CoreException e) {
e.printStackTrace();
throw e;
} catch (ArchiveException e) {
e.printStackTrace();
EclipseMECorePlugin.throwCoreException(IStatus.ERROR, -999, e);
}
}
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.deleteRuntimeJar project = " + project);
}
}
/**
* Get the folder into which the jad and jar will be written.
*
* @param project
* @param monitor
* @return
* @throws CoreException
*/
private static IFolder getDeploymentFolder(IProject project, IProgressMonitor monitor)
throws CoreException
{
String deploymentDirectoryName = EclipseMECorePlugin.getDeploymentDirectoryName();
IFolder deploymentFolder = project.getFolder(deploymentDirectoryName);
if (!deploymentFolder.exists()) {
deploymentFolder.create(false, true, monitor);
}
return deploymentFolder;
}
/**
* Implementation of the IClasspathEntryVisitor interface
* for collecting the set of required projects
*/
private static class RequiredProjectsCPEntryVisitor
extends AbstractClasspathEntryVisitor
{
private ArrayList requiredProjects;
/** Construct a new instance. */
private RequiredProjectsCPEntryVisitor() {
requiredProjects = new ArrayList();
}
/**
* @return Returns the requiredProjects.
*/
public ArrayList getRequiredProjects() {
return requiredProjects;
}
/**
* @see eclipseme.core.internal.utils.IClasspathEntryVisitor#visitProject(IClasspathEntry, org.eclipse.jdt.core.IJavaProject, org.eclipse.jdt.core.IJavaProject, org.eclipse.core.runtime.IProgressMonitor)
*/
public boolean visitProject(
IClasspathEntry entry,
IJavaProject javaProject,
IJavaProject classpathProject,
IProgressMonitor monitor)
throws CoreException
{
boolean continueVisitation = entry.isExported();
if (continueVisitation) {
requiredProjects.add(classpathProject);
}
return continueVisitation;
}
}
/**
* Create the specified folder and all parent folders as necessary.
*
* @param folder
* @param monitor
* @throws CoreException
*/
static void createFolders(IFolder folder, IProgressMonitor monitor)
throws CoreException
{
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.createFolders folder = " + folder);
}
while (!folder.exists()) {
if (folder.getParent().getType() == IResource.FOLDER) {
createFolders((IFolder) folder.getParent(), monitor);
}
folder.create(true, true, monitor);
folder.setDerived(true);
}
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.createFolders folder = " + folder);
}
}
/**
* Generate a MANIFEST.MF file into the deployed folder based
* on the current information in the JAD file.
*
* @param midletSuite
* @param monitor
* @throws CoreException
*/
static void generateDeployedManifest(IMidletSuiteProject midletSuite, IProgressMonitor monitor)
throws CoreException
{
IProject project = midletSuite.getProject();
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.generateDeployedManifest project = " + project);
}
if (!midletSuite.getJadFile().exists()) {
BuildConsoleProxy.instance.traceln("- PreverificationBuilder.generateDeployedManifest exiting early since " + midletSuite.getJadFile() + " does not exist");
return;
}
ApplicationDescriptor applicationDescriptor =
midletSuite.getApplicationDescriptor();
Properties manifestProperties = applicationDescriptor.getManifestProperties();
// Filter out manifest attributes
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("- PreverificationBuilder.generateDeployedManifest filtering excluded properties");
}
String[] excluded = PreferenceAccessor.instance.getExcludedManifestProperties(project);
for (int i = 0; i < excluded.length; i++) {
String excludedName = excluded[i];
if (manifestProperties.containsKey(excludedName)) {
manifestProperties.remove(excludedName);
}
}
Manifest jarManifest = new Manifest();
Attributes mainAttributes = jarManifest.getMainAttributes();
mainAttributes.putValue(Attributes.Name.MANIFEST_VERSION.toString(), "1.0");
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("- PreverificationBuilder.generateDeployedManifest setting properties into Manifest object");
}
Iterator iterator = manifestProperties.entrySet().iterator();
while (iterator.hasNext()) {
Map.Entry entry = (Map.Entry) iterator.next();
try {
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("- PreverificationBuilder.generateDeployedManifest -- " + entry.getKey() + " -> " + entry.getValue());
}
mainAttributes.putValue((String) entry.getKey(), (String) entry.getValue());
} catch (IllegalArgumentException e) {
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("- PreverificationBuilder.generateDeployedManifest exception: " + e);
}
Status s = new Status(
IStatus.ERROR,
IEclipseMECoreConstants.PLUGIN_ID,
-999,
"Illegal Manifest Entry Key or Value \"" + e.getMessage() + "\"",
e);
throw new CoreException(s);
}
}
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("- PreverificationBuilder.generateDeployedManifest setting MIDlet definitions");
}
Iterator iter = applicationDescriptor.getMidletDefinitions().iterator();
while (iter.hasNext()) {
MidletDefinition def = (MidletDefinition) iter.next();
String key = ApplicationDescriptor.MIDLET_PREFIX + def.getNumber();
String value = def.toString();
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("- PreverificationBuilder.generateDeployedManifest -- " + key + " -> " + value);
}
mainAttributes.putValue(key, value);
}
FileOutputStream fos = null;
File manifestFile = new File(getRuntimeJar(project, monitor), "META-INF/MANIFEST.MF");
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("- PreverificationBuilder.generateDeployedManifest writing manifest file: " + manifestFile);
}
try {
fos = new FileOutputStream(manifestFile);
jarManifest.write(fos);
} catch (IOException e) {
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("- PreverificationBuilder.generateDeployedManifest exception: " + e);
}
Status s = new Status(
IStatus.ERROR,
IEclipseMECoreConstants.PLUGIN_ID,
-999,
"Illegal Manifest Entry Key or Value \"" + e.getMessage() + "\"",
e);
throw new CoreException(s);
} finally {
if (fos != null) {
try { fos.close(); } catch (IOException e) {}
}
}
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.generateDeployedManifest suite = " + midletSuite.getProject());
}
}
/**
* Construct a new builder instance.
*
*/
public PreverificationBuilder() {
}
/**
* @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
{
IProject project = getProject();
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.build project = " + project);
}
IJavaProject rootJavaProject = JavaCore.create(project);
IJavaProject javaProject = rootJavaProject;
IJavaProject[] requiredProjects = getRequiredProjects(javaProject, monitor);
// TODO Fix monitoring
monitor.beginTask("Preverification", requiredProjects.length + 1);
BuildInfo buildInfo = new BuildInfo(kind, args, javaProject);
// Update the manifest version if specified
boolean updateVersionForProject =
PreferenceAccessor.instance.getAutoversionPackage(project) &&
buildInfo.isBuildArgumentTrue(ARG_UPDATE_VERSION);
if (updateVersionForProject) {
updateJADVersion(buildInfo, monitor);
} else {
generateDeployedManifest(buildInfo.getMidletSuite(), monitor);
}
// Start with our project
preverifyProject(buildInfo, monitor);
// Now prereq projects
for (int i = 0; i < requiredProjects.length; i++) {
javaProject = requiredProjects[i];
if (javaProject != null) {
buildInfo.setCurrentJavaProject(javaProject);
preverifyProject(buildInfo, monitor);
}
}
// Make sure all of the libraries in the project have been
// preverified
if (buildInfo.isClasspathChanged() && buildInfo.areLibrariesPreverified()) {
IFolder libsFolder = buildInfo.getVerifiedLibsFolder(monitor);
Utils.clearContainer(libsFolder, monitor);
buildInfo.setCurrentJavaProject(rootJavaProject);
preverifyLibraries(buildInfo, monitor);
for (int i = 0; i < requiredProjects.length; i++) {
javaProject = requiredProjects[i];
buildInfo.setCurrentJavaProject(javaProject);
preverifyLibraries(buildInfo, monitor);
}
}
// Convert to IProject instances
IProject[] interestingProjects = new IProject[requiredProjects.length];
for (int i = 0; i < requiredProjects.length; i++) {
interestingProjects[i] = requiredProjects[i].getProject();
}
// Make sure that the TrueZIP caches are forced out to the file system
// and update the JAD file to contain the correct size
if (buildInfo.isPackageDirty()) {
try {
File runtimeJar = buildInfo.getRuntimeJarFile(monitor);
File.umount(runtimeJar, true, true, true, true);
writeJADFile(buildInfo, runtimeJar, buildInfo.getRuntimeFolder(monitor), true, monitor);
} catch (ArchiveException e) {
EclipseMECorePlugin.throwCoreException(IStatus.ERROR, -999, e);
}
}
// Obfuscate as requested
if (buildInfo.isBuildArgumentTrue(ARG_DO_PACKAGE)) {
buildInfo.setPackageDirty(true);
if (buildInfo.isBuildArgumentTrue(ARG_DO_OBFUSCATION)) {
doObfuscation(buildInfo, monitor);
} else {
copyRuntimeJarToDeploymentFolder(buildInfo, monitor);
}
}
// Refresh...
if (buildInfo.isPackageDirty()) {
generateDeployedManifest(buildInfo.getMidletSuite(), monitor);
IFolder deployedFolder = getDeploymentFolder(project, monitor);
deployedFolder.refreshLocal(IResource.DEPTH_INFINITE, monitor);
// Set all of the resources in the verified path
// to be derived resources
setResourcesAsDerived(buildInfo.getVerifiedClassesFolder(monitor), monitor);
setResourcesAsDerived(buildInfo.getVerifiedLibsFolder(monitor), monitor);
setResourcesAsDerived(buildInfo.getRuntimeFolder(monitor), monitor);
}
monitor.done();
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.build project = " + project);
}
return interestingProjects;
}
/* (non-Javadoc)
* @see org.eclipse.core.internal.events.InternalBuilder#clean(org.eclipse.core.runtime.IProgressMonitor)
*/
protected void clean(IProgressMonitor monitor)
throws CoreException
{
IProject project = getProject();
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.clean project = " + project);
}
super.clean(monitor);
cleanProject(project, false, monitor);
// Regenerate the manifest
IMidletSuiteProject suite =
MidletSuiteFactory.getMidletSuiteProject(JavaCore.create(getProject()));
generateDeployedManifest(suite, monitor);
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.clean project = " + project);
}
}
/**
* Copy the runtime jar file to the deployed folder.
*
* @param buildInfo
* @param monitor
* @throws CoreException
*/
private void copyRuntimeJarToDeploymentFolder(BuildInfo buildInfo, IProgressMonitor monitor)
throws CoreException
{
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.copyRuntimeJarToDeploymentFolder");
}
FileInputStream fis = null;
try {
File runtimeJar = getRuntimeJar(getProject(), monitor);
fis = new FileInputStream(runtimeJar);
IFolder deploymentFolder = getDeploymentFolder(buildInfo, monitor);
IFile deployedJar = deploymentFolder.getFile(runtimeJar.getName());
if (deployedJar.exists()) {
deployedJar.setContents(fis, true, false, monitor);
} else {
deployedJar.create(fis, true, monitor);
}
writeJADFile(buildInfo, new File(deployedJar.getLocation().toFile()), deploymentFolder, false, monitor);
} catch (IOException e) {
EclipseMECorePlugin.throwCoreException(IStatus.ERROR, 999, e);
} finally {
if (fis != null) {
try { fis.close(); } catch (IOException e) { }
}
}
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.copyRuntimeJarToDeploymentFolder");
}
}
/**
* Do the work to obfuscate the jar file.
* @param deployedJarFile
* @param monitor
*
* @throws CoreException
*/
private void doObfuscation(BuildInfo buildInfo, IProgressMonitor monitor)
throws CoreException
{
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.doObfuscation");
}
final StringBuffer errorText = new StringBuffer();
File runtimeJar = buildInfo.getRuntimeJarFile(monitor);
BuildConsoleProxy.instance.traceln("Obfuscating " + runtimeJar);
// Calculate the name of the obfuscated jar file name...
Path runtimeJarPath = new Path(runtimeJar.getAbsolutePath());
String basename = runtimeJarPath.lastSegment();
basename = basename.substring(0, basename.length() - 4); // Making an assumption of .jar file extension
IFolder deploymentFolder = getDeploymentFolder(buildInfo, monitor);
IFile obfuscatedJarFile = deploymentFolder.getFile(basename + "_obf.jar");
IFile deployedJarFile = deploymentFolder.getFile(runtimeJarPath.lastSegment());
BuildConsoleProxy.instance.traceln("Obfuscating to output jar " + obfuscatedJarFile.getLocation().toFile());
ObfuscatorTool obfuscator =
new ObfuscatorTool(buildInfo.getMidletSuite(), runtimeJar, obfuscatedJarFile.getLocation().toFile());
ILaunch launch = obfuscator.launch(monitor);
// Snag any error output that might occur
final StringBuffer stdoutBuffer = new StringBuffer();
IProcess[] processes = launch.getProcesses();
if ((processes != null) && (processes.length > 0)) {
IProcess process = processes[0];
IStreamsProxy proxy = process.getStreamsProxy();
// Wire up a listener to write to the console if logging is
// enabled
if (buildLoggingConfig.isObfuscationOutputEnabled()) {
BuildConsoleProxy.instance.traceln("======================== Launching Obfuscation =========================");
BuildConsoleProxy.instance.addConsoleStreamListener(
IBuildConsoleProxy.ID_ERROR_STREAM,
proxy.getErrorStreamMonitor());
BuildConsoleProxy.instance.addConsoleStreamListener(
IBuildConsoleProxy.ID_OUTPUT_STREAM,
proxy.getOutputStreamMonitor());
}
proxy.getErrorStreamMonitor().addListener(new IStreamListener() {
public void streamAppended(String text, IStreamMonitor monitor) {
errorText.append(text);
}
});
// Wait until completion
while ((!monitor.isCanceled()) && (!process.isTerminated())) {
try { Thread.sleep(1000); } catch (InterruptedException e) {};
}
if (buildLoggingConfig.isObfuscationOutputEnabled()) {
BuildConsoleProxy.instance.traceln("======================== Obfuscation exited with code: " + process.getExitValue());
}
// Log the stdout if requested
if (stdoutBuffer.length() > 0) {
EclipseMECorePlugin.log(IStatus.INFO, stdoutBuffer.toString());
}
// Let the user know that something went wrong if necessary
boolean doFinalPreverify = true;
if (errorText.length() > 0) {
String text = errorText.toString();
IStatus status = new Status(
IStatus.ERROR,
IEclipseMECoreConstants.PLUGIN_ID,
IEclipseMECoreConstants.ERR_OBFUSCATION_ERRORS,
text, null);
Boolean response = (Boolean) EclipseMECorePlugin.statusPrompt(status, this);
doFinalPreverify = (response != null) ? response.booleanValue() : false;
}
if (doFinalPreverify) {
doPostObfuscationPreverification(buildInfo, obfuscatedJarFile, deployedJarFile, monitor);
}
}
writeJADFile(buildInfo, new File(deployedJarFile.getLocation().toFile()), deploymentFolder, false, monitor);
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.doObfuscation");
}
}
/**
* Do the preverification necessary after obfuscation occurs.
*
* @param obfuscatedJar
* @param deployedJarFile
* @param monitor
* @throws CoreException
* @throws IOException
*/
private void doPostObfuscationPreverification(
BuildInfo buildInfo,
IFile obfuscatedJar,
IFile deployedJarFile,
IProgressMonitor monitor)
throws CoreException
{
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.doPostObfuscationPreverification");
BuildConsoleProxy.instance.traceln("- Obfuscated jar: " + obfuscatedJar.getLocation().toFile());
BuildConsoleProxy.instance.traceln("- Deployed jar file: " + deployedJarFile.getLocation().toFile());
}
try {
// Create a temporary directory to handle the preverification
// output
IFolder deployFolder = (IFolder) obfuscatedJar.getParent();
IFolder tempFolder = deployFolder.getFolder("temp");
if (!tempFolder.exists()) tempFolder.create(true, true, monitor);
// Preverify the jar file into the temp directory
BuildConsoleProxy.instance.traceln("Preverifying obfuscated jar into " + tempFolder.getLocation().toFile());
File jarFile = new File(obfuscatedJar.getLocation().toFile());
PreverificationError[] errors =
buildInfo.getMidletSuite().preverifyJarFile(jarFile, tempFolder, monitor);
tempFolder.refreshLocal(IResource.DEPTH_ONE, monitor);
// Check for errors
if (errors.length > 0) {
BuildConsoleProxy.instance.traceln(errors.length + " errors occurred during post-obfuscation preverification");
handlePreverificationErrors(errors);
}
// Copy the result back into the deployment directory
IFile finalJarFile = getJarFile(buildInfo, deployFolder, false);
IFile preverified = tempFolder.getFile(obfuscatedJar.getName());
Utils.copyFile(preverified, finalJarFile);
BuildConsoleProxy.instance.traceln("Copying " + preverified + " to " + finalJarFile.getLocation().toFile());
// Clean up the temp directory
BuildConsoleProxy.instance.traceln("Deleting " + preverified.getLocation().toFile());
preverified.delete(true, monitor);
BuildConsoleProxy.instance.traceln("Deleting " + tempFolder.getLocation().toFile());
tempFolder.delete(true, monitor);
} catch (IOException e) {
EclipseMECorePlugin.throwCoreException(IStatus.ERROR, 999, e);
}
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.doPostObfuscationPreverification");
}
}
/**
* Get the folder into which the jad and jar will be written.
*
* @param monitor
* @return
* @throws CoreException
*/
private IFolder getDeploymentFolder(BuildInfo buildInfo, IProgressMonitor monitor)
throws CoreException
{
return getDeploymentFolder(buildInfo.getMidletSuite().getProject(), monitor);
}
/**
* Get the IFile instance into which the JAR will be
* written.
*
* @return
*/
private IFile getJarFile(
BuildInfo buildInfo,
IFolder deploymentFolder,
boolean obfuscateName)
{
String jarFileName = buildInfo.getMidletSuite().getJarFilename();
if (obfuscateName) {
int length = jarFileName.length();
jarFileName = jarFileName.substring(0, length - 4) + "_base.jar";
}
return deploymentFolder.getFile(jarFileName);
}
/**
* Get the projects that are required by the project being built.
*
* @param javaProject
* @param monitor
* @return
* @throws CoreException
*/
private IJavaProject[] getRequiredProjects(
IJavaProject javaProject,
IProgressMonitor monitor)
throws CoreException
{
RequiredProjectsCPEntryVisitor visitor = new RequiredProjectsCPEntryVisitor();
visitor.getRunner().run(javaProject, visitor, monitor);
ArrayList projects = visitor.getRequiredProjects();
return (IJavaProject[]) projects.toArray(new IJavaProject[projects.size()]);
}
/**
* Return the integer value of the specified component string value.
*
* @param stringValue
* @return
*/
private int getVersionComponentValue(String stringValue) {
int value = 0;
if (stringValue != null) {
try {
value = Integer.parseInt(stringValue);
} catch (NumberFormatException e) { /* Munch */ }
}
return value;
}
/**
* Add text based on the specified error to the string buffer.
*
* @param sb
* @param error
*/
/**
* Handle preverification errors that were encountered
* while obfuscating.
*
* @param errors
* @throws CoreException
*/
private void handlePreverificationErrors(PreverificationError[] errors)
throws CoreException
{
StringBuffer sb = new StringBuffer("Errors preverifying jar\n");
for (int i = 0; i < errors.length; i++) {
if (i != 0) sb.append("\n");
sb.append(PreverificationUtils.getErrorText(errors[i]));
}
EclipseMECorePlugin.throwCoreException(IStatus.ERROR, -999, sb.toString());
}
/**
* Preverify the libraries associated with the current java project
* in the build info.
*
* @param buildInfo
* @param monitor
* @throws CoreException
*/
private void preverifyLibraries(BuildInfo buildInfo, IProgressMonitor monitor)
throws CoreException
{
IProject project = buildInfo.getCurrentJavaProject().getProject();
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.preverifyLibraries project = " + project);
}
if ((project != null) && project.isAccessible()) {
monitor.setTaskName("Preverifying " + project.getName());
// Figure the resource delta to be used
buildInfo.setCurrentResourceDelta(null);
if (buildInfo.getBuildKind() != FULL_BUILD) {
buildInfo.setCurrentResourceDelta(getDelta(project));
}
// Hand off to the build helper for the heavy lifting
ResourceDeltaBuilder deltaBuilder = new ResourceDeltaBuilder(buildInfo);
deltaBuilder.preverifyLibraries(monitor);
monitor.worked(1);
}
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.preverifyLibraries project = " + project);
}
}
/**
* Preverify the project based on the specified build information.
*
* @param buildInfo
* @param monitor
* @throws CoreException
*/
private void preverifyProject(BuildInfo buildInfo, IProgressMonitor monitor)
throws CoreException
{
IProject project = buildInfo.getCurrentJavaProject().getProject();
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.preverifyProject project = " + project);
}
if ((project != null) && project.isAccessible()) {
monitor.setTaskName("Preverifying " + project.getName());
// Figure the resource delta to be used
buildInfo.setCurrentResourceDelta(null);
if (buildInfo.getBuildKind() != FULL_BUILD) {
buildInfo.setCurrentResourceDelta(getDelta(project));
}
// Hand off to the build helper for the heavy lifting
ResourceDeltaBuilder deltaBuilder = new ResourceDeltaBuilder(buildInfo);
deltaBuilder.build(monitor);
}
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.preverifyProject project = " + project);
}
}
/**
* Set the resources in the output directory to
* be derived so they are left alone by the team support.
*
* @param verifiedFolder
* @param monitor
* @throws CoreException
*/
private void setResourcesAsDerived(
IFolder verifiedFolder,
IProgressMonitor monitor)
throws CoreException
{
// Refresh from the folder down so that we can
// set derived on these...
verifiedFolder.refreshLocal(IResource.DEPTH_INFINITE, monitor);
// Get the starting folder
EclipseMECorePlugin.setResourcesAsDerived(verifiedFolder);
}
/**
* Write the JAD file for the jar file into the specified location.
*
* @param buildInfo
* @param targetFolder
* @param monitor
*
* @throws CoreException
* @throws IOException
*/
private void writeJADFile(
BuildInfo buildInfo,
File jarFile,
IFolder targetFolder,
boolean incrementalBuild,
IProgressMonitor monitor)
throws CoreException
{
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.writeJADFile jar = " + jarFile + "; targetFolder = " + targetFolder);
}
DeployedJADWriter writer = new DeployedJADWriter(
buildInfo.getMidletSuite(),
targetFolder,
new java.io.File(jarFile.getAbsolutePath()));
try {
writer.writeDeployedJAD(incrementalBuild, monitor);
} catch (IOException e) {
EclipseMECorePlugin.throwCoreException(IStatus.ERROR, 999, e);
}
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.writeJADFile");
}
}
/**
* Update the JAD version in the manifest properties.
* @throws IOException
* @throws CoreException
*/
private void updateJADVersion(BuildInfo buildInfo, IProgressMonitor monitor)
throws CoreException
{
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("> PreverificationBuilder.updateJADVersion");
}
// Read the source jad file and update the jar file
// length property.
ApplicationDescriptor appDescriptor =
buildInfo.getMidletSuite().getApplicationDescriptor();
ColonDelimitedProperties jadProperties = appDescriptor.getManifestProperties();
// Calculate the updated version string
String versionString =
jadProperties.getProperty(IJADConstants.JAD_MIDLET_VERSION, "0.0.0");
Version version = new Version(versionString);
int major = getVersionComponentValue(version.getMajor());
int minor = getVersionComponentValue(version.getMinor());
int secondary = getVersionComponentValue(version.getSecondary());
if (secondary >= 99) {
secondary = 0;
minor++;
} else {
secondary++;
}
StringBuffer newVersion = new StringBuffer();
newVersion.append(major).append(".").append(minor).append(".").append(secondary);
// Update the JAD
jadProperties.setProperty(IJADConstants.JAD_MIDLET_VERSION, newVersion.toString());
try {
appDescriptor.store();
} catch (IOException e) {
EclipseMECorePlugin.throwCoreException(IStatus.ERROR, 999, e);
}
generateDeployedManifest(buildInfo.getMidletSuite(), monitor);
buildInfo.getMidletSuite().getJadFile().refreshLocal(IResource.DEPTH_ONE, monitor);
if (buildLoggingConfig.isPreverifierTraceEnabled()) {
BuildConsoleProxy.instance.traceln("< PreverificationBuilder.updateJADVersion");
}
}
}
The table below shows all metrics for PreverificationBuilder.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 140.00 | Number of blocks | |
| BLOCK_COMMENT | 3.00 | Number of block comment lines | |
| COMMENTS | 246.00 | Comment lines | |
| COMMENT_DENSITY | 0.46 | Comment density | |
| COMPARISONS | 109.00 | Number of comparison operators | |
| CYCLOMATIC | 132.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 30.00 | Comments in declarations | |
| DOC_COMMENT | 188.00 | Number of javadoc comment lines | |
| ELOC | 537.00 | Effective lines of code | |
| EXEC_COMMENTS | 39.00 | Comments in executable code | |
| EXITS | 147.00 | Procedure exits | |
| FUNCTIONS | 26.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 89.86 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 162.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 | 3.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 | 2.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 | 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 | 9.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 | 1.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 | 11.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 1.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 2.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 | 3.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 3.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 | 7.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 | 1.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 | 9.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 2105.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 | 1.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 | 2.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 | 1.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 | 2.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 | 3.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 | 1076.00 | Number of lines in the source file | |
| LINE_COMMENT | 55.00 | Number of line comments | |
| LOC | 678.00 | Lines of code | |
| LOGICAL_LINES | 339.00 | Number of statements | |
| LOOPS | 9.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 1862.00 | Number of operands | |
| OPERATORS | 3154.00 | Number of operators | |
| PARAMS | 53.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 5016.00 | Halstead program length | |
| PROGRAM_VOCAB | 568.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 109.00 | Number of return points from functions | |
| SIZE | 37766.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 518.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 50.00 | Number of unique operators | |
| WHITESPACE | 152.00 | Number of whitespace lines | |