Utils.java
| Index Score | ||
|---|---|---|
 |
 |
eclipseme.core.internal.utils |
 |
 |
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 |  |
| EXITS | Procedure exits | |
| DECL_COMMENTS | Comments in declarations | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| PARAMS | Number of formal parameter declarations | |
| COMMENTS | Comment lines | |
| RETURNS | Number of return points from functions | |
| LINES | Number of lines in the source file | |
| BLOCKS | Number of blocks | |
| SIZE | Size of the file in bytes | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| CYCLOMATIC | Cyclomatic complexity | |
| LOOPS | Number of loops | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| LOC | Lines of code | |
| ELOC | Effective lines of code | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| LOGICAL_LINES | Number of statements | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| COMPARISONS | Number of comparison operators | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0008 | JAVA0008 Empty catch block | |
| FUNCTIONS | Number of function declarations | |
| JAVA0287 | JAVA0287 Unnecessary null check | |
| LINE_COMMENT | Number of line comments | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| JAVA0160 | JAVA0160 Method does not throw specified exception | |
| JAVA0087 | JAVA0087 Use of Thread.sleep() | |
| JAVA0163 | JAVA0163 Empty statement | |
| NEST_DEPTH | Maximum nesting depth | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
/**
* 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.utils;
import java.io.File;
import java.io.FileFilter;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URL;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
import java.util.zip.ZipOutputStream;
import org.eclipse.core.resources.IContainer;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IWorkspaceRoot;
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.Platform;
import org.eclipse.debug.core.DebugPlugin;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.ILaunchConfigurationType;
import org.eclipse.debug.core.ILaunchConfigurationWorkingCopy;
import org.eclipse.debug.core.ILaunchManager;
import org.eclipse.debug.core.IStreamListener;
import org.eclipse.debug.core.Launch;
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.IClasspathAttribute;
import org.eclipse.jdt.core.IClasspathEntry;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.core.ITypeHierarchy;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.internal.core.BinaryType;
import org.eclipse.jdt.internal.core.JavaModel;
import org.eclipse.jdt.launching.IJavaLaunchConfigurationConstants;
import org.eclipse.osgi.service.datalocation.Location;
import eclipseme.core.IEclipseMECoreConstants;
import eclipseme.core.internal.EclipseMECorePlugin;
/**
* Various utility functions.
* <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.25 $
* <br>
* $Date: 2006/11/26 21:41:57 $
* <br>
* @author Craig Setera
*/
public class Utils {
// TODO This should probably be handled better...
private static final String PRIVATE_CONFIGURATION =
"org.eclipse.debug.ui.private";
// Private default file filter
private static final FileFilter DEFAULT_FILTER = new FileFilter() {
public boolean accept(File pathname) {
// Default is to copy all files
return true;
}
};
// Copy buffer
private static final byte[] buffer = new byte[1024];
// Track whether the file system is case sensitive
private static boolean caseSensitivityChecked;
private static boolean caseSensitiveFileSystem;
/**
* Return a boolean indicating whether the specified paths
* point to the same file.
*
* @param path1
* @param path2
* @return
* @throws CoreException
*/
public static boolean arePathTargetsEqual(IPath path1, IPath path2)
throws CoreException
{
boolean equal = false;
File file1 = getPathTargetFile(path1);
File file2 = getPathTargetFile(path2);
if ((file1 != null) && (file2 != null)) {
equal = file1.equals(file2);
}
return equal;
}
/**
* Clear the specified container of all resources recursively.
*
* @param container
* @param monitor
* @throws CoreException
*/
public static void clearContainer(IContainer container, IProgressMonitor monitor)
throws CoreException
{
if (container.exists()) {
IResource[] resources = container.members();
for (int i = 0; i < resources.length; i++) {
IResource resource = resources[i];
if (resource instanceof IContainer) {
clearContainer((IContainer) resource, monitor);
resource.delete(true, monitor);
} else {
resource.delete(true, monitor);
}
}
}
}
/**
* Copy from the specified source to the specified destination,
* recursively as necessary.
*
* @param source
* @param destination
* @throws IOException
*/
public static void copy(File source, File destination)
throws IOException
{
copy(source, destination, null);
}
/**
* Copy from the specified source to the specified destination,
* recursively as necessary. The file filter will be used to
* determine what files will be copied along the way.
*
* @param source
* @param destination
* @param filter
* @throws IOException
*/
public static void copy(File source, File destination, FileFilter filter)
throws IOException
{
if (source.exists()) {
if (source.isDirectory()) {
copyDirectory(source, destination, filter);
} else {
copyFile(source, destination, filter);
}
}
}
/**
* Copy the specified directory and all of its contents recursively
* to the specified destination.
*
* @param source
* @param destination
* @param filter
* @throws IOException
*/
public static void copyDirectory(File source, File destination, FileFilter filter)
throws IOException
{
if (filter == null) filter = DEFAULT_FILTER;
if (source.exists() && source.isDirectory() && filter.accept(source)) {
destination.mkdirs();
File[] sources = source.listFiles();
for (int i = 0; i < sources.length; i++) {
File newSource = sources[i];
File newDestination = new File(destination, newSource.getName());
if (newSource.isDirectory()) {
copyDirectory(newSource, newDestination, filter);
} else {
copyFile(newSource, newDestination, filter);
}
}
}
}
/**
* Copy the specified source file into the specified target file.
*
* @param sourceFile
* @param targetFile
* @throws IOException
* @throws CoreException
*/
public static void copyFile(IFile sourceFile, IFile targetFile)
throws IOException, CoreException
{
copyFile(
sourceFile.getLocation().toFile(),
targetFile.getLocation().toFile(),
null);
}
/**
* Copy the specified source file into the specified target file.
*
* @param sourceFile
* @param targetFile
* @param filter
* @throws IOException
*/
public static void copyFile(File sourceFile, File targetFile, FileFilter filter)
throws IOException
{
if (filter == null) filter = DEFAULT_FILTER;
if (filter.accept(sourceFile)) {
FileInputStream fis = new FileInputStream(sourceFile);
FileOutputStream fos = new FileOutputStream(targetFile);
copyInputToOutput(fis, fos);
fis.close();
fos.close();
}
}
/**
* Copy the contents of the input to the output stream.
*
* @param input
* @param output
* @throws IOException
*/
public static void copyInputToOutput(InputStream input, OutputStream output)
throws IOException
{
int bytesRead = 0;
do {
bytesRead = input.read(buffer, 0, buffer.length);
if (bytesRead > 0) {
output.write(buffer, 0, bytesRead);
}
} while (bytesRead != -1);
output.flush();
}
/**
* Create a new zip archive with the contents specified by the source folder.
*
* @param tgtArchiveFile
* @param srcFolder
* @throws IOException
*/
public static void createArchive(File tgtArchiveFile, File srcFolder)
throws IOException
{
if (srcFolder.exists() && srcFolder.isDirectory()) {
ZipOutputStream zos = new ZipOutputStream(new FileOutputStream(tgtArchiveFile));
try {
addFolderToArchive(zos, srcFolder.getAbsolutePath().length() + 1, srcFolder);
} finally {
if (zos != null) {
try { zos.close(); } catch (IOException e) {}
}
}
}
}
/**
* Delete the specified file, recursively as necessary.
*
* @param file
*/
public static void delete(File file) {
if (file.exists()) {
if (file.isDirectory()) {
File[] files = file.listFiles();
for (int i = 0; i < files.length; i++) {
delete(files[i]);
}
}
file.delete();
}
}
/**
* If the system property "eclipseme.dump.launch" is set to "true",
* dump the command line that was used to launch the emulator.
*/
public static void dumpCommandLine(ILaunch launch) {
// Search for the process command-line
IProcess[] processes = launch.getProcesses();
if ((processes != null) && (processes.length > 0)) {
IProcess process = processes[0];
if (process != null) {
String commandLine = process.getAttribute(IProcess.ATTR_CMDLINE);
dumpCommandLine(commandLine);
}
}
}
/**
* If the system property "eclipseme.dump.launch" is set to "true",
* dump the command line that was used to launch the emulator.
*
* @param commandLine
*/
public static void dumpCommandLine(String commandLine) {
// Pull the dump choice from system properties
String propValue =
System.getProperty(IEclipseMECoreConstants.PROP_DUMP_LAUNCH, "false");
boolean doDump = propValue.equalsIgnoreCase("TRUE");
// Only do this if requested
if (doDump) {
// Let the user know what happened via the log file
String text = (commandLine == null) ?
"Command line not found" :
"Command line: " + commandLine;
EclipseMECorePlugin.log(IStatus.INFO, text);
// if (commandLine != null) {
// EclipseMECorePlugin.log(IStatus.INFO, "" + commandLine.length());
// }
}
}
/**
* If the system property "eclipseme.dump.launch" is set to "true",
* dump the command line that was used to launch the emulator.
*
* @param commandLine
*/
public static void dumpCommandLine(String[] commandLine) {
StringBuffer sb = new StringBuffer();
for (int i = 0; i < commandLine.length; i++) {
String string = commandLine[i];
if (i != 0) sb.append(' ');
sb.append(string);
}
dumpCommandLine(sb.toString());
}
/**
* Exec a new process via the debug plugin.
*
* @param commandLine
* @param workingDirectory
* @param env The environment to be used or <code>null</code>
* to take the default.
* @return
* @throws CoreException
*/
public static Process exec(String[] commandLine, File workingDirectory, String[] env)
throws CoreException
{
return DebugPlugin.exec(commandLine, workingDirectory, env);
}
/**
* Test if the specified executable file exist. Add a ".exe"
* if necessary to handle Windows systems.
*
* @param executableFile
* @return
*/
public static boolean executableExists(File executableFile) {
File winExecutable = new File(
executableFile.getParentFile(),
executableFile.getName() + ".exe");
return
executableFile.exists() ||
winExecutable.exists();
}
/**
* Extract the archive specified by the file into the provided directory.
*
* @param jarFile
* @param tgtDirectory
* @throws IOException
*/
public static void extractArchive(File jarFile, File tgtDirectory)
throws IOException
{
ZipInputStream zis = new ZipInputStream(new FileInputStream(jarFile));
try {
ZipEntry entry = null;
while ((entry = zis.getNextEntry()) != null) {
if (entry.isDirectory()) {
File directory = new File(tgtDirectory, entry.getName());
directory.mkdirs();
} else {
File file = new File(tgtDirectory, entry.getName());
file.getParentFile().mkdirs();
FileOutputStream fos = new FileOutputStream(file);
try {
Utils.copyInputToOutput(zis, fos);
} finally {
if (fos != null) {
try { fos.close(); } catch (IOException e) {}
}
}
}
}
} finally {
try { zis.close(); } catch (IOException e) {}
}
}
/**
* Extract the class name from the specified
* IResource within the specified java project.
*
* @param javaProject the java project to provide the relative name
* @param resource the resource to extract a class name
* @return the class name or <code>null</code> if the resource
* name cannot be converted for some reason.
* @throws JavaModelException
*/
public static String extractClassName(
IJavaProject javaProject,
IResource resource)
throws JavaModelException
{
IPath classPath = extractsSourceFolderRelativePath(javaProject, resource);
return (classPath == null) ? null :
classPath.removeFileExtension().toString().replace('/', '.');
}
/**
* Extract the class path from the specified
* IResource within the specified java project.
*
* @param javaProject
* @param resource
* @return the extracted resource path
* @throws JavaModelException
*/
public static IPath extractsSourceFolderRelativePath(
IJavaProject javaProject,
IResource resource)
throws JavaModelException
{
IPath resultPath = null;
IPath projectOutputPath =
javaProject.getOutputLocation().makeAbsolute();
IPath resourcePath = resource.getFullPath();
IClasspathEntry[] classpath = javaProject.getRawClasspath();
for (int i = 0; i < classpath.length; i++) {
IClasspathEntry entry = classpath[i];
if (entry.getEntryKind() == IClasspathEntry.CPE_SOURCE) {
IPath entryPath = entry.getOutputLocation();
entryPath = (entryPath == null) ?
projectOutputPath : entryPath.makeAbsolute();
if (entryPath.isPrefixOf(resourcePath)) {
resultPath =
resourcePath.removeFirstSegments(entryPath.segmentCount());
}
}
}
return resultPath;
}
/**
* Return the Javadoc classpath attribute or <code>null</code> if none
* is attached.
*
* @return
*/
public static IClasspathAttribute getJavadocAttribute(IClasspathEntry entry) {
int index = getJavadocAttributeIndex(entry);
return (index == -1) ? null : entry.getExtraAttributes()[index];
}
/**
* Return the Javadoc classpath attribute index or <code>-1</code> if none
* is attached.
*
* @return
*/
public static int getJavadocAttributeIndex(IClasspathEntry entry) {
int index = -1;
IClasspathAttribute[] attributes = entry.getExtraAttributes();
for (int i = 0; i < attributes.length; i++) {
IClasspathAttribute attribute = attributes[i];
if (attribute.getName().equals(IClasspathAttribute.JAVADOC_LOCATION_ATTRIBUTE_NAME)) {
index = i;
break;
}
}
return index;
}
/**
* Get a new launch instance with the specified configuration
* name.
*
* @param configName
* @return
* @throws CoreException
*/
public static ILaunch getNewLaunch(String configName)
throws CoreException
{
return new Launch(
getNewLaunchConfiguration(configName),
ILaunchManager.RUN_MODE,
null);
}
/**
* Get the launch configuration to be used in building
* the ILaunch instance.
*/
public static ILaunchConfiguration getNewLaunchConfiguration(String name)
throws CoreException
{
ILaunchManager launchManager =
DebugPlugin.getDefault().getLaunchManager();
ILaunchConfigurationType configType =
launchManager.getLaunchConfigurationType(
IJavaLaunchConfigurationConstants.ID_JAVA_APPLICATION);
ILaunchConfigurationWorkingCopy config =
configType.newInstance(null, name);
config.setAttribute(PRIVATE_CONFIGURATION, true);
return config;
}
/**
* Return the resource that is resolved for the specified path.
* This will return one of three things:
* <ul>
* <li>An instance of org.eclipse.core.resources.IResource if the entry refers to a workspace resource.</li>
* <li>An instance of java.io.File if the entry refers to a non-workspace resource.</li>
* <li><code>null</code> if the entry points to a non-existent resource.</li>
* </ul>
*
* @param path the path to look for an object
* @return the resolved object
*/
public static Object getPathTarget(IPath path) {
Object target = null;
IWorkspaceRoot root = EclipseMECorePlugin.getWorkspace().getRoot();
target = root.findMember(path);
if (target == null) {
File externalFile = new File(path.toOSString());
if ((externalFile != null) && (externalFile.isFile())) {
target = externalFile;
} else {
target = null;
}
}
return target;
}
/**
* Return the java.io.File instance referenced by the specified path
* or <code>null</code> if no such file exists.
*
* @param entry
* @return
* @throws CoreException
*/
public static File getPathTargetFile(IPath path)
throws CoreException
{
File entryFile = null;
Object pathTarget = getPathTarget(path);
if (pathTarget instanceof IResource) {
entryFile = ((IResource) pathTarget).getLocation().toFile();
} else if (pathTarget instanceof File) {
entryFile = (File) pathTarget;
}
return entryFile;
}
/**
* Attempt to retrieve the fully-qualified class name.
*
* @param type
* @return
*/
public static String getQualifiedClassName(IType type) {
String classname = null;
if (type instanceof BinaryType) {
classname = getQualifiedClassName((BinaryType) type);
} else {
classname = type.getFullyQualifiedName();
}
return classname;
}
/**
* Return the resource that is resolved for the specified classpath
* entry. This will return one of three things:
* <ul>
* <li>An instance of org.eclipse.core.resources.IResource if the entry refers to a workspace resource.</li>
* <li>An instance of java.io.File if the entry refers to a non-workspace resource.</li>
* <li><code>null</code> if the entry points to a non-existent resource.</li>
* </ul>
*
* @param entry the entry to be resolved
* @return the resolved object
*/
public static Object getResolvedClasspathEntry(IClasspathEntry entry) {
IClasspathEntry resolved = JavaCore.getResolvedClasspathEntry(entry);
return getPathTarget(resolved.getPath());
}
/**
* Return the java.io.File instance referenced by the specified classpath
* entry or <code>null</code> if no such file exists.
*
* @param entry
* @return
* @throws CoreException
*/
public static final File getResolvedClasspathEntryFile(IClasspathEntry entry)
throws CoreException
{
IClasspathEntry resolved = JavaCore.getResolvedClasspathEntry(entry);
return getPathTargetFile(resolved.getPath());
}
/**
* Launch the specified command line and return the output from
* the standard output.
*
* @param name
* @param commandLine
* @return
* @throws CoreException
*/
public static String getStandardOutput(String name, String[] commandLine)
throws CoreException
{
return getStandardOutput(name, commandLine, null);
}
/**
* Launch the specified command line and return the output from
* the standard output.
*
* @param name
* @param commandLine
* @return
* @throws CoreException
*/
public static String getStandardOutput(String name, String[] commandLine, File workingDirectory)
throws CoreException
{
IProcess process =
Utils.launchApplication(commandLine, workingDirectory, null, name, name);
// Listen on the process output streams
IStreamsProxy proxy = process.getStreamsProxy();
// Wait until completion
while (!process.isTerminated()) {
try { Thread.sleep(1000); } catch (InterruptedException e) {};
}
return proxy.getOutputStreamMonitor().getContents();
}
/**
* This class is used as part of monitoring process output in the
* #getProcessOutput method. It monitors output from the process
* (either stdout or stderr) and appends the results to the
* specified <code>StringBuffer</code>. The listener approach
* prevents a process from stalling because output blocks.
*/
private static class StreamListener implements IStreamListener
{
private StringBuffer buf;
public StreamListener(StringBuffer buf)
{
this.buf = buf;
}
public void streamAppended(String text, IStreamMonitor monitor)
{
if (buf != null)
{
buf.append(text);
}
}
}
/**
* Execute a process and collect its stdout and stderr.
*
* @param name Name of the process for display purposes
* @param commandLine Array of <code>String</code>s that provides the command line.
* The first entry in the array is the executable.
* @param stdout <code>StringBuffer</code> to which the process' stdout will
* be appended. May be <code>null</code>.
* @param stderr <code>StringBuffer</code> to which the process' stderr will
* be appended. May be <code>null</code>.
* @return The exit value of the process.
* @throws CoreException
*/
public static int getProcessOutput(String name, String[] commandLine, StringBuffer stdout, StringBuffer stderr)
throws CoreException
{
IProcess process = Utils.launchApplication(commandLine, null, null, name, name);
// Listen on the process output streams
IStreamsProxy proxy = process.getStreamsProxy();
proxy.getOutputStreamMonitor().addListener(new StreamListener(stdout));
proxy.getErrorStreamMonitor().addListener(new StreamListener(stderr));
// Wait until completion
while (!process.isTerminated())
{
try
{
Thread.sleep(1000); // sleep for one second
}
catch (InterruptedException e)
{
}
}
return(process.getExitValue());
}
/**
* Return a boolean indicating whether the host file system
* appears to be case sensitive.
*
* @return case sensitivity of the host file system
*/
public static boolean isFileSystemCaseSensitive() {
if (!caseSensitivityChecked) {
caseSensitivityChecked = true;
Location location = Platform.getInstallLocation();
if (location != null) {
URL url = location.getURL();
if (url != null) {
String urlString = url.toString();
if (urlString.startsWith("file:/")) {
urlString = urlString.substring("file:/".length()).toUpperCase();
caseSensitiveFileSystem = !(new File(urlString)).exists();
}
}
}
}
return caseSensitiveFileSystem;
}
/**
* Return a boolean indicating whether the specified type is a Midlet
* subclass.
*
* @param type
* @return
*/
public static boolean isMidlet(IType type, IProgressMonitor monitor)
throws JavaModelException
{
boolean isMidlet = false;
if (type != null) {
IJavaProject javaProject = type.getJavaProject();
if (!type.exists() && type.isBinary()) {
// A binary type, which won't help much... Attempt to convert
// to a source type and use that to do the lookup
String classname = getQualifiedClassName(type);
if (classname != null) {
IType sourceType = javaProject.findType(classname);
isMidlet = isMidlet(sourceType, monitor);
}
} else {
ITypeHierarchy typeHierarchy = type.newSupertypeHierarchy(monitor);
IType midletType =
javaProject.findType(IEclipseMECoreConstants.MIDLET_SUPERCLASS);
isMidlet =
(midletType != null) &&
typeHierarchy.contains(midletType);
}
}
return isMidlet;
}
/**
* Launch a new application and return the IProcess
* representing the application.
*
* @param commandLine
* @param workingDirectory
* @param environment
* @param configName
* @param label
* @return
* @throws CoreException
*/
public static IProcess launchApplication(
String[] commandLine,
File workingDirectory,
String[] environment,
String configName,
String label)
throws CoreException
{
// Execute the process.
Process execProcess = exec(commandLine, workingDirectory, environment);
// Wrap it up in a JDT IProcess instance
Launch launch = new Launch(
getNewLaunchConfiguration(configName),
ILaunchManager.RUN_MODE,
null);
IProcess process = DebugPlugin.newProcess(launch, execProcess, label);
Utils.dumpCommandLine(commandLine);
return process;
}
/**
* Add the contents of the specified folder to the archive being
* created.
*
* @param zos
* @param prefixLength
* @param srcFolder
* @throws IOException
*/
private static void addFolderToArchive(ZipOutputStream zos, int prefixLength, File srcFolder)
throws IOException
{
File[] files = srcFolder.listFiles();
for (int i = 0; i < files.length; i++) {
File file = files[i];
if (file.isDirectory()) {
addFolderToArchive(zos, prefixLength, file);
} else {
addFileEntryToArchive(zos, prefixLength, file);
}
}
}
/**
* Add the specified file as an entry to the archive output stream.
*
* @param zos
* @param prefixLength
* @param file
* @throws IOException
*/
private static void addFileEntryToArchive(ZipOutputStream zos, int prefixLength, File file)
throws IOException
{
// Create a new zip entry
ZipEntry entry = getEntryForFile(file, prefixLength);
zos.putNextEntry(entry);
// Write the contents for the new zip entry
FileInputStream fis = new FileInputStream(file);
try {
copyInputToOutput(fis, zos);
} finally {
zos.closeEntry();
if (fis != null) {
try { fis.close(); } catch (IOException e) {}
}
}
}
/**
* @param file
* @param prefixLength
* @return
*/
private static ZipEntry getEntryForFile(File file, int prefixLength) {
String fileString = file.getAbsolutePath();
String entryName = fileString.substring(prefixLength).replace('\\', '/');
ZipEntry entry = new ZipEntry(entryName);
entry.setSize(file.length());
entry.setTime(file.lastModified());
return entry;
}
/**
* Private constructor
*/
private Utils() {
super();
}
/**
* Attempt to retrieve the fully-qualified class name.
*
* @param type
* @return
*/
private static String getQualifiedClassName(BinaryType type) {
IJavaElement javaElement = type.getPackageFragment();
StringBuffer name = new StringBuffer(type.getElementName());
while (javaElement.getElementType() != IJavaElement.JAVA_PROJECT) {
String elementName = javaElement.getElementName();
if ((elementName != null) && (elementName.length() > 0)) {
name.insert(0, '.').insert(0, elementName);
}
javaElement = javaElement.getParent();
}
return name.toString();
}
}
The table below shows all metrics for Utils.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 118.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 342.00 | Comment lines | |
| COMMENT_DENSITY | 0.87 | Comment density | |
| COMPARISONS | 66.00 | Number of comparison operators | |
| CYCLOMATIC | 111.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 45.00 | Comments in declarations | |
| DOC_COMMENT | 320.00 | Number of javadoc comment lines | |
| ELOC | 392.00 | Effective lines of code | |
| EXEC_COMMENTS | 17.00 | Comments in executable code | |
| EXITS | 119.00 | Procedure exits | |
| FUNCTIONS | 41.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 78.32 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 157.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 | 6.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 | 3.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 | 1.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 | 1.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 | 1.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 | 2.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 | 7.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 1.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 | 0.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 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 1.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 1.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 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 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1659.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 | 2.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 | 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 | 5.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 | 4.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 957.00 | Number of lines in the source file | |
| LINE_COMMENT | 22.00 | Number of line comments | |
| LOC | 519.00 | Lines of code | |
| LOGICAL_LINES | 234.00 | Number of statements | |
| LOOPS | 12.00 | Number of loops | |
| NEST_DEPTH | 7.00 | Maximum nesting depth | |
| OPERANDS | 1220.00 | Number of operands | |
| OPERATORS | 2164.00 | Number of operators | |
| PARAMS | 73.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3384.00 | Halstead program length | |
| PROGRAM_VOCAB | 457.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 84.00 | Number of return points from functions | |
| SIZE | 26868.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 405.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 52.00 | Number of unique operators | |
| WHITESPACE | 96.00 | Number of whitespace lines | |