OvernetCore.java
| Index Score | ||
|---|---|---|
 |
 |
org.xnap.plugin.overnet.net |
 |
 |
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 |  |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0143 | JAVA0143 Synchronized method | |
| BLOCKS | Number of blocks | |
| LOC | Lines of code | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| LOGICAL_LINES | Number of statements | |
| OPERANDS | Number of operands | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0075 | JAVA0075 Method parameter hides field | |
| ELOC | Effective lines of code | |
| RETURNS | Number of return points from functions | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| UNIQUE_OPERATORS | Number of unique operators | |
| DECL_COMMENTS | Comments in declarations | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| JAVA0077 | JAVA0077 Private field not used in declaring class | |
| LINES | Number of lines in the source file | |
| PROGRAM_VOLUME | Halstead program volume | |
| FUNCTIONS | Number of function declarations | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINE_COMMENT | Number of line comments | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0123 | JAVA0123 Use all three components of for loop | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| DOC_COMMENT | Number of javadoc comment lines | |
/*
* 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.overnet.net;
import java.io.IOException;
import java.net.*;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
import java.nio.channels.ClosedChannelException;
import java.nio.channels.SelectionKey;
import java.nio.channels.Selector;
import java.nio.channels.SocketChannel;
import java.util.Hashtable;
import java.util.Iterator;
import org.apache.log4j.Logger;
import org.xnap.XNap;
import org.xnap.event.StateListener;
import org.xnap.event.StateSupport;
import org.xnap.plugin.overnet.OvernetPlugin;
import org.xnap.plugin.overnet.net.msg.client.*;
import org.xnap.plugin.overnet.net.msg.*;
import org.xnap.plugin.overnet.net.msg.client.GetOptionsMessage;
import org.xnap.plugin.overnet.net.msg.client.GetServerListMessage;
import org.xnap.plugin.overnet.net.msg.client.GetSharedFilesMessage;
import org.xnap.plugin.overnet.net.msg.client.LoginMessage;
import org.xnap.plugin.overnet.net.msg.client.SendDownloadStatusMessage;
import org.xnap.plugin.overnet.net.msg.client.SendUploadStatusMessage;
import org.xnap.plugin.overnet.net.msg.client.StopDownloadStatusMessage;
import org.xnap.plugin.overnet.net.msg.client.StopUploadStatusMessage;
import org.xnap.plugin.overnet.net.msg.core.OvernetCoreMessage;
import org.xnap.plugin.overnet.net.msg.core.MessageFactory;
import org.xnap.plugin.overnet.util.OvernetPreferences;
import org.xnap.search.SearchManager;
import org.xnap.util.FiniteStateMachine;
import org.xnap.util.Preferences;
import org.xnap.util.Scheduler;
import org.xnap.util.State;
/**
* Epitomizes a connection to the overnet core.
*
* This class handles all the low level writing and reading of messages. The
* transitions from one connection state to the next are handled in its
* private subclass <code>StateMachine</code>.
*/
public class OvernetCore
{
//--- Constant(s) ---
public static final byte ED2K_BYTE = (byte)0xe3;
private static final Hashtable TRANSITION_TABLE;
static {
State[][] table = new State[][] {
{ State.DISCONNECTED, State.CONNECTING, },
{ State.CONNECTING, State.CONNECTED, State.DISCONNECTED },
{ State.CONNECTED, State.DISCONNECTING, State.DISCONNECTED },
{ State.DISCONNECTING, State.DISCONNECTED }
};
TRANSITION_TABLE = FiniteStateMachine.createStateTable(table);
}
//--- Data Field(s) ---
/**
* The non blocking channel for this connection.
*/
private SocketChannel channel;
/**
* The buffer used for reading from the channel.
*/
private ByteBuffer buffer = ByteBuffer.allocate(1024);
private Selector selector;
private boolean die = false;
/**
* Queues the messages to be written out.
*/
private MessageQueue sendQueue = new MessageQueue();
/**
* Messages are forwarded to the message handler after their creation.
*/
private MessageHandler messageHandler;
private OvernetPreferences prefs = OvernetPreferences.getInstance();
/**
* Delay connection time.
*/
private int delay = 0;
private StateMachine sm = new StateMachine();
private StateSupport listeners = new StateSupport(this);
private static Logger logger = Logger.getLogger(OvernetCore.class);
//--- Constructor(s) ---
public OvernetCore(MessageHandler handler)
{
buffer.order(ByteOrder.LITTLE_ENDIAN);
if (handler == null) {
throw new NullPointerException();
}
messageHandler = handler;
}
/**
* Connect to the overnet core.
*/
public void connect()
{
connect(0);
}
/**
* Connect to core after a certain delay.
*
* The core's state will be immediately connecting.
*/
public void connect(int delay)
{
this.delay = delay;
setState(State.CONNECTING);
}
private void read() throws IOException
{
try {
if (channel.read(buffer) == -1) {
stop();
return;
}
}
catch (IOException ie) {
// logger.debug("channel read", ie);
}
byte type;
while ((type = check(buffer)) != -1) {
// logger.debug("read " + (int)type);
OvernetCoreMessage msg = MessageFactory.create(type, buffer);
if (msg != null && msg.isValid()) {
messageHandler.handle(msg);
}
int size = buffer.getInt(1);
// logger.debug("Computed size " + size + " as to b.limit() "
// + buffer.limit());
buffer.position(Math.min(size + 5, buffer.limit()));
buffer.compact();
}
buffer.compact();
}
private byte check(ByteBuffer buffer) throws IOException
{
buffer.flip();
if (buffer.remaining() < 6) {
return -1;
}
byte b = buffer.get();
int size = buffer.getInt();
byte type = buffer.get();
buffer.rewind();
if (b != ED2K_BYTE) {
logger.debug("invalid packet" + toString(buffer.array())
+ " offset " + buffer.arrayOffset()
+ " position " + buffer.position()
+ " limit " + buffer.limit());
throw new IOException("Invalid Packet");
}
if (buffer.capacity() < size + 5) {
resizeBuffer(size + 5);
return -1;
}
if (buffer.remaining() < size + 5) {
logger.debug(type + " message of size " + size
+ " not fully read");
return -1;
}
return type;
}
private void resizeBuffer(int size)
{
logger.debug("reallocating buffer to " + size);
byte[] bytes = new byte[size];
buffer.get(bytes, 0, buffer.remaining());
ByteBuffer newBuf = ByteBuffer.wrap(bytes);
newBuf.order(ByteOrder.LITTLE_ENDIAN);
newBuf.limit(buffer.limit());
buffer = newBuf;
}
private String toString(byte[] array)
{
StringBuffer sb = new StringBuffer(array.length * 2);
for (int i = 0; i < array.length; i++) {
sb.append(array[i]);
sb.append(" ");
}
return sb.toString();
}
private synchronized void write() throws IOException
{
OvernetClientMessage msg = sendQueue.getNextMessage();
if (msg != null) {
channel.write(msg.getBuffer());
}
/* if there is still data to be written out, register the write op
bit. */
if (sendQueue.hasRemaining()) {
addOp(SelectionKey.OP_WRITE);
}
else {
removeOp(SelectionKey.OP_WRITE);
}
}
private void addOp(int op)
{
SelectionKey key = channel.keyFor(selector);
try {
if (key != null) {
channel.register(selector, key.interestOps() | op);
}
else {
channel.register(selector, op);
}
}
catch (ClosedChannelException ce) {
logger.debug("addOp", ce);
setState(State.DISCONNECTED, ce.getLocalizedMessage());
}
}
private void removeOp(int op)
{
SelectionKey key = channel.keyFor(selector);
try {
if (key != null) {
channel.register(selector, key.interestOps() ^ op);
}
}
catch (ClosedChannelException ce) {
logger.debug("removeOp", ce);
setState(State.DISCONNECTED, ce.getLocalizedMessage());
}
}
/**
* Adds the message to the <code>sendQueue</code> and calls {@link
* #write()}
*/
private void write(OvernetClientMessage cm)
{
sendQueue.add(cm);
try {
write();
}
catch (IOException ie) {
stop();
logger.debug("error writing", ie);
}
}
/**
* Sends a message to the overnet core in a non-blocking way.
*/
public static void send(OvernetClientMessage cm)
{
OvernetCore c = OvernetPlugin.getInstance().getCore();
// logger.debug("Sending " + cm.getClass().getName());
c.write(cm);
}
/**
* Stops the connection.
*/
public void stop()
{
die = true;
if (selector != null) {
selector.wakeup();
}
}
public void addStateListener(StateListener listener)
{
listeners.addStateListener(listener);
}
public void removeStateListener(StateListener listener)
{
listeners.removeStateListener(listener);
}
public State getState()
{
return sm.getState();
}
public String getDescription()
{
return sm.getDescription();
}
private void setState(State newState)
{
sm.setState(newState);
listeners.fireStateChanged();
}
private void setState(State newState, String message)
{
sm.setState(newState, message);
listeners.fireStateChanged();
}
//--- Inner Class(es) ---
private class StateMachine extends FiniteStateMachine implements Runnable
{
//---- Data Field(s) ---
private Thread runner;
//--- Constructor(s) ---
public StateMachine()
{
super(State.DISCONNECTED, TRANSITION_TABLE);
}
protected synchronized void stateChanged(State oldState,
State newState)
{
if (newState == State.CONNECTING) {
if (delay > 0) {
Scheduler.run(delay, new Runnable() {
public void run()
{
connect();
}
});
}
else {
connect();
}
}
else if (newState == State.CONNECTED) {
connected();
}
else if (newState == State.DISCONNECTING) {
disconnect();
}
else if (newState == State.DISCONNECTED) {
close();
}
}
private void connect()
{
try {
sendQueue.clear();
die = false;
channel = SocketChannel.open();
channel.configureBlocking(false);
InetSocketAddress isa = new InetSocketAddress
(prefs.getCoreHost(), prefs.getCorePort());
if (isa.isUnresolved()) {
throw new IOException("Address could not me be resolved");
}
channel.connect(isa);
}
catch (IOException ie) {
logger.debug("connecting failed", ie);
this.setState(State.DISCONNECTED, ie.getLocalizedMessage());
}
// start selector thread here
runner = new Thread(this, "Overnet core connection");
runner.start();
}
private void connected()
{
removeOp(SelectionKey.OP_CONNECT);
addOp(SelectionKey.OP_READ);
/* todo: move this somewhere else, it's not the core's task to
send messages on its own. */
write(new LoginMessage(prefs.getUsername(), prefs.getPassword()));
write(new CommandMessage("g"));
if (prefs.getUseXNapDownloadDirs()) {
// these are the global preferences
Preferences p = Preferences.getInstance();
write(new CommandMessage("temp " + p.getIncompleteDir()));
write(new CommandMessage("in " + p.getDownloadDir()));
}
write(new GetOptionsMessage());
write(new SendDownloadStatusMessage());
write(new SendUploadStatusMessage());
write(new GetServerListMessage());
// write(new GetSharedDirsMessage());
// write(new GetSharedFilesMessage());
SearchManager.getInstance().add(OvernetPlugin.getInstance());
}
public void run()
{
try {
select();
OvernetCore.this.setState(State.DISCONNECTING);
OvernetCore.this.setState(State.DISCONNECTED);
}
catch (IOException ie) {
logger.debug("overnet core connection", ie);
OvernetCore.this.setState(State.DISCONNECTED,
ie.getLocalizedMessage());
}
}
private void select() throws IOException
{
selector = Selector.open();
channel.register(selector, SelectionKey.OP_CONNECT);
while (selector.select() > 0 && !die) {
for (Iterator i = selector.selectedKeys().iterator();
i.hasNext();) {
SelectionKey key = (SelectionKey)i.next();
i.remove();
SocketChannel sc = (SocketChannel)key.channel();
if (key.isConnectable()) {
if (sc.isConnectionPending()) {
logger.debug("finish connect");
try {
if (sc.finishConnect()) {
OvernetCore.this.setState(State.CONNECTED);
}
else {
throw new
IOException("finish connect failed");
}
}
catch (ConnectException ce) {
logger.debug("connect exp", ce);
throw new ConnectException(XNap.tr("Could not connect to overnet daemon\nThis can have several reasons:\n-overnet is not installed.This plugin requires an external program called overnet that handles the network connection. Please see http://www.overnet.com/ for more information and download links.\n-The plugin settings are incorrect, e.g. the overnet daemon port is wrong. Please check the settings under Settings -> Configure Plugins.\n-The overnet daemon is not running: Please start it manually or configure XNap to start it for you and restart XNap.\n"));
}
}
}
else if (key.isReadable()) {
read();
}
else if (key.isWritable()) {
write();
}
}
}
}
private void disconnect()
{
// that's what the gtk gui sends on deliberate shutdown
// this shouldn't be sent here
write(new StopDownloadStatusMessage());
write(new StopUploadStatusMessage());
write(new GetSharedFilesMessage());
}
/**
* Clean up and close channel.
*/
private void close()
{
if (channel != null) {
try {
logger.debug("closing channel");
channel.socket().shutdownInput();
channel.socket().shutdownOutput();
channel.socket().close();
}
catch (IOException ie) {
logger.debug("closing channel", ie);
}
}
SearchManager.getInstance().remove(OvernetPlugin.getInstance());
}
}
}
The table below shows all metrics for OvernetCore.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 78.00 | Number of blocks | |
| BLOCK_COMMENT | 22.00 | Number of block comment lines | |
| COMMENTS | 82.00 | Comment lines | |
| COMMENT_DENSITY | 0.30 | Comment density | |
| COMPARISONS | 38.00 | Number of comparison operators | |
| CYCLOMATIC | 67.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 19.00 | Comments in declarations | |
| DOC_COMMENT | 43.00 | Number of javadoc comment lines | |
| ELOC | 269.00 | Effective lines of code | |
| EXEC_COMMENTS | 11.00 | Comments in executable code | |
| EXITS | 103.00 | Procedure exits | |
| FUNCTIONS | 28.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 0.54 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 59.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 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains 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 | 2.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 | 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 | 2.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 2.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 1.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 | 0.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 | 1.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 6.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 | 1.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 1.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 1.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 2.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 1.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1079.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 | 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 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 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 | 0.00 | JAVA0288 Inconsistent null check | |
| JAVA0289 | 1.00 | null | |
| LINES | 518.00 | Number of lines in the source file | |
| LINE_COMMENT | 17.00 | Number of line comments | |
| LOC | 379.00 | Lines of code | |
| LOGICAL_LINES | 178.00 | Number of statements | |
| LOOPS | 4.00 | Number of loops | |
| NEST_DEPTH | 7.00 | Maximum nesting depth | |
| OPERANDS | 799.00 | Number of operands | |
| OPERATORS | 1546.00 | Number of operators | |
| PARAMS | 16.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2345.00 | Halstead program length | |
| PROGRAM_VOCAB | 330.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 43.00 | Number of return points from functions | |
| SIZE | 13462.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 278.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 52.00 | Number of unique operators | |
| WHITESPACE | 57.00 | Number of whitespace lines | |