PluginManager.java
| Index Score | ||
|---|---|---|
 |
 |
org.xnap.plugin |
 |
 |
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 | |
|---|---|---|
| EXITS | Procedure exits |  |
| LOOPS | Number of loops | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| BLOCKS | Number of blocks | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0123 | JAVA0123 Use all three components of for loop | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| DECL_COMMENTS | Comments in declarations | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LOC | Lines of code | |
| OPERATORS | Number of operators | |
| COMPARISONS | Number of comparison operators | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0170 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| PROGRAM_LENGTH | Halstead program length | |
| RETURNS | Number of return points from functions | |
| LINES | Number of lines in the source file | |
| LOGICAL_LINES | Number of statements | |
| OPERANDS | Number of operands | |
| ELOC | Effective lines of code | |
| FUNCTIONS | Number of function declarations | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| UNIQUE_OPERATORS | Number of unique operators | |
| SIZE | Size of the file in bytes | |
| JAVA0008 | JAVA0008 Empty catch block | |
| 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' | |
| JAVA0113 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0287 | JAVA0287 Unnecessary null check | |
| JAVA0067 | JAVA0067 Array descriptor on identifier name | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* 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.plugin;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.util.Collections;
import java.util.Comparator;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Vector;
import java.util.Properties;
import org.apache.log4j.Logger;
import org.xnap.XNap;
import org.xnap.gui.SplashWindow;
import org.xnap.gui.XNapFrame;
import org.xnap.loader.*;
import org.xnap.pkg.*;
import org.xnap.pkg.PackageInfoReader;
import org.xnap.pkg.PackageInfoWriter;
import org.xnap.pkg.ParseException;
import org.xnap.pkg.UnsatisfiedDependenciesException;
import org.xnap.pkg.XNapPackageManager;
import org.xnap.event.PluginListener;
import org.xnap.util.FileHelper;
import org.xnap.util.Preferences;
import org.xnap.util.UncaughtExceptionManager;
import org.xnap.util.VersionParser;
/**
* This class keeps track of all available and enabled plugins.
*/
public class PluginManager
{
//--- Constant(s) ---
public static final String PLUGIN_FILENAME
= FileHelper.getHomeDir() + "available_plugins";
//--- Data field(s) ---
private static Logger logger = Logger.getLogger(PluginManager.class);
private static Preferences prefs = Preferences.getInstance();
private static PluginManager singleton = new PluginManager();
private Hashtable infoByName = new Hashtable();
private List listeners = new Vector();
//--- Constructor(s) ---
/**
* Discovers available plugins. For each plugin that has satisfied
* dependencies a {@link PluginInfo} object is created and added to the
* plugin manager.
*/
private PluginManager()
{
if (XNap.clearPackageInfos
|| Preferences.getInstance().getUpdatePluginsOnStartup()) {
updateFromPackageManager();
}
File file = new File(PLUGIN_FILENAME);
if (!XNap.clearPackageInfos) {
// read control file from home directory
if (file.exists()) {
try {
read(file);
}
catch (IOException e) {
logger.info("Error reading list of available plugins", e);
}
}
else {
updateFromPackageManager();
}
}
removeBaseConflicts();
}
//--- Method(s) ---
public static PluginManager getInstance()
{
return singleton;
}
/**
* Constructs a {@link PluginInfo} object from <code>props</code>
* and invokes {@link #add(PluginInfo)} if info is valid.
*
* @see #PluginManager()
*/
public PluginInfo add(Properties props)
{
PluginInfo info = new PluginInfo(props);
if (info.isValid() && add(info)) {
return info;
}
return null;
}
/**
* Adds a new plugin information object to the list of available
* plugins.
*
* <p>If the plugin was already known and <code>info</code>
* has a lower version or the plugin was already loaded,
* <code>info</code> is not added.
*
* @return true, if <code>info</code> was added; false, otherwise
*/
public boolean add(PluginInfo info)
{
if (!info.areRequirementsSatisfied()) {
return false;
}
PluginInfo existing = getInfoByName(info.getName());
if (existing != null) {
if (!existing.isLoaded()
&& existing.isAvailable()
&& VersionParser.compare(info.getVersion(),
existing.getVersion()) > 0) {
// replace by newer info
infoByName.put(info.getName(), info);
return true;
}
}
else {
// add new info
infoByName.put(info.getName(), info);
firePluginInfoAdded(info);
return true;
}
return false;
}
/**
* Adds a plugin from package info. The classpath is resolved to
* absolute jar file dependencies.
*
* @return true, if the plugin was added successfully
* @see #add(PluginInfo)
*/
public boolean addFromPackage(PackageInfo p)
throws ParseException, UnsatisfiedDependenciesException
{
PluginInfo info = new PluginInfo(p.getProperties());
info.setClassPath(PluginManager.resolveClassPath(info));
return add(info);
}
/**
* Adds the specified plugin listener to receive plugin events.
*/
public void addPluginListener(PluginListener l)
{
listeners.add(l);
}
/**
* Removes the specified plugin listener.
*/
public void removePluginListener(PluginListener l)
{
listeners.remove(l);
}
/**
* Returns the xnap-core package.
*
* @return null, if package is not found
*/
public PluginInfo getCorePackage()
{
return getInfoByName("XNap");
}
public static String getCoreVersion()
{
PluginInfo info = PluginManager.getInstance().getCorePackage();
return (info != null) ? info.getVersion() : XNapLoader.VERSION;
}
/**
* Returns the number of enabled plugins.
*/
public int getEnabledCount()
{
int count = 0;
for (Iterator i = infos(); i.hasNext();) {
PluginInfo info = (PluginInfo)i.next();
if (info.isEnabled()) {
count++;
}
}
return count;
}
/**
* Invoked by {@link org.xnap.gui.XNapFrame}.
*/
public void guiStarted()
{
int count = getEnabledCount();
int increaseBy = (count > 0)
? (95 - SplashWindow.getProgress()) / count
: 0;
for (Iterator i = infos(); i.hasNext();) {
PluginInfo info = (PluginInfo)i.next();
if (info.isEnabled()) {
SplashWindow.incProgress
(increaseBy, XNap.tr("Setting up {0}", info.getName()));
try {
info.getPlugin().startGUI();
}
catch(Throwable t) {
logger.error("could not start plugin gui", t);
UncaughtExceptionManager.getInstance().notify(t);
}
}
}
}
/**
* Invoked by {@link org.xnap.gui.XNapFrame}.
*/
public void guiStopped()
{
for (Iterator i = infos(); i.hasNext();) {
PluginInfo info = (PluginInfo)i.next();
if (info.isEnabled()) {
try {
info.getPlugin().stopGUI();
}
catch(Throwable t) {
logger.error("could not stop plugin gui", t);
UncaughtExceptionManager.getInstance().notify(t);
}
}
}
}
/**
* Returns the information record for plugin with name.
*
* @param name the plugin's name
*/
public PluginInfo getInfoByName(String name)
{
return (PluginInfo)infoByName.get(name);
}
/**
* Return a sorted iterator over a copy of all {@link PluginInfo} objects.
* Changes made to the iterator are not reflected.
*/
public Iterator infos()
{
LinkedList list = new LinkedList(infoByName.values());
Collections.sort(list, new PluginInfoComparator());
return list.iterator();
}
/**
* Loads the plugin described by <code>info</code>. All required jar
* files are added to the class loader and the plugin class is
* instantiated.
*
* @param info the plugin to be loaded
* @return the instantiated plugin object
*/
public Plugin load(PluginInfo info) throws Exception
{
if (!info.isLoaded()) {
ClassLoader loader = getClass().getClassLoader();
if (loader == null) {
loader = XNapClassLoader.getInstance();
}
XNapClassLoader.getInstance().add(info.getClassPath());
Class c = loader.loadClass(info.getClassName());
Plugin p = (Plugin)c.newInstance();
info.setPlugin(p);
p.setInfo(info);
return p;
}
else {
return info.getPlugin();
}
}
/**
* Reads information about installed plugins from file.
*
* @param alreadyLoaded if true, the plugin is already installed in
* the classpath
*/
private void read(File file) throws IOException
{
BufferedReader in = null;
try {
in = new BufferedReader(new FileReader(file));
Properties p;
while ((p = PackageInfoReader.readNext(in)) != null) {
add(p);
}
}
finally {
if (in != null) {
try {
in.close();
}
catch (IOException e) {
}
}
}
}
/**
* Removes all plugins that conflict with the installed base
* packages. Currently only xnap-core is considered to be part of
* base.
*/
private void removeBaseConflicts()
{
// remove conflicting plugins
try {
PluginInfo baseInfo = getCorePackage();
if (baseInfo == null) {
logger.warn("Required base package XNap not found!");
return;
}
PackageInfo[] conflicts
= XNapPackageManager.getInstance().getConflicts(baseInfo);
if (conflicts != null) {
for (int i = 0; i < conflicts.length; i++) {
PluginInfo info = getInfoByName(conflicts[i].getName());
if (info != null && info.equals(conflicts[i])) {
// plugin conflicts with base
remove(info);
}
}
}
}
catch (ParseException e) {
logger.warn("Error parsing base conflicts");
}
}
/**
* Restores the state of the plugin manager from the {@link Preferences}.
*/
public void restore()
{
String[] names = prefs.getEnabledPlugins();
for (int i = 0; i < names.length; i++) {
PluginInfo info = getInfoByName(names[i]);
if (info != null) {
info.setEnableOnStartup(true);
try {
SplashWindow.incProgress(2, XNap.tr("Loading {0} plugin",
info.getName()));
Plugin p = info.getPlugin();
if (p == null) {
p = load(info);
}
setEnabled(p, true);
}
catch (PluginInitializeException e) {
logger.error("could not restore plugin " + names[i], e);
}
catch (ClassNotFoundException e) {
logger.error("could not restore plugin " + names[i], e);
}
catch (Throwable t) {
logger.error("could not restore plugin " + names[i], t);
UncaughtExceptionManager.getInstance().notify(t);
}
}
else {
logger.error("plugin not found " + names[i]);
}
}
}
/**
* Disables all plugins and saves the state of the PluginManager.
*/
public void save()
{
List enabledPlugins = new LinkedList();
for (Iterator i = infos(); i.hasNext();) {
PluginInfo info = (PluginInfo)i.next();
if (info.isEnabled()) {
try {
setEnabled(info.getPlugin(), false, true);
if (info.getEnableOnStartup()) {
enabledPlugins.add(info.getName());
}
}
catch(Throwable t) {
logger.error("could not disable plugin", t);
UncaughtExceptionManager.getInstance().notify(t);
}
}
}
// save the names of the successfully disabled plugins
prefs.setEnabledPlugins((String[])enabledPlugins.toArray(new String[0]));
}
/**
* Enables or disables <code>plugin</code>
*/
private void setEnabled(Plugin plugin, boolean enable, boolean force)
throws Exception
{
if (enable) {
if (!plugin.getInfo().isEnabled()) {
plugin.start();
if (XNapFrame.getInstance() != null) {
plugin.startGUI();
}
plugin.getInfo().setEnabled(true);
firePluginEnabled(plugin);
}
}
else {
if (!plugin.getInfo().canDisable() && !force) {
throw new Exception(XNap.tr("Can not disable plugin. Restart XNap to disable plugin."));
}
if (plugin.getInfo().isEnabled()) {
if (XNapFrame.getInstance() != null) {
plugin.stopGUI();
}
plugin.stop();
plugin.getInfo().setEnabled(false);
firePluginDisabled(plugin);
}
}
}
public void setEnabled(Plugin plugin, boolean enable)
throws Exception
{
setEnabled(plugin, enable, false);
}
/**
* Returns the number of plugins.
*/
public int size()
{
return infoByName.values().size();
}
public void remove(PluginInfo info)
{
infoByName.remove(info.getName());
firePluginInfoRemoved(info);
}
/**
* Resolves the class path of info to absolute filenames.
*/
public static String[] resolveClassPath(PluginInfo info)
throws ParseException, UnsatisfiedDependenciesException
{
List list = new LinkedList();
PackageInfo[] depends
= XNapPackageManager.getInstance().getDependencies(info);
for (int j = 0; j < depends.length; j++) {
String classPath[] = depends[j].getClassPath();
for (int i = 0; i < classPath.length; i++) {
File f = depends[j].getFile(classPath[i].trim());
list.add(f.getAbsolutePath());
}
}
return (String[])list.toArray(new String[0]);
}
/**
* Updates the list of available plugins from {@link
* XNapPackageManager}.
*/
public void updateFromPackageManager()
{
XNapPackageManager.getInstance().initialize();
for (Iterator i = XNapPackageManager.getInstance().packages();
i.hasNext();) {
PackageInfo p = (PackageInfo)i.next();
try {
if (p.isPlugin() || p.isBase()) {
addFromPackage(p);
}
}
catch (ParseException e) {
logger.debug("Could not resolve dependencies for "
+ p.getPackage() + " " + p.getVersion()
+ ": " + e.getMessage());
continue;
}
catch (UnsatisfiedDependenciesException e) {
logger.debug("Unsatisfied dependency for "
+ p.getPackage() + " " + p.getVersion()
+ ": " + e.getMessage());
continue;
}
}
write();
}
public void write()
{
try {
write(new File(PLUGIN_FILENAME));
}
catch (IOException e) {
logger.debug("Error writing list of available plugins", e);
}
}
private void write(File file) throws IOException
{
BufferedWriter out = new BufferedWriter(new FileWriter(file));
try {
for (Iterator i = infoByName.values().iterator(); i.hasNext();) {
PluginInfo info = (PluginInfo)i.next();
PackageInfoWriter.write(out, info.getProperties());
}
}
finally {
try {
out.close();
}
catch (IOException e) {
}
}
}
private void firePluginEnabled(Plugin plugin)
{
Object[] l = listeners.toArray();
if (l != null) {
for (int i = l.length - 1; i >= 0; i--) {
((PluginListener)l[i]).pluginEnabled(plugin);
}
}
}
private void firePluginDisabled(Plugin plugin)
{
Object[] l = listeners.toArray();
if (l != null) {
for (int i = l.length - 1; i >= 0; i--) {
((PluginListener)l[i]).pluginDisabled(plugin);
}
}
}
private void firePluginInfoAdded(PluginInfo info)
{
Object[] l = listeners.toArray();
if (l != null) {
for (int i = l.length - 1; i >= 0; i--) {
((PluginListener)l[i]).pluginInfoAdded(info);
}
}
}
private void firePluginInfoRemoved(PluginInfo info)
{
Object[] l = listeners.toArray();
if (l != null) {
for (int i = l.length - 1; i >= 0; i--) {
((PluginListener)l[i]).pluginInfoRemoved(info);
}
}
}
//--- Inner Classes ---
/**
* Compares {@link PluginInfo} objects by name.
*/
public static class PluginInfoComparator implements Comparator
{
public int compare(Object o1, Object o2)
{
return ((PluginInfo)o1).getName().compareToIgnoreCase
(((PluginInfo)o2).getName());
}
}
}
The table below shows all metrics for PluginManager.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 110.00 | Number of blocks | |
| BLOCK_COMMENT | 18.00 | Number of block comment lines | |
| COMMENTS | 130.00 | Comment lines | |
| COMMENT_DENSITY | 0.44 | Comment density | |
| COMPARISONS | 60.00 | Number of comparison operators | |
| CYCLOMATIC | 99.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 29.00 | Comments in declarations | |
| DOC_COMMENT | 101.00 | Number of javadoc comment lines | |
| ELOC | 297.00 | Effective lines of code | |
| EXEC_COMMENTS | 6.00 | Comments in executable code | |
| EXITS | 108.00 | Procedure exits | |
| FUNCTIONS | 32.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 0.52 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 73.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 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 2.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 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 | 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 | 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 | 1.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 | 10.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 1.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 6.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 | 2.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 2.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 7.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 1.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 5.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 | 6.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 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1154.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 | 4.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 4.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 | 1.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 | 6.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 | 1.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 | 4.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 | 1.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| JAVA0289 | 1.00 | null | |
| LINES | 641.00 | Number of lines in the source file | |
| LINE_COMMENT | 11.00 | Number of line comments | |
| LOC | 443.00 | Lines of code | |
| LOGICAL_LINES | 192.00 | Number of statements | |
| LOOPS | 15.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 868.00 | Number of operands | |
| OPERATORS | 1809.00 | Number of operators | |
| PARAMS | 22.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2677.00 | Halstead program length | |
| PROGRAM_VOCAB | 348.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 51.00 | Number of return points from functions | |
| SIZE | 15357.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 296.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 52.00 | Number of unique operators | |
| WHITESPACE | 68.00 | Number of whitespace lines | |