FileHelper.java
| Index Score | ||
|---|---|---|
 |
 |
org.xnap.util |
 |
 |
XNap 3 |
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 | |
|---|---|---|
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' |  |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| EXITS | Procedure exits | |
| BLOCKS | Number of blocks | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0008 | JAVA0008 Empty catch block | |
| JAVA0143 | JAVA0143 Synchronized method | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0287 | JAVA0287 Unnecessary null check | |
| RETURNS | Number of return points from functions | |
| PARAMS | Number of formal parameter declarations | |
| LOC | Lines of code | |
| CYCLOMATIC | Cyclomatic complexity | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LINES | Number of lines in the source file | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0123 | JAVA0123 Use all three components of for loop | |
| OPERANDS | Number of operands | |
| ELOC | Effective lines of code | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| FUNCTIONS | Number of function declarations | |
| COMPARISONS | Number of comparison operators | |
| LOOPS | Number of loops | |
| LOGICAL_LINES | Number of statements | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| UNIQUE_OPERATORS | Number of unique operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0109 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| SIZE | Size of the file in bytes | |
| JAVA0067 | JAVA0067 Array descriptor on identifier name | |
| COMMENTS | Comment lines | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| EXEC_COMMENTS | Comments in executable code | |
| NEST_DEPTH | Maximum nesting depth | |
/*
* XNap - A P2P framework and client.
*
* See the file AUTHORS for copyright information.
*
* 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.
*
* 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
*/
package org.xnap.util;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.NotSerializableException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.OutputStream;
import java.io.RandomAccessFile;
import java.net.URL;
import java.util.Collection;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Properties;
import java.util.StringTokenizer;
import org.apache.log4j.Logger;
import org.xnap.loader.XNapClassLoader;
import org.xnap.search.MediaType;
import org.xnap.search.SearchManager;
/**
* Provides a set of static methods that help with file manipulation.
*/
public class FileHelper
{
//--- Constant(s) ---
//--- Data field(s) ---
private static Logger logger = Logger.getLogger(FileHelper.class);
//--- Constructor(s) ---
//--- Method(s) ---
/**
* Creates and returns a file in the incomplete directory.
*/
public static File createIncompleteFile(String filename)
throws IOException
{
File path = new File(Preferences.getInstance().getIncompleteDir());
return FileHelper.createUnique(path, filename);
}
/**
* Creates a unique file by inserting digits into <code>filename</code>.
*
* @return the created file
*/
public static synchronized File createUnique(String filename)
throws IOException
{
logger.debug("FileHelper: creating unique: " + filename);
File f = new File(uniqueName(filename));
f.createNewFile();
return f;
}
/**
* Creates a unique file in by inserting digits into <code>filename</code>.
*
* @param path the path of the file to create
* @param filename the name of the file to create
* @return the created file
*/
public static synchronized File createUnique(File path, String filename)
throws IOException
{
if (path.isDirectory() || path.mkdirs()) {
// sanitize filename
filename = toFilename(filename);
return createUnique
(path.getAbsolutePath() + File.separator + filename);
}
throw new FileNotFoundException();
}
/**
* Moves <code>file</code> to <code>path</code> but renames
* <code>filename</code> if it already exists in the target path.
*
* @param file the file to move
* @param path the target path
* @param filename the new filename for <code>file</code>
* @return the moved file
*/
public static synchronized File moveUnique
(File file, String path, String filename) throws IOException
{
String newFilename = appendSeparator(path) + toFilename(filename);
logger.debug("moveUnique new name: " + newFilename);
if (newFilename.equals(file.getAbsolutePath())) {
return file;
}
File p = new File(path);
if (p.isDirectory() || p.mkdirs()) {
File newFile = new File(uniqueName(newFilename));
logger.debug("moveUnique new file: " + newFile);
if (move(file, newFile)) {
return newFile;
}
else {
throw new FileNotFoundException
("Could not rename " + file.getAbsolutePath() + " to "
+ newFile.getAbsolutePath());
}
}
else {
throw new FileNotFoundException
("Could not create " + p.getAbsolutePath());
}
}
/**
* Moves <code>file</code> to <code>path</code>.
*
* @see #moveUnique(File, String, String)
*/
public static synchronized File moveUnique(File file, String path)
throws IOException
{
return moveUnique(file, path, file.getName());
}
/**
* Moves a file. Tries a rename, if fails, copies file.
*/
public static boolean move(File source, File dest) throws IOException
{
if (!source.renameTo(dest)) {
copy(source, dest);
source.delete();
}
return true;
}
/**
* Copies <code>source</code> to <code>dest</code>. If dest already exists
* it is overwritten.
*
* @param source the source file
* @param dest the destination file
*/
public static void copy(File source, File dest) throws IOException
{
InputStream in = new FileInputStream(source);
try {
copy(in, new FileOutputStream(dest));
}
finally {
try {
in.close();
}
catch (IOException e) {
}
}
}
/**
* Copies <code>source</code> to <code>dest</code>. If dest already exists
* it is overwritten.
*
* @param source the source file
* @param dest the destination file
*/
public static void copy(InputStream inStream, OutputStream outStream)
throws IOException
{
BufferedInputStream in = null;
BufferedOutputStream out = null;
try {
in = new BufferedInputStream(inStream);
out = new BufferedOutputStream(outStream);
byte buffer[] = new byte[512 * 1024];
int count;
while ((count = in.read(buffer, 0, buffer.length)) != -1) {
out.write(buffer, 0, count);
}
out.flush();
}
finally {
if (in != null) {
try {
in.close();
}
catch (IOException e) {
}
}
if (out != null) {
try {
out.close();
}
catch (IOException e) {
}
}
}
}
/**
* Returns the lower case extension part of <code>filename</code>.
*
* @see #name(String)
*/
public static String extension(String filename)
{
return StringHelper.lastToken(filename, ".").toLowerCase();
}
/**
* Returns the name part of <code>filename</code>.
*
* @see #extension(String)
*/
public static String name(String filename)
{
int i = filename.lastIndexOf(".");
return (i < 1) ? filename : filename.substring(0, i);
}
/**
* Returns the path of the download dir where <code>filename</code>
* should be downloaded to.
*/
public static String getDownloadDir(String filename)
{
Preferences p = Preferences.getInstance();
MediaType type = SearchManager.getMediaType(filename);
if (type != null) {
String dir = p.getMediaTypeDownloadDir(type.getRealm());
if (dir.length() > 0) {
return dir;
}
}
return p.getDownloadDir();
}
public static URL getResource(String filename)
{
return XNapClassLoader.getInstance().getResource(filename);
}
public static InputStream getResourceAsStream(String filename)
{
return XNapClassLoader.getInstance().getResourceAsStream(filename);
}
/**
* Creates unique filename.
*/
public static String uniqueName(String filename)
{
return uniqueName(filename, "");
}
public static String uniqueName(String filename, String infix)
{
String extension = extension(filename);
if (extension.length() > 0) {
extension = "." + extension;
filename = name(filename);
}
if (infix.length() > 0) {
infix = "." + infix;
}
if (exists(filename + infix + extension)) {
for (int i = 1; ; i++) {
if (!exists(filename + infix + "." + i + extension))
return (filename + infix + "." + i + extension);
}
}
return filename + infix + extension;
}
/**
* Returns true, if filename exists; false, otherwise.
*/
public static boolean exists(String filename)
{
return (new File(filename)).exists();
}
/**
* Checks for existence of .xnap folder in the user's home directory and
* returns the absolute path with a file separator appended.
*
* @param subdir a sub directory that is located in ~/.xnap/ or created if
* it does not exist
* @return empty string, if subdir could not be created; absolute path,
* otherwise
*/
public static final String getHomeDir(String subdir)
{
StringBuffer sb = new StringBuffer();
sb.append(XNapClassLoader.getHomeDir());
if (subdir.length() > 0) {
sb.append(subdir);
sb.append(File.separatorChar);
}
String dir = sb.toString();
File file = new File(dir);
if (file.isDirectory() || file.mkdirs()) {
return dir;
}
return "";
}
/**
* Returns the absolute path of the ~/.xnap/ directory.
*
* @see #getHomeDir(String)
*/
public static final String getHomeDir()
{
return getHomeDir("");
}
/**
* Appens a file separator to <code>path</code> if it does not have a
* trailing one.
*/
public static String appendSeparator(String path)
{
if (path.length() > 0 && !path.endsWith(File.separator)) {
return path + File.separator;
}
else {
return path;
}
}
public static String directory(String dir)
{
dir = dir.trim();
if (dir.length() == 0) {
dir = System.getProperty("user.dir");
}
return appendSeparator(dir);
}
public static String directories(String dirs)
{
StringTokenizer st = new StringTokenizer(dirs, ";");
StringBuffer sb = new StringBuffer();
while (st.hasMoreTokens()) {
String s = st.nextToken().trim();
if (s.length() > 0) {
File f = new File(s);
sb.append(f.getAbsolutePath());
sb.append(";");
}
}
dirs = sb.toString();
// remove trailing semicolon
return (dirs.length() > 0) ? dirs.substring(0, dirs.length() - 1) : "";
}
/**
* Shortens <code>file</code> by <code>bytes</code> bytes.
*/
public static void shorten(File file, long bytes)
{
try {
RandomAccessFile f = new RandomAccessFile(file, "rw");
try {
f.setLength(Math.max(f.length() - bytes, 0));
}
catch (IOException e) {
}
finally {
try {
f.close();
}
catch (IOException e) {
}
}
}
catch (IOException e) {
}
}
/**
* Stores <code>props</code> in <code>file</code>.
*/
public static void writeProperties(File file, Properties props)
throws IOException
{
FileOutputStream out = null;
try {
out = new FileOutputStream(file);
props.store(out, "This file was automatically generated.");
}
catch (IOException e) {
throw(e);
}
finally {
try {
if (out != null) {
out.close();
}
}
catch (Exception e) {
}
}
}
/**
* Reads all objects from <code>file</code> using serialization and adds
* them to <code>c</code>.
*/
public static void readBinary(File file, Collection c) throws IOException
{
logger.debug("reading binary file: " + file);
ObjectInputStream in = null;
try {
in = new ObjectInputStream(new FileInputStream(file));
int size = in.readInt();
for (int i = 0; i < size; i++) {
try {
Object o = in.readObject();
if (o != null) {
c.add(o);
}
}
catch (IOException e) {
throw e;
}
catch (Exception e) {
logger.warn("error while reading binary file", e);
}
}
}
finally {
try {
if (in != null) {
in.close();
}
}
catch (IOException e) {
}
}
}
public static String readText(File file) throws IOException
{
return readText(new FileInputStream(file));
}
/**
* Reads a text file.
*/
public static String readText(InputStream inStream) throws IOException
{
BufferedReader in
= new BufferedReader(new InputStreamReader(inStream));
try {
StringBuffer sb = new StringBuffer();
String s;
while ((s = in.readLine()) != null) {
sb.append(s);
sb.append("\n");
}
return sb.toString();
}
finally {
try {
in.close();
}
catch (IOException e) {
// this exception gets lost
}
}
}
public static String[] readConfig(File file) throws IOException
{
return readConfig(new FileInputStream(file));
}
/**
* Reads a text file. Ignores all lines empty lines and lines that
* start with a '#' character.
*
* @return always a valid array, possibly with size 0
*/
public static String[] readConfig(InputStream inStream) throws IOException
{
BufferedReader in
= new BufferedReader(new InputStreamReader(inStream));
try {
List lines = new LinkedList();
String s;
while ((s = in.readLine()) != null) {
s = s.trim();
if (s.length() == 0 || s.startsWith("#")) {
continue;
}
lines.add(s);
}
return (String[])lines.toArray(new String[0]);
}
finally {
try {
in.close();
}
catch (IOException e) {
// this exception gets lost
}
}
}
/**
* Replaces all special characters in filename by '_'.
*/
public static String toAscii(String filename)
{
String s = filename;
s = s.replace('\t', '_');
s = s.replace(' ', '_');
s = s.replace(File.separatorChar, '_');
s = s.replace(File.pathSeparatorChar, '_');
return s;
}
/**
* Replaces some special characters in filename by '_'.
*/
public static String toFilename(String filename)
{
String s = filename;
s = s.replace(File.separatorChar, '_');
s = s.replace(File.pathSeparatorChar, '_');
return s;
}
/**
* Write all items in <code>c</code> to <code>file</code> using
* serialization.
*/
public static void writeBinary(File file, Collection c) throws IOException
{
logger.debug("writing " + c.size() + " items to binary file: " + file);
ObjectOutputStream out = null;
try {
out = new ObjectOutputStream(new FileOutputStream(file));
out.writeInt(c.size());
for (Iterator i = c.iterator(); i.hasNext();) {
try {
out.writeObject(i.next());
}
catch (NotSerializableException e) {
logger.debug("Object not serializable", e);
}
}
}
finally {
try {
if (out != null) {
out.close();
}
}
catch (IOException e) {
}
}
}
/**
* Writes a text file.
*/
public static void writeText(File file, String text) throws IOException
{
BufferedWriter out = new BufferedWriter(new FileWriter(file));
try {
out.write(text);
}
finally {
try {
out.close();
}
catch (IOException e) {
// this exception gets lost
}
}
}
}
The table below shows all metrics for FileHelper.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 111.00 | Number of blocks | |
| BLOCK_COMMENT | 18.00 | Number of block comment lines | |
| COMMENTS | 146.00 | Comment lines | |
| COMMENT_DENSITY | 0.51 | Comment density | |
| COMPARISONS | 47.00 | Number of comparison operators | |
| CYCLOMATIC | 85.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 31.00 | Comments in declarations | |
| DOC_COMMENT | 119.00 | Number of javadoc comment lines | |
| ELOC | 285.00 | Effective lines of code | |
| EXEC_COMMENTS | 5.00 | Comments in executable code | |
| EXITS | 83.00 | Procedure exits | |
| FUNCTIONS | 32.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 0.53 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 102.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 9.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 | 1.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 non-protected 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 | 1.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 | 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 | 1.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 2.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 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 | 28.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 2.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 13.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 | 14.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 7.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 | 2.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 | 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 | 4.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1098.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 | 2.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 3.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 | 1.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 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 5.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| JAVA0289 | 0.00 | null | |
| LINES | 636.00 | Number of lines in the source file | |
| LINE_COMMENT | 9.00 | Number of line comments | |
| LOC | 430.00 | Lines of code | |
| LOGICAL_LINES | 165.00 | Number of statements | |
| LOOPS | 7.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 827.00 | Number of operands | |
| OPERATORS | 1551.00 | Number of operators | |
| PARAMS | 44.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2378.00 | Halstead program length | |
| PROGRAM_VOCAB | 329.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 58.00 | Number of return points from functions | |
| SIZE | 14303.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 279.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 50.00 | Number of unique operators | |
| WHITESPACE | 60.00 | Number of whitespace lines | |