FileLogWriter.java
| Index Score | ||
|---|---|---|
 |
 |
com.zimbra.cs.redolog.logger |
 |
 |
Zimbra Collaboration Suite |
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 | |
|---|---|---|
| JAVA0034 | JAVA0034 Missing braces in if statement |  |
| JAVA0143 | JAVA0143 Synchronized method | |
| LINE_COMMENT | Number of line comments | |
| EXEC_COMMENTS | Comments in executable code | |
| EXITS | Procedure exits | |
| RETURNS | Number of return points from functions | |
| LOGICAL_LINES | Number of statements | |
| UNIQUE_OPERATORS | Number of unique operators | |
| SIZE | Size of the file in bytes | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| BLOCKS | Number of blocks | |
| DECL_COMMENTS | Comments in declarations | |
| ELOC | Effective lines of code | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| PROGRAM_VOLUME | Halstead program volume | |
| LOC | Lines of code | |
| UNIQUE_OPERANDS | Number of unique operands | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINES | Number of lines in the source file | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0087 | JAVA0087 Use of Thread.sleep() | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| OPERATORS | Number of operators | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| PROGRAM_LENGTH | Halstead program length | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 ("License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.zimbra.com/license
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is: Zimbra Collaboration Suite Server.
*
* The Initial Developer of the Original Code is Zimbra, Inc.
* Portions created by Zimbra are Copyright (C) 2004, 2005, 2006 Zimbra, Inc.
* All Rights Reserved.
*
* Contributor(s):
*
* ***** END LICENSE BLOCK *****
*/
/*
* Created on 2004. 11. 12.
*
* TODO To change the template for this generated file go to
* Window - Preferences - Java - Code Generation - Code and Comments
*/
package com.zimbra.cs.redolog.logger;
import java.io.File;
import java.io.FileDescriptor;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
import com.zimbra.common.util.Log;
import com.zimbra.common.util.LogFactory;
import com.zimbra.common.service.ServiceException;
import com.zimbra.cs.account.Provisioning;
import com.zimbra.cs.redolog.RedoConfig;
import com.zimbra.cs.redolog.RedoLogManager;
import com.zimbra.cs.redolog.RolloverManager;
import com.zimbra.cs.redolog.op.RedoableOp;
import com.zimbra.cs.util.Zimbra;
/**
* @author jhahm
*
* TODO To change the template for this generated type comment go to
* Window - Preferences - Java - Code Generation - Code and Comments
*/
public class FileLogWriter implements LogWriter {
private static Log mLog = LogFactory.getLog(FileLogWriter.class);
private static String sServerId;
static {
try {
sServerId = Provisioning.getInstance().getLocalServer().getId();
} catch (ServiceException e) {
mLog.error("Unable to get local server ID", e);
sServerId = "unknown";
}
}
protected RedoLogManager mRedoLogMgr;
// Synchronizes access to mRAF, mFileSize, mLogSeq, mFsyncSeq,
// mLogCount, mFsyncCount, and mFsyncTime.
private final Object mLock = new Object();
// wait/notify between logger threads and fsync thread
private final Object mFsyncCond = new Object();
private FileHeader mHeader;
private long mFirstOpTstamp;
private long mLastOpTstamp;
private File mFile;
private RandomAccessFile mRAF;
private FileDescriptor mFD;
private long mFileSize;
private long mLastLogTime;
private long mFsyncIntervalMS; // how many milliseconds fsync thread sleeps after each fync
private FsyncThread mFsyncer; // fsync thread
private int mLogSeq; // last item logged
private int mFsyncSeq; // last item fsynced
// for gathering some stats; nonessential for functionality
private int mLogCount; // how many times log was called
private int mFsyncCount; // how many times fsync was called
private long mFsyncTime; // sum of sync durations
public FileLogWriter(RedoLogManager redoLogMgr,
File logfile,
long fsyncIntervalMS) {
mRedoLogMgr = redoLogMgr;
mHeader = new FileHeader(sServerId);
mFile = logfile;
mFileSize = mFile.length();
mLastLogTime = mFile.lastModified();
mFsyncIntervalMS = fsyncIntervalMS;
mFsyncCount = mLogCount = 0;
mFsyncTime = 0;
}
public long getSequence() {
synchronized (mLock) {
return mHeader.getSequence();
}
}
/* (non-Javadoc)
* @see com.zimbra.cs.redolog.LogWriter#getSize()
*/
public long getSize() {
synchronized (mLock) {
return mFileSize;
}
}
/* (non-Javadoc)
* @see com.zimbra.cs.redolog.logger.LogWriter#getLastLogTime()
*/
public long getLastLogTime() {
synchronized (mLock) {
return mLastLogTime;
}
}
/* (non-Javadoc)
* @see com.zimbra.cs.redolog.logger.LogWriter#isEmpty()
*/
public boolean isEmpty() throws IOException {
return getSize() <= FileHeader.HEADER_LEN;
}
/* (non-Javadoc)
* @see com.zimbra.cs.redolog.logger.LogWriter#exists()
*/
public boolean exists() {
return mFile.exists();
}
/* (non-Javadoc)
* @see com.zimbra.cs.redolog.LogWriter#getAbsolutePath()
*/
public String getAbsolutePath() {
return mFile.getAbsolutePath();
}
/* (non-Javadoc)
* @see com.zimbra.cs.redolog.LogWriter#renameTo()
*/
public boolean renameTo(File dest) {
return mFile.renameTo(dest);
}
/* (non-Javadoc)
* @see com.zimbra.cs.redolog.logger.LogWriter#delete()
*/
public boolean delete() {
return mFile.delete();
}
/* (non-Javadoc)
* @see com.zimbra.cs.redolog.LogWriter#open()
*/
public synchronized void open() throws IOException {
synchronized (mLock) {
if (mRAF != null) return; // already open
mRAF = new RandomAccessFile(mFile, "rw");
mFD = mRAF.getFD();
if (mRAF.length() >= FileHeader.HEADER_LEN) {
mHeader.read(mRAF);
mFirstOpTstamp = mHeader.getFirstOpTstamp();
} else {
mHeader.setSequence(mRedoLogMgr.getCurrentLogSequence());
}
mHeader.setOpen(true);
mHeader.write(mRAF);
// go to the end of file, so we can append
long len = mRAF.length();
mRAF.seek(len);
mFileSize = len;
mLogSeq = mFsyncSeq = 0;
}
if (mFsyncIntervalMS > 0)
startFsyncThread();
}
/* (non-Javadoc)
* @see com.zimbra.cs.redolog.LogWriter#close()
*/
public synchronized void close() throws IOException {
stopFsyncThread();
synchronized (mLock) {
if (mRAF != null) {
if (mLastOpTstamp != 0)
mHeader.setLastOpTstamp(mLastOpTstamp);
mHeader.setOpen(false);
mHeader.setFileSize(mRAF.length());
mHeader.write(mRAF);
mFD = null;
mRAF.close();
mRAF = null;
} else
return;
}
// Write some stats, so we can see how many times we were able
// to avoid calling fsync.
if (!mNoStat && mLogCount > 0 && mLog.isDebugEnabled()) {
double msPerSync = 0;
if (mFsyncCount > 0)
msPerSync =
((double) Math.round(
((double) mFsyncTime ) / mFsyncCount * 1000
)) / 1000;
mLog.debug("Logged: " + mLogCount + " items, " +
mFsyncCount + " fsyncs, " + msPerSync + " ms/fsync");
}
}
/**
* Log the supplied bytes. Depending on the value of synchronous argument
* and the setting of fsync interval, this method can do one of 3 things:
*
* case 1: !synchronous
* action: write() only; no flush/fsync
*
* case 2: synchronous && fsyncInterval > 0
* action: write(), then wait() until notified by fsync thread
* Current thread only calls write() on the RandomAccessFile, and blocks to
* wait for the next scheduled fsync. Fsync thread periodically flushes
* the output stream and fsync's the file. After each fsync, all waiting
* logger threads are notified to continue. This method batches multiple
* log items before each fsync, and results in greater throughput than
* calling fsync after each log item because fsync to physical disk is
* a high-latency operation.
*
* case 3: synchronous && fsyncInterval <= 0
* action: write(), then fsync() in the current thread
* Fsync is required, but the sleep interval for fsync thread is 0. We
* special case this condition to mean fsync should be done by the calling
* thread.
*/
public void log(RedoableOp op, byte[][] datav, boolean synchronous) throws IOException {
int seq;
synchronized (mLock) {
if (mRAF == null)
throw new IOException("Redolog file closed");
// Record first transaction in header.
long tstamp = op.getTimestamp();
mLastOpTstamp = tstamp;
if (mFirstOpTstamp == 0) {
mFirstOpTstamp = tstamp;
mHeader.setFirstOpTstamp(mFirstOpTstamp);
mHeader.setLastOpTstamp(mLastOpTstamp);
long pos = mRAF.getFilePointer();
mHeader.write(mRAF);
mRAF.seek(pos);
}
mLogSeq++;
mLogCount++;
seq = mLogSeq;
for (int i = 0; i < datav.length; i++) {
byte[] buf = datav[i];
if (buf != null) {
mRAF.write(buf);
mFileSize += buf.length;
}
}
mLastLogTime = System.currentTimeMillis();
}
// cases 1 above
if (!synchronous)
return;
if (mFsyncIntervalMS > 0) {
// case 2
try {
// wait for fsync thread to write this entry to disk
synchronized (mFsyncCond) {
mFsyncCond.wait(10000);
}
} catch (InterruptedException e) {
mLog.info("Thread interrupted during fsync");
}
synchronized (mLock) {
// timed out, so fsync in this thread
if (seq > mFsyncSeq)
fsync();
}
} else {
// case 3
fsync();
}
}
private boolean mNoStat;
public void noStat(boolean b) {
mNoStat = b;
}
public synchronized File rollover(LinkedHashMap /*<TxnId, RedoableOp>*/ activeOps)
throws IOException {
RolloverManager romgr = mRedoLogMgr.getRolloverManager();
long lastSeq = getSequence();
// Close current log, so it's impossible for its content to change.
noStat(true);
close();
romgr.incrementSequence();
String currentPath = mFile.getAbsolutePath();
// Open a temporary logger.
File tempLogfile = new File(mFile.getParentFile(), romgr.getTempFilename(lastSeq + 1));
FileLogWriter tempLogger =
new FileLogWriter(mRedoLogMgr, tempLogfile, 0);
tempLogger.open();
tempLogger.noStat(true);
// Rewrite change entries for all active operations, maintaining
// their order of occurrence. (LinkedHashMap ensures ordering.)
Set opsSet = activeOps.entrySet();
for (Iterator it = opsSet.iterator(); it.hasNext(); ) {
Map.Entry entry = (Map.Entry) it.next();
RedoableOp op = (RedoableOp) entry.getValue();
tempLogger.log(op, op.getSerializedByteArrayVector(), false);
}
tempLogger.close();
// Rename the current log to rolled-over name.
File rolloverFile = romgr.getRolloverFile(lastSeq);
if (RedoConfig.redoLogDeleteOnRollover()) {
// Delete the current log. We don't need to hold on to the
// indexing-only log files after rollover.
if (!mFile.delete())
throw new IOException("Unable to delete current redo log " + mFile.getAbsolutePath());
} else {
File destDir = rolloverFile.getParentFile();
if (destDir != null && !destDir.exists())
destDir.mkdirs();
if (!mFile.renameTo(rolloverFile))
throw new IOException("Unable to rename current redo log to " + rolloverFile.getAbsolutePath());
}
// Rename the temporary logger to current logfile name.
String tempPath = tempLogfile.getAbsolutePath();
mFile = new File(currentPath);
if (!tempLogfile.renameTo(mFile))
throw new IOException("Unable to rename " + tempPath + " to " + currentPath);
// Reopen current log.
open();
noStat(false);
return rolloverFile;
}
public synchronized void enableFsync() throws IOException {
startFsyncThread();
fsync();
}
public synchronized void disableFsync() throws IOException {
fsync();
stopFsyncThread();
}
private synchronized void startFsyncThread() {
if (mFsyncer == null) {
mFsyncer = new FsyncThread(mFsyncIntervalMS);
mFsyncer.start();
}
}
private synchronized void stopFsyncThread() {
if (mFsyncer != null) {
mFsyncer.stopThread();
mFsyncer = null;
}
}
// do fsync if there are items logged since last fsync
private void fsync() throws IOException {
boolean fsyncNeeded = false;
int seq = 0;
synchronized (mLock) {
if (mFsyncSeq < mLogSeq) {
if (mRAF == null)
throw new IOException("Redolog file closed");
fsyncNeeded = true;
seq = mLogSeq;
mFsyncCount++;
}
}
// no need to synchronize threads for fsync call; just need to get the
// mFD value in synchronized block
if (fsyncNeeded) {
long start = System.currentTimeMillis();
FileDescriptor fd;
synchronized (mLock) {
fd = mFD;
}
if (fd == null)
throw new IOException("log file closed (null file descriptor)");
fd.sync();
long elapsed = System.currentTimeMillis() - start;
mFsyncTime += elapsed;
synchronized (mLock) {
mFsyncSeq = seq;
}
synchronized (mFsyncCond) {
mFsyncCond.notifyAll();
}
}
}
// Thread that calls fsync() periodically. Threads that call log()
// will write the log entry and wait for this thread to signal them
// after sync to disk has occurred. This way, there are fewer fsyncs
// than there are calls to log(), resulting in improved throughput.
private class FsyncThread extends Thread {
private long mSleepMS;
private Object mFsyncLock; // synchronizes access to mRunning
private boolean mRunning;
public FsyncThread(long fsyncIntervalMS) {
super("FileLogWriter.FsyncThread");
mSleepMS = fsyncIntervalMS;
mFsyncLock = new Object();
mRunning = true;
}
public void run() {
boolean running = true;
while (running) {
// Sleep between fsyncs.
try {
Thread.sleep(mSleepMS);
} catch (InterruptedException e) {
mLog.warn("Sync thread interrupted", e);
}
try {
fsync(); // do the sync
} catch (IOException e) {
String message = "Error while fsyncing " + mFile.getAbsolutePath() + "; Aborting.";
Zimbra.halt(message, e);
}
synchronized (mFsyncLock) {
running = mRunning;
}
}
}
// Stop the fsync thread. Wait until the thread really stops.
public void stopThread() {
synchronized (mFsyncLock) {
mRunning = false;
}
try {
join();
} catch (InterruptedException e) {
mLog.warn("InterruptedException while stopping FsyncThread", e);
}
}
}
}
The table below shows all metrics for FileLogWriter.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 64.00 | Number of blocks | |
| BLOCK_COMMENT | 57.00 | Number of block comment lines | |
| COMMENTS | 117.00 | Comment lines | |
| COMMENT_DENSITY | 0.45 | Comment density | |
| COMPARISONS | 31.00 | Number of comparison operators | |
| CYCLOMATIC | 57.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 19.00 | Comments in declarations | |
| DOC_COMMENT | 29.00 | Number of javadoc comment lines | |
| ELOC | 259.00 | Effective lines of code | |
| EXEC_COMMENTS | 17.00 | Comments in executable code | |
| EXITS | 64.00 | Procedure exits | |
| FUNCTIONS | 22.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 75.37 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 65.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 public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 14.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 | 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 | 2.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 1.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 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 | 0.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 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 1.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.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 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 1.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 7.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 12.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 | 2.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 1.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 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 | |
| LINES | 501.00 | Number of lines in the source file | |
| LINE_COMMENT | 31.00 | Number of line comments | |
| LOC | 316.00 | Lines of code | |
| LOGICAL_LINES | 176.00 | Number of statements | |
| LOOPS | 3.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 581.00 | Number of operands | |
| OPERATORS | 1211.00 | Number of operators | |
| PARAMS | 10.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1792.00 | Halstead program length | |
| PROGRAM_VOCAB | 267.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 55.00 | Number of return points from functions | |
| SIZE | 16176.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 212.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 55.00 | Number of unique operators | |
| WHITESPACE | 68.00 | Number of whitespace lines | |