JOscarPlugin.java
| Index Score | ||
|---|---|---|
 |
 |
org.xnap.plugin.joscar |
 |
 |
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 |  |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0123 | JAVA0123 Use all three components of for loop | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0179 | JAVA0179 Local variable hides visible field | |
| UNIQUE_OPERANDS | Number of unique operands | |
| FUNCTIONS | Number of function declarations | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0143 | JAVA0143 Synchronized method | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0237 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| LOGICAL_LINES | Number of statements | |
| LOC | Lines of code | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| OPERANDS | Number of operands | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| LINES | Number of lines in the source file | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| ELOC | Effective lines of code | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0288 | JAVA0288 Inconsistent null check | |
| RETURNS | Number of return points from functions | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| EXEC_COMMENTS | Comments in executable code | |
| BLOCKS | Number of blocks | |
| JAVA0043 | JAVA0043 Inner class does not use outer class | |
| JAVA0007 | JAVA0007 Should not declare public field | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| LINE_COMMENT | Number of line comments | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
/*
* 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.joscar;
import java.awt.event.ActionEvent;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.File;
import java.io.IOException;
import java.util.Collections;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.Icon;
import javax.swing.JMenu;
import javax.swing.JOptionPane;
import org.apache.log4j.Logger;
import org.xnap.XNap;
import org.xnap.XNapFacade;
import org.xnap.action.*;
import org.xnap.chat.ChatManager;
import org.xnap.event.StateEvent;
import org.xnap.event.StateListener;
import org.xnap.gui.AbstractPreferencesDialog;
import org.xnap.gui.StatusBar;
import org.xnap.gui.XNapFrame;
import org.xnap.gui.component.XNapMenu;
import org.xnap.gui.component.XNapMenuItem;
import org.xnap.gui.event.AbstractPreferencesDialogListener;
import org.xnap.gui.util.IconHelper;
import org.xnap.peer.HotlistManager;
import org.xnap.plugin.AbstractPlugin;
import org.xnap.util.FileHelper;
import org.xnap.util.IllegalOperationException;
import org.xnap.util.State;
import JOscarLib.Integration.Event.IncomingMessageEvent;
import JOscarLib.Integration.Event.IncomingUrlEvent;
import JOscarLib.Integration.Event.IncomingUserEvent;
import JOscarLib.Integration.Event.MessagingListener;
import JOscarLib.Integration.Event.OffgoingUserEvent;
import JOscarLib.Integration.Event.OfflineMessageEvent;
import JOscarLib.Integration.Event.StatusListener;
/**
* Provides a simple chat plugin for ICQ.
*
* This class creates the connection to the oscar server and is responsible of
* managing the buddies and open chat channels, it also updates the online
* status of each buddy.
*/
public class JOscarPlugin extends AbstractPlugin
implements StateListener, MessagingListener, StatusListener,
PropertyChangeListener
{
//--- Constant(s) ---
public static String ICON_FILENAME = "licq.png";
public static Icon ICON_16 = IconHelper.getIcon(ICON_FILENAME, 16, false);
public static final String BUDDY_FILE =
FileHelper.getHomeDir() + "joscar_buddies";
//--- Data Field(s) ---
private static JOscarPlugin instance;
private PreferencesDialogListener listener;
/**
* The wrapped connection to the icq network.
*/
private JOscarConnection connection;
/**
* The local JOscarPeer.
*/
private JOscarPeer peer;
/**
* The list of active channels hashed by chat partner.
*/
private Map channelsByPeer;
/**
* The buddy list, hashed by their uins.
*/
private Map buddies;
/**
* Menu plugged into XNap's plugins menu.
*/
private JMenu jmOscar;
/**
* Displays if we're online or offline for now.
*/
private JOscarStatusPanel spOscar;
private JOscarPreferences prefs;
private static Logger logger = Logger.getLogger(JOscarPlugin.class);
//--- Constructor(s) ---
public JOscarPlugin()
{
}
//--- Method(s) ---
public static JOscarPlugin getInstance()
{
return instance;
}
/**
* Returns the name of the plugin.
*/
public String getName()
{
return getInfo().getName();
}
/**
* Starts the plugin.
*/
public void start()
{
instance = this;
prefs = JOscarPreferences.getInstance();
prefs.addPropertyChangeListener("username", this);
connection = new JOscarConnection();
connection.addStateListener(this);
peer = new JOscarPeer(prefs.getUsername());
channelsByPeer = Collections.synchronizedMap(new Hashtable());
buddies = Collections.synchronizedMap(new Hashtable());
readBuddiesList();
if (prefs.getAutoconnect()) {
connection.connect();
}
}
/**
* Starts the GUI of the plugin.
*/
public void startGUI()
{
initializeMenu();
XNapFrame.getInstance().getMainMenuBar().addPluginMenu(jmOscar);
listener = new PreferencesDialogListener();
XNapFacade.addPluginPreferencesDialogListener(listener);
// add status panel to GUI
spOscar = new JOscarStatusPanel();
connection.addStateListener(spOscar);
StatusBar.getInstance().addComponent(spOscar);
}
private void initializeMenu()
{
jmOscar = new XNapMenu(getName());
jmOscar.setIcon(IconHelper.getMenuIcon(ICON_FILENAME));
jmOscar.add(new XNapMenuItem(new AddBuddyAction()));
jmOscar.addSeparator();
jmOscar.add(new XNapMenuItem(new ConnectAction()));
jmOscar.add(new XNapMenuItem(new DisconnectAction()));
}
/**
* Stops the plugin. Disposes all singletons.
*/
public void stop()
{
removeChannels();
writeBuddiesList();
removeBuddies();
try {
connection.disconnect();
}
catch (IllegalOperationException ie) {
}
connection = null;
peer = null;
buddies = null;
channelsByPeer = null;
prefs.removePropertyChangeListener(this);
JOscarPreferences.disposeInstance();
prefs = null;
instance = null;
}
public synchronized void propertyChange(PropertyChangeEvent e)
{
peer = new JOscarPeer(prefs.getUsername());
if (connection.getState() == State.CONNECTED) {
connection.disconnect();
connection.connect();
}
}
/**
*
*/
public void stateChanged(StateEvent event)
{
if (connection.getState() == State.CONNECTED) {
connection.addMessagingListener(this);
connection.addStatusListener(this);
synchronized(buddies) {
for (Iterator i = buddies.keySet().iterator(); i.hasNext();) {
connection.addUser((String)i.next());
}
}
}
else {
}
}
/**
* Stops the GUI of the plugin.
*/
public void stopGUI()
{
listener.dispose();
XNapFacade.removePluginPreferencesDialogListener(listener);
listener = null;
XNapFrame.getInstance().getMainMenuBar().removePluginMenu(jmOscar);
jmOscar = null;
StatusBar.getInstance().removeComponent(spOscar);
connection.removeStateListener(spOscar);
spOscar = null;
}
/**
* Tells {@link ChatManager} to close all joscar channels.
*/
private void removeChannels()
{
synchronized (channelsByPeer) {
for (Iterator i = channelsByPeer.values().iterator();
i.hasNext();) {
ChatManager.getInstance().remove((JOscarChannel)i.next());
}
}
}
public void sendMessage(String uin, String message)
{
connection.sendMessage(uin, message);
}
public void sendSMS(String uin, String message)
{
connection.sendSMS(uin, message);
}
/**
* Creates a new {@link JOscarPeer} if it's not already in the
* <code>buddies</code> hashtable.
*/
public JOscarPeer addBuddy(String uin)
{
return addBuddy(new JOscarPeer(uin));
}
/**
* Creates a new {@link JOscarPeer} if it's not already in the
* <code>buddies</code> hashtable.
*
*/
public JOscarPeer addBuddy(JOscarPeer buddy)
{
if (!buddies.containsKey(buddy.getName())) {
connection.addStateListener(buddy);
buddies.put(buddy.getName(), buddy);
connection.addUser(buddy.getName());
HotlistManager.getInstance().add(buddy);
return buddy;
}
return (JOscarPeer)buddies.get(buddy.getName());
}
/**
* Returns the local peer.
*/
public synchronized JOscarPeer getLocalPeer()
{
return peer;
}
/**
* Returns the oscar connection for listeners to subscribe to.
*/
public JOscarConnection getConnection()
{
return connection;
}
/**
* Removes a buddy.
*/
public void removeBuddy(JOscarPeer buddy)
{
buddies.remove(buddy.getName());
connection.removeStateListener(buddy);
HotlistManager.getInstance().remove(buddy);
}
private void removeBuddies()
{
JOscarPeer[] peers =
(JOscarPeer[])buddies.values().toArray(new JOscarPeer[0]);
for (int i = 0; i < peers.length; i++) {
removeBuddy(peers[i]);
}
}
public void addChannel(JOscarChannel channel)
{
if (!channelsByPeer.containsKey(channel.getJOscarPeer())) {
channelsByPeer.put(channel.getJOscarPeer(), channel);
ChatManager.getInstance().add(channel);
}
}
public void removeChannel(JOscarChannel channel)
{
logger.debug("channel remove called for "
+ channel.getJOscarPeer().getName());
channelsByPeer.remove(channel.getJOscarPeer());
}
private void readBuddiesList()
{
LinkedList list = new LinkedList();
try {
FileHelper.readBinary(new File(BUDDY_FILE), list);
}
catch (IOException ie) {
logger.debug("error reading buddies file", ie);
}
for (Iterator i = list.iterator(); i.hasNext();) {
addBuddy((String)i.next());
}
}
private void writeBuddiesList()
{
try {
FileHelper.writeBinary(new File(BUDDY_FILE), buddies.keySet());
}
catch (IOException ie) {
logger.debug("error writing buddies file", ie);
}
}
/**
* Implements the {@link OscarListener} interface.
*/
public void onIncomingMessage(IncomingMessageEvent event)
{
JOscarPeer peer = addBuddy(event.getSenderID());
if (!channelsByPeer.containsKey(peer)) {
JOscarChannel channel = new JOscarChannel(peer);
addChannel(channel);
// show the first message, even if it's shown twice
channel.messageReceived(peer, event.getMessage());
}
}
/**
* Implements the {@link OscarListener} interface.
*/
public void onIncomingUrl(IncomingUrlEvent e)
{
}
/**
* Implements the {@link OscarListener} interface.
*/
public void onIncomingUser(IncomingUserEvent e)
{
JOscarPeer peer = (JOscarPeer)buddies.get(e.getIncomingUserId());
if (peer != null) {
logger.debug("buddy " + peer.getName()
+ " seems to have gone online");
peer.setStatus(e.getStatusMode().toString());
}
}
/**
* Implements the {@link OscarListener} interface.
*/
public void onOffgoingUser(OffgoingUserEvent e)
{
JOscarPeer peer = (JOscarPeer)buddies.get(e.getOffgoingUserId());
logger.debug("buddy " + peer.getName() + " seems to have gone offline");
if (peer != null) {
peer.setStatus(XNap.tr("Offline"));
}
}
/**
* Implements the {@link OscarListener} interface.
*/
public void onOfflineMessage(OfflineMessageEvent e)
{
logger.debug("buddy " + e.getSenderUin() + " is going offline, " +
e.getMessage());
}
// --- Inner Class(es) ---
private class AddBuddyAction extends AbstractAction
{
public AddBuddyAction()
{
putValue(Action.NAME, XNap.tr("Add Buddy"));
putValue(Action.SHORT_DESCRIPTION,
XNap.tr("Asks for a UIN and adds it to the Hotlist."));
putValue(IconHelper.XNAP_ICON, "edit_add.png");
}
public void actionPerformed(ActionEvent event)
{
Object[] message = new Object[] {
XNap.tr("Buddy UIN")
};
String uin = JOptionPane.showInputDialog
(XNapFrame.getInstance().getRootPane(), message,
XNap.tr("Add Buddy"), JOptionPane.PLAIN_MESSAGE);
if (uin != null) {
JOscarPlugin.getInstance().addBuddy(uin.trim());
}
}
}
private class ConnectAction extends AbstractXNapAction
implements StateListener
{
public ConnectAction()
{
putValue(Action.NAME, XNap.tr("Connect"));
putValue(IconHelper.XNAP_ICON, "connect_creating.png");
connection.addStateListener(this);
stateChanged(null);
}
public void actionPerformed(ActionEvent event)
{
connection.connect();
}
public void stateChanged(StateEvent e)
{
setEnabledLater(connection.getState() == State.DISCONNECTED);
}
}
private class DisconnectAction extends AbstractXNapAction
implements StateListener
{
public DisconnectAction()
{
putValue(Action.NAME, XNap.tr("Disconnect"));
putValue(IconHelper.XNAP_ICON, "connect_no.png");
connection.addStateListener(this);
stateChanged(null);
}
public void actionPerformed(ActionEvent event)
{
connection.disconnect();
}
public void stateChanged(StateEvent e)
{
setEnabledLater(connection.getState() == State.CONNECTED);
}
}
private class PreferencesDialogListener
extends AbstractPreferencesDialogListener
{
public void addPanels(AbstractPreferencesDialog dialog, List panels)
{
JOscarPreferencesPanel jpp = new JOscarPreferencesPanel();
panels.add(jpp);
panels.add(dialog.addPanel(jpp, ICON_FILENAME));
}
}
}
The table below shows all metrics for JOscarPlugin.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 59.00 | Number of blocks | |
| BLOCK_COMMENT | 18.00 | Number of block comment lines | |
| COMMENTS | 104.00 | Comment lines | |
| COMMENT_DENSITY | 0.42 | Comment density | |
| COMPARISONS | 21.00 | Number of comparison operators | |
| CYCLOMATIC | 53.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 30.00 | Comments in declarations | |
| DOC_COMMENT | 79.00 | Number of javadoc comment lines | |
| ELOC | 246.00 | Effective lines of code | |
| EXEC_COMMENTS | 2.00 | Comments in executable code | |
| EXITS | 91.00 | Procedure exits | |
| FUNCTIONS | 37.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 0.37 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 62.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 | 2.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 1.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 | 1.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 1.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 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 | 1.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 | 3.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 5.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 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 3.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 9.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 | 3.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 | 3.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 | 2.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 638.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 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 3.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 3.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 | 3.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 | 3.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 | 1.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 1.00 | JAVA0288 Inconsistent null check | |
| JAVA0289 | 0.00 | null | |
| LINES | 529.00 | Number of lines in the source file | |
| LINE_COMMENT | 7.00 | Number of line comments | |
| LOC | 352.00 | Lines of code | |
| LOGICAL_LINES | 174.00 | Number of statements | |
| LOOPS | 4.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 741.00 | Number of operands | |
| OPERATORS | 1368.00 | Number of operators | |
| PARAMS | 23.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2109.00 | Halstead program length | |
| PROGRAM_VOCAB | 320.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 39.00 | Number of return points from functions | |
| SIZE | 12900.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 281.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 39.00 | Number of unique operators | |
| WHITESPACE | 73.00 | Number of whitespace lines | |