FileUtils.java
| Index Score | ||
|---|---|---|
 |
 |
phex.utils |
 |
 |
Phex |
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 |  |
| JAVA0081 | JAVA0081 Boolean literal in comparison | |
| JAVA0284 | JAVA0284 Explicit garbage collection | |
| RETURNS | Number of return points from functions | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| LINE_COMMENT | Number of line comments | |
| SIZE | Size of the file in bytes | |
| BLOCKS | Number of blocks | |
| LOC | Lines of code | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LINES | Number of lines in the source file | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| COMMENTS | Comment lines | |
| CYCLOMATIC | Cyclomatic complexity | |
| COMPARISONS | Number of comparison operators | |
| OPERATORS | Number of operators | |
| EXITS | Procedure exits | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| DOC_COMMENT | Number of javadoc comment lines | |
| PROGRAM_LENGTH | Halstead program length | |
| PARAMS | Number of formal parameter declarations | |
| ELOC | Effective lines of code | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| OPERANDS | Number of operands | |
| LOGICAL_LINES | Number of statements | |
| LOOPS | Number of loops | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| UNIQUE_OPERANDS | Number of unique operands | |
| DECL_COMMENTS | Comments in declarations | |
| PROGRAM_VOLUME | Halstead program volume | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0087 | JAVA0087 Use of Thread.sleep() | |
| WHITESPACE | Number of whitespace lines | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* PHEX - The pure-java Gnutella-servent.
* Copyright (C) 2001 - 2008 Phex Development Group
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* --- SVN Information ---
* $Id: FileUtils.java 4219 2008-07-02 09:06:13Z gregork $
*/
package phex.utils;
import java.io.*;
import phex.common.FileHandlingException;
import phex.common.log.NLogger;
/**
* Offers static utility methods for file handling, like creating file path...
*/
public final class FileUtils
{
private static final int BUFFER_LENGTH = 256 * 1024;
/**
* Don't create any instance!
*/
private FileUtils()
{
}
public static String getFileExtension( File file )
{
String name = file.getName();
return getFileExtension(name);
}
public static String getFileExtension( String fileName )
{
int idx = fileName.lastIndexOf( '.' );
if ( idx == -1 )
{
return "";
}
else
{
return fileName.substring(idx + 1);
}
}
public static String replaceFileExtension( String fileName, String newExtension )
{
int idx = fileName.lastIndexOf( '.' );
if ( idx == -1 )
{
return fileName + "." + newExtension;
}
else
{
return fileName.substring(0, idx + 1) + newExtension;
}
}
/**
* Since we are only supporting J2SE 1.2 and J2SE is not available on
* MACOS 9 and MACOS X is supporting 255 characters we are shorting only
* for 255 on MAC.
*
* MACOS X filename: 255
* Windows pathlength: 260
* filelength: 255
*/
public static String convertToLocalSystemFilename(String filename)
{
// we generally cut of at 255 it will suit everybody and we have no
// os comparing stuff to do....
// TODO we need to improve things here to keep up with the window pathlength
// handling... but for now we just help the mac guys..
// replace all possible invalid filename characters with _
filename = StringUtils.replaceChars( filename, "\\/:*?\"<>|", '_' );
return filename.substring( 0, Math.min( 255, filename.length() ) );
/*if ( OS_NAME.indexOf("MAC") != -1)
{
return makeShortName(filename, 255);
}
else
{
return filename;
}*/
}
/**
* Appends the fileToAppend on the destination file. The file that is appended
* will be removed afterwards.
*/
public static void appendFile( File destination, File fileToAppend )
throws IOException
{
long destFileLength = destination.length();
long appendFileLength = fileToAppend.length();
// open files
FileInputStream inStream = new FileInputStream( fileToAppend );
try
{
RandomAccessFile destFile = new RandomAccessFile( destination, "rwd" );
try
{
// extend file length... this causes dramatical performance boost since
// contents is streamed into already freed space.
destFile.setLength( destFileLength + appendFileLength );
destFile.seek( destFileLength );
byte[] buffer = new byte[ (int)Math.min( BUFFER_LENGTH, appendFileLength ) ];
int length;
while ( -1 != (length = inStream.read(buffer)) )
{
long start2 = System.currentTimeMillis();
destFile.write( buffer, 0, length );
long end2 = System.currentTimeMillis();
try
{
Thread.sleep( (end2 - start2) * 2 );
}
catch ( InterruptedException exp )
{
// reset interrupted flag
Thread.currentThread().interrupt();
return;
}
}
}
finally
{
destFile.close();
IOUtil.closeQuietly( destFile );
}
}
finally
{
IOUtil.closeQuietly( inStream );
}
FileUtils.deleteFileMultiFallback( fileToAppend );
}
/**
* Copys the source file to the destination file. Old contents of the
* destination file will be overwritten.
* This is a optimized version of the org.apache.commons.io.FileUtils.copy
* source, with larger file buffer for a faster copy process.
*/
public static void copyFile( File source, File destination )
throws IOException
{
copyFile( source, destination, source.length() );
if (source.length() != destination.length())
{
String message = "Failed to copy full contents from " + source
+ " to " + destination + " - " + source.length() + "/" + destination.length();
throw new IOException(message);
}
}
/**
* Copys the source file to the destination file. Old contents of the
* destination file will be overwritten.
* This is a optimized version of the org.apache.commons.io.FileUtils.copy
* source, with larger file buffer for a faster copy process.
*/
public static void copyFile( File source, File destination, long copyLength )
throws IOException
{
// check source exists
if (!source.exists())
{
String message = "File " + source + " does not exist";
throw new FileNotFoundException(message);
}
//does destinations directory exist ?
if (destination.getParentFile() != null
&& !destination.getParentFile().exists())
{
destination.getParentFile().mkdirs();
}
//make sure we can write to destination
if (destination.exists() && !destination.canWrite())
{
String message = "Unable to open file " + destination
+ " for writing.";
throw new IOException(message);
}
//makes sure it is not the same file
if (source.getCanonicalPath().equals(destination.getCanonicalPath()))
{
String message = "Unable to write file " + source + " on itself.";
throw new IOException(message);
}
if ( copyLength == 0 )
{
truncateFile( destination, 0 );
}
FileInputStream input = null;
FileOutputStream output = null;
try
{
input = new FileInputStream(source);
output = new FileOutputStream(destination);
long lengthLeft = copyLength;
byte[] buffer = new byte[(int) Math.min(BUFFER_LENGTH,
lengthLeft + 1)];
int read;
while ( lengthLeft > 0 )
{
read = input.read(buffer);
if ( read == -1 )
{
break;
}
lengthLeft -= read;
output.write(buffer, 0, read);
}
output.flush();
output.getFD().sync();
}
finally
{
IOUtil.closeQuietly(input);
IOUtil.closeQuietly(output);
}
//file copy should preserve file date
destination.setLastModified(source.lastModified());
}
/**
* Splits the source file at the splitpoint into the destination file.
* The result will be the source file containing data to the split point and
* the destination file containing the data from the split point to the end
* of the file.
* @param source the source file to split.
* @param destination the destination file to split into.
* @param splitPoint the split point byte position inside the file.
* When the file size is 10 and the splitPoint is 3 the source file will contain
* the first 3 bytes while the destination file will contain the last 7 bytes.
* @throws IOException in case of a IOException during split operation.
*/
public static void splitFile( File source, File destination, long splitPoint )
throws IOException
{
// open files
RandomAccessFile sourceFile = new RandomAccessFile( source, "rws" );
try
{
FileOutputStream outStream = new FileOutputStream( destination );
try
{
sourceFile.seek( splitPoint );
byte[] buffer = new byte[ (int)Math.min( BUFFER_LENGTH, source.length() + 1) ];
int length;
while ( -1 != (length = sourceFile.read(buffer)) )
{
outStream.write( buffer, 0, length );
}
sourceFile.setLength( splitPoint );
}
finally
{
IOUtil.closeQuietly(outStream);
}
}
finally
{
IOUtil.closeQuietly(sourceFile);
}
}
/**
* This method performce a multi fallback file rename operation to try to
* work around the Java problems with rename operations.
* http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6213298
* @throws FileHandlingException
*/
public static void renameFileMultiFallback( File sourceFile, File destFile )
throws FileHandlingException
{
if ( destFile.exists() )
{
// cant rename to file that already exists
throw new FileHandlingException(
FileHandlingException.FILE_ALREADY_EXISTS );
}
if ( !sourceFile.exists() )
{
return;
}
boolean succ = sourceFile.renameTo( destFile );
if ( succ )
{
NLogger.warn( FileUtils.class, "First renameTo operation worked!" );
return;
}
NLogger.warn( FileUtils.class, "First renameTo operation failed." );
// Try to run garbage collector to make the file rename operation work
System.gc();
// Yield thread and to hope GC kicks in...
Thread.yield();
// Try rename again...
succ = sourceFile.renameTo( destFile );
if ( succ )
{
return;
}
NLogger.warn( FileUtils.class, "Second renameTo operation failed." );
// Rename failed again... just perform a slow copy/delete operation
FileInputStream input = null;
FileOutputStream output = null;
try
{
input = new FileInputStream(sourceFile);
output = new FileOutputStream(destFile);
long lengthLeft = sourceFile.length();
byte[] buffer = new byte[(int) Math.min(BUFFER_LENGTH,
lengthLeft + 1)];
int read;
while ( lengthLeft > 0 )
{
read = input.read(buffer);
if ( read == -1 )
{
break;
}
lengthLeft -= read;
output.write(buffer, 0, read);
}
}
catch ( IOException exp )
{
NLogger.warn( FileUtils.class, "Third renameTo operation failed." );
throw new FileHandlingException(
FileHandlingException.RENAME_FAILED, exp );
}
finally
{
IOUtil.closeQuietly(input);
IOUtil.closeQuietly(output);
}
//file copy should preserve file date
destFile.setLastModified(sourceFile.lastModified());
// try to delete file
FileUtils.deleteFileMultiFallback( sourceFile );
}
/**
* This method performce a multi fallback file delete operation to try to
* work around the Java problems with delete operations.
* http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6213298
* @param file the file to delete.
*/
public static void deleteFileMultiFallback( File file )
{
boolean succ = file.delete();
if ( succ )
{
return;
}
NLogger.warn( FileUtils.class, "First delete operation failed." );
// Try to run garbage collector to make the file delete operation work
System.gc();
// Yield thread and to hope GC kicks in...
Thread.yield();
// Try again...
succ = file.delete( );
if ( succ )
{
return;
}
NLogger.warn( FileUtils.class, "Second delete operation failed." );
// Last chance... try to delete on exit...
file.deleteOnExit();
// and truncate file to at least free up the space...
try
{
FileUtils.truncateFile( file, 0 );
}
catch ( IOException exp )
{
NLogger.warn( FileUtils.class, "Delete/truncate operation failed." );
}
}
/**
* Truncates an input file to the requested size. If the file doesnt exists
* or is of equal or smaller size noting is done.
*
* @param file The file to truncate.
* @param size The size to truncate to.
* @throws IOException in case an IO error occures during truncating.
*/
public static void truncateFile( File file, long size )
throws IOException
{
if ( size < 0 )
{
throw new IllegalArgumentException( "File size < 0: " + size );
}
if ( file.exists()
&& file.length() > size )
{
RandomAccessFile raf = null;
try
{
raf = new RandomAccessFile( file, "rws" );
raf.setLength( size );
}
finally
{
IOUtil.closeQuietly(raf);
}
}
}
/**
* Checks if subDir is a sub directory of maybeParentDir.
*/
public static boolean isChildOfDir( File maybeChild, File maybeParentDir )
{
// it can't be a sub dir if they don't start the same way...
if ( !maybeChild.getAbsolutePath().startsWith( maybeParentDir.getAbsolutePath() ) )
{
return false;
}
return isChildOfDirInternal( maybeChild, maybeParentDir );
}
/**
* Checks if subDir is a sub directory of maybeParentDir. Used for internal
* processing.
*/
private static boolean isChildOfDirInternal( File maybeChild, File maybeParentDir )
{
File parent = maybeChild.getParentFile();
// no parent dir... cant be sub
if ( parent == null )
{
return false;
}
// parent equals we have a sub dir
if ( parent.equals( maybeParentDir ) )
{
return true;
}
// go up one level and check again
return isChildOfDirInternal( parent, maybeParentDir );
}
/**
* From Apache Jakarta Commons IO.
*
* Copies a whole directory to a new location.
* <p>
* This method copies the contents of the specified source directory
* to within the specified destination directory.
* <p>
* The destination directory is created if it does not exist.
* If the destination directory did exist, then this method merges
* the source with the destination, with the source taking precedence.
*
* @param srcDir an existing directory to copy, must not be null
* @param destDir the new directory, must not be null
* @param preserveFileDate true if the file date of the copy
* should be the same as the original
*
* @throws NullPointerException if source or destination is null
* @throws IOException if source or destination is invalid
* @throws IOException if an IO error occurs during copying
* @since Commons IO 1.1
*/
public static void copyDirectory(File srcDir, File destDir,
boolean preserveFileDate) throws IOException {
if (srcDir == null) {
throw new NullPointerException("Source must not be null");
}
if (destDir == null) {
throw new NullPointerException("Destination must not be null");
}
if (srcDir.exists() == false) {
throw new FileNotFoundException("Source '" + srcDir + "' does not exist");
}
if (srcDir.isDirectory() == false) {
throw new IOException("Source '" + srcDir + "' exists but is not a directory");
}
if (srcDir.getCanonicalPath().equals(destDir.getCanonicalPath())) {
throw new IOException("Source '" + srcDir + "' and destination '" + destDir + "' are the same");
}
doCopyDirectory(srcDir, destDir, preserveFileDate);
}
/**
* From Apache Jakarta Commons IO.
*
* Internal copy directory method.
*
* @param srcDir the validated source directory, not null
* @param destDir the validated destination directory, not null
* @param preserveFileDate whether to preserve the file date
* @throws IOException if an error occurs
* @since Commons IO 1.1
*/
private static void doCopyDirectory(File srcDir, File destDir, boolean preserveFileDate)
throws IOException
{
if (destDir.exists())
{
if (destDir.isDirectory() == false)
{
throw new IOException("Destination '" + destDir + "' exists but is not a directory");
}
}
else
{
if (destDir.mkdirs() == false)
{
throw new IOException("Destination '" + destDir + "' directory cannot be created");
}
if (preserveFileDate)
{
destDir.setLastModified(srcDir.lastModified());
}
}
if (destDir.canWrite() == false)
{
throw new IOException("Destination '" + destDir + "' cannot be written to");
}
// recurse
File[] files = srcDir.listFiles();
if (files == null)
{ // null if security restricted
throw new IOException("Failed to list contents of " + srcDir);
}
for (int i = 0; i < files.length; i++)
{
File copiedFile = new File(destDir, files[i].getName());
if (files[i].isDirectory())
{
doCopyDirectory(files[i], copiedFile, preserveFileDate);
}
else
{
doCopyFile(files[i], copiedFile, preserveFileDate);
}
}
}
/**
* From Apache Jakarta Commons IO.
*
* Internal copy file method.
*
* @param srcFile the validated source file, not null
* @param destFile the validated destination file, not null
* @param preserveFileDate whether to preserve the file date
* @throws IOException if an error occurs
*/
private static void doCopyFile(File srcFile, File destFile, boolean preserveFileDate)
throws IOException
{
if (destFile.exists() && destFile.isDirectory())
{
throw new IOException("Destination '" + destFile + "' exists but is a directory");
}
FileInputStream input = new FileInputStream(srcFile);
try
{
FileOutputStream output = new FileOutputStream(destFile);
try
{
byte[] buffer = new byte[BUFFER_LENGTH];
int n = 0;
while (-1 != (n = input.read(buffer)))
{
output.write(buffer, 0, n);
}
}
finally
{
IOUtil.closeQuietly(output);
}
}
finally
{
IOUtil.closeQuietly(input);
}
if (srcFile.length() != destFile.length())
{
throw new IOException("Failed to copy full contents from '" +
srcFile + "' to '" + destFile + "'");
}
if (preserveFileDate)
{
destFile.setLastModified(srcFile.lastModified());
}
}
/**
* Recursively delete a directory.
*
* @param directory directory to delete
* @throws IOException in case deletion is unsuccessful
*/
public static void deleteDirectory(File directory)
throws IOException {
if (!directory.exists()) {
return;
}
cleanDirectory(directory);
if (!directory.delete()) {
String message =
"Unable to delete directory " + directory + ".";
throw new IOException(message);
}
}
/**
* Clean a directory without deleting it.
*
* @param directory directory to clean
* @throws IOException in case cleaning is unsuccessful
*/
public static void cleanDirectory(File directory) throws IOException {
if (!directory.exists()) {
String message = directory + " does not exist";
throw new IllegalArgumentException(message);
}
if (!directory.isDirectory()) {
String message = directory + " is not a directory";
throw new IllegalArgumentException(message);
}
File[] files = directory.listFiles();
if (files == null) { // null if security restricted
throw new IOException("Failed to list contents of " + directory);
}
IOException exception = null;
for (int i = 0; i < files.length; i++) {
File file = files[i];
try {
forceDelete(file);
} catch (IOException ioe) {
exception = ioe;
}
}
if (null != exception) {
throw exception;
}
}
/**
* Delete a file. If file is a directory, delete it and all sub-directories.
* <p>
* The difference between File.delete() and this method are:
* <ul>
* <li>A directory to be deleted does not have to be empty.</li>
* <li>You get exceptions when a file or directory cannot be deleted.
* (java.io.File methods returns a boolean)</li>
* </ul>
*
* @param file file or directory to delete, not null
* @throws NullPointerException if the directory is null
* @throws IOException in case deletion is unsuccessful
*/
public static void forceDelete(File file) throws IOException {
if (file.isDirectory()) {
deleteDirectory(file);
} else {
if (!file.exists()) {
throw new FileNotFoundException("File does not exist: " + file);
}
if (!file.delete()) {
String message =
"Unable to delete file: " + file;
throw new IOException(message);
}
}
}
}
The table below shows all metrics for FileUtils.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 102.00 | Number of blocks | |
| BLOCK_COMMENT | 29.00 | Number of block comment lines | |
| COMMENTS | 200.00 | Comment lines | |
| COMMENT_DENSITY | 0.69 | Comment density | |
| COMPARISONS | 54.00 | Number of comparison operators | |
| CYCLOMATIC | 80.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 19.00 | Comments in declarations | |
| DOC_COMMENT | 139.00 | Number of javadoc comment lines | |
| ELOC | 289.00 | Effective lines of code | |
| EXEC_COMMENTS | 29.00 | Comments in executable code | |
| EXITS | 55.00 | Procedure exits | |
| FUNCTIONS | 20.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 80.17 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 121.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 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 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 | 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 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 5.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 | 14.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 3.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 3.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 3.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 4.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 | 2.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 | 2.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 | 708.00 | Number of lines in the source file | |
| LINE_COMMENT | 32.00 | Number of line comments | |
| LOC | 469.00 | Lines of code | |
| LOGICAL_LINES | 167.00 | Number of statements | |
| LOOPS | 7.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 765.00 | Number of operands | |
| OPERATORS | 1610.00 | Number of operators | |
| PARAMS | 36.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2375.00 | Halstead program length | |
| PROGRAM_VOCAB | 277.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 85.00 | Number of return points from functions | |
| SIZE | 23741.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 229.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 48.00 | Number of unique operators | |
| WHITESPACE | 39.00 | Number of whitespace lines | |