ItemActionHelper.java
| Index Score | ||
|---|---|---|
 |
 |
com.zimbra.cs.service.mail |
 |
 |
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 |  |
| INTERFACE_COMPLEXITY | Interface complexity | |
| PARAMS | Number of formal parameter declarations | |
| RETURNS | Number of return points from functions | |
| EXITS | Procedure exits | |
| OPERANDS | Number of operands | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| CYCLOMATIC | Cyclomatic complexity | |
| OPERATORS | Number of operators | |
| COMPARISONS | Number of comparison operators | |
| SIZE | Size of the file in bytes | |
| ELOC | Effective lines of code | |
| LOGICAL_LINES | Number of statements | |
| JAVA0138 | JAVA0138 N parameters defined for method (maximum: M) | |
| LOC | Lines of code | |
| LINES | Number of lines in the source file | |
| JAVA0040 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0031 | JAVA0031 Case statement not properly closed | |
| UNIQUE_OPERATORS | Number of unique operators | |
| FUNCTIONS | Number of function declarations | |
| JAVA0071 | JAVA0071 Strings compared with == | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| EXEC_COMMENTS | Comments in executable code | |
| LINE_COMMENT | Number of line comments | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| LOOPS | Number of loops | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| COMMENTS | Comment lines | |
| DOC_COMMENT | Number of javadoc comment lines | |
| BLOCKS | Number of blocks | |
| DECL_COMMENTS | Comments in 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) 2006 Zimbra, Inc.
* All Rights Reserved.
*
* Contributor(s):
*
* ***** END LICENSE BLOCK *****
*/
package com.zimbra.cs.service.mail;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;
import org.dom4j.QName;
import com.zimbra.common.service.ServiceException;
import com.zimbra.common.soap.Element;
import com.zimbra.common.soap.MailConstants;
import com.zimbra.common.util.ByteUtil;
import com.zimbra.common.util.Pair;
import com.zimbra.common.util.ZimbraLog;
import com.zimbra.cs.account.Account;
import com.zimbra.cs.account.AuthToken;
import com.zimbra.cs.account.AuthTokenException;
import com.zimbra.cs.account.Provisioning;
import com.zimbra.cs.mailbox.*;
import com.zimbra.cs.mailbox.MailItem.TargetConstraint;
import com.zimbra.cs.mailbox.Mailbox.OperationContext;
import com.zimbra.cs.mailbox.calendar.Invite;
import com.zimbra.cs.mime.Mime;
import com.zimbra.cs.service.util.ItemId;
import com.zimbra.cs.service.util.ItemIdFormatter;
import com.zimbra.cs.service.util.SpamHandler;
import com.zimbra.cs.util.AccountUtil;
import com.zimbra.cs.zclient.ZMailbox;
public class ItemActionHelper {
public static ItemActionHelper TAG(OperationContext oc, Mailbox mbox,
List<Integer> ids, byte type, boolean flagValue,
TargetConstraint tcon, int tagId)
throws ServiceException {
ItemActionHelper ia = new ItemActionHelper(oc, mbox,
ids, Op.TAG, type, flagValue, tcon);
ia.setTagId(tagId);
ia.schedule();
return ia;
}
public static ItemActionHelper FLAG(OperationContext oc, Mailbox mbox,
List<Integer> ids, byte type, boolean flagValue,
TargetConstraint tcon)
throws ServiceException {
ItemActionHelper ia = new ItemActionHelper(oc, mbox,
ids, Op.FLAG, type, flagValue, tcon);
ia.schedule();
return ia;
}
public static ItemActionHelper READ(OperationContext oc, Mailbox mbox,
List<Integer> ids, byte type, boolean flagValue,
TargetConstraint tcon)
throws ServiceException {
ItemActionHelper ia = new ItemActionHelper(oc, mbox,
ids, Op.READ, type, flagValue, tcon);
ia.schedule();
return ia;
}
public static ItemActionHelper COLOR(OperationContext oc, Mailbox mbox,
List<Integer> ids, byte type, TargetConstraint tcon,
byte color)
throws ServiceException {
ItemActionHelper ia = new ItemActionHelper(oc, mbox,
ids, Op.COLOR, type, true, tcon);
ia.setColor(color);
ia.schedule();
return ia;
}
public static ItemActionHelper HARD_DELETE(OperationContext oc, Mailbox mbox,
List<Integer> ids, byte type, TargetConstraint tcon)
throws ServiceException {
ItemActionHelper ia = new ItemActionHelper(oc, mbox,
ids, Op.HARD_DELETE, type, true, tcon);
ia.schedule();
return ia;
}
public static ItemActionHelper MOVE(OperationContext oc, Mailbox mbox,
List<Integer> ids, byte type, TargetConstraint tcon,
ItemId iidFolder)
throws ServiceException {
ItemActionHelper ia = new ItemActionHelper(oc, mbox,
ids, Op.MOVE, type, true, tcon);
ia.setIidFolder(iidFolder);
ia.schedule();
return ia;
}
public static ItemActionHelper COPY(OperationContext oc, Mailbox mbox,
List<Integer> ids, byte type, TargetConstraint tcon,
ItemId iidFolder)
throws ServiceException {
ItemActionHelper ia = new ItemActionHelper(oc, mbox,
ids, Op.COPY, type, true, tcon);
ia.setIidFolder(iidFolder);
ia.schedule();
return ia;
}
public static ItemActionHelper SPAM(OperationContext oc, Mailbox mbox,
List<Integer> ids, byte type, boolean flagValue,
TargetConstraint tcon, int folderId)
throws ServiceException {
ItemActionHelper ia = new ItemActionHelper(oc, mbox,
ids, Op.SPAM, type, flagValue, tcon);
ia.setFolderId(folderId);
ia.schedule();
return ia;
}
public static ItemActionHelper TRASH(OperationContext oc, Mailbox mbox,
List<Integer> ids,
byte type, TargetConstraint tcon) throws ServiceException {
ItemActionHelper ia = new ItemActionHelper(oc, mbox,
ids, Op.TRASH, type, true, tcon);
ia.schedule();
return ia;
}
public static ItemActionHelper RENAME(OperationContext oc, Mailbox mbox,
List<Integer> ids, byte type, TargetConstraint tcon,
String name, ItemId iidFolder)
throws ServiceException {
ItemActionHelper ia = new ItemActionHelper(oc, mbox,
ids, Op.RENAME, type, true, tcon);
ia.setName(name);
ia.setIidFolder(iidFolder);
ia.schedule();
return ia;
}
public static ItemActionHelper UPDATE(OperationContext oc, Mailbox mbox,
List<Integer> ids, byte type, TargetConstraint tcon,
String name, ItemId iidFolder, String flags,
String tags, byte color)
throws ServiceException {
ItemActionHelper ia = new ItemActionHelper(oc, mbox,
ids, Op.UPDATE, type, true, tcon);
ia.setName(name);
ia.setIidFolder(iidFolder);
ia.setFlags(flags);
ia.setTags(tags);
ia.setColor(color);
ia.schedule();
return ia;
}
public static enum Op {
TAG("tag"),
FLAG("flag"),
READ("read"),
COLOR("color"),
HARD_DELETE("delete"),
MOVE("move"),
COPY("copy"),
SPAM("spam"),
TRASH("trash"),
RENAME("rename"),
UPDATE("update")
;
private Op(String str) {
mStr = str;
}
public String toString() { return mStr; }
private String mStr;
}
protected String mResult;
protected List<String> mCreatedIds;
protected Op mOperation;
protected int[] mIds;
protected byte mItemType;
protected boolean mFlagValue;
protected TargetConstraint mTargetConstraint;
// only when Op=TAG
protected int mTagId;
// only when OP=COLOR or OP=UPDATE
protected byte mColor;
// only when OP=RENAME or OP=UPDATE
protected String mName;
// only when OP=MOVE or OP=RENAME or OP=UPDATE
protected ItemId mIidFolder;
// only when OP=SPAM
protected int mFolderId;
// only when OP=UPDATE
protected String mFlags;
protected String mTags;
protected ItemIdFormatter mIdFormatter;
protected Account mAuthenticatedAccount;
public String toString() {
StringBuilder toRet = new StringBuilder(super.toString());
toRet.append(" Op=").append(mOperation.toString());
toRet.append(" Type=").append(mItemType);
toRet.append(" FlagValue=").append(mFlagValue);
if (mTargetConstraint != null)
toRet.append(" TargetConst=").append(mTargetConstraint.toString());
if (mOperation == Op.TAG)
toRet.append(" TagId=").append(mTagId);
if (mOperation == Op.COLOR || mOperation == Op.UPDATE)
toRet.append(" Color=").append(mColor);
if (mOperation == Op.MOVE || mOperation == Op.UPDATE)
toRet.append(" iidFolder=").append(mIidFolder);
if (mOperation == Op.SPAM)
toRet.append(" folderId=").append(mFolderId);
if (mOperation == Op.UPDATE) {
if (mFlags != null)
toRet.append(" flags=").append(mFlags);
if (mTags != null)
toRet.append(" tags=").append(mTags);
}
return toRet.toString();
}
public void setTagId(int tagId) {
assert(mOperation == Op.TAG);
mTagId = tagId;
}
public void setColor(byte color) {
assert(mOperation == Op.COLOR || mOperation == Op.UPDATE);
mColor = color;
}
public void setName(String name) {
assert(mOperation == Op.RENAME || mOperation == Op.UPDATE);
mName = name;
}
public void setIidFolder(ItemId iidFolder) {
assert(mOperation == Op.MOVE || mOperation == Op.RENAME || mOperation == Op.UPDATE);
mIidFolder = iidFolder;
}
public void setFolderId(int folderId) {
assert(mOperation == Op.SPAM);
mFolderId = folderId;
}
public void setFlags(String flags) {
assert(mOperation == Op.UPDATE);
mFlags = flags;
}
public void setTags(String tags) {
assert(mOperation == Op.UPDATE);
mTags = tags;
}
ItemActionHelper(OperationContext octxt, Mailbox mbox,
List<Integer> ids,
Op op, byte type, boolean flagValue,
TargetConstraint tcon)
throws ServiceException {
mOpCtxt = octxt;
mMailbox = mbox;
mAuthenticatedAccount = octxt == null ? null : octxt.getAuthenticatedUser();
if (mAuthenticatedAccount == null)
mAuthenticatedAccount = mbox.getAccount();
mIdFormatter = new ItemIdFormatter(mAuthenticatedAccount, mbox, false);
int i = 0;
mIds = new int[ids.size()];
for (int id : ids)
mIds[i++] = id;
mOperation = op;
if (mOperation == null)
throw ServiceException.INVALID_REQUEST("unknown operation: null", null);
mItemType = type;
mFlagValue = flagValue;
mTargetConstraint = tcon;
}
private OperationContext mOpCtxt;
private Mailbox mMailbox;
protected Mailbox getMailbox() { return mMailbox; }
protected OperationContext getOpCtxt() { return mOpCtxt; }
protected void schedule() throws ServiceException {
boolean movable = mOperation == Op.MOVE || mOperation == Op.COPY || mOperation == Op.RENAME || mOperation == Op.UPDATE;
// deal with local mountpoints pointing at local folders here
if (movable && mIidFolder.belongsTo(mMailbox) && mIidFolder.getId() > 0) {
Folder folder = mMailbox.getFolderById(mOpCtxt, mIidFolder.getId());
if (folder instanceof Mountpoint && !((Mountpoint) folder).getOwnerId().equals(mIidFolder.getAccountId()))
mIidFolder = new ItemId(((Mountpoint) folder).getOwnerId(), ((Mountpoint) folder).getRemoteId());
}
try {
if (movable && !mIidFolder.belongsTo(mMailbox))
executeRemote();
else
executeLocal();
} catch (IOException ioe) {
throw ServiceException.FAILURE("exception reading item blob", ioe);
}
StringBuilder successes = new StringBuilder();
for (int id : mIds)
successes.append(successes.length() > 0 ? "," : "").append(mIdFormatter.formatItemId(id));
mResult = successes.toString();
}
public String getResult() {
return mResult;
}
public List<String> getCreatedIds() {
return mCreatedIds;
}
private void executeLocal() throws ServiceException {
// iterate over the local items and perform the requested operation
switch (mOperation) {
case FLAG:
getMailbox().alterTag(getOpCtxt(), mIds, mItemType, Flag.ID_FLAG_FLAGGED, mFlagValue, mTargetConstraint);
break;
case READ:
getMailbox().alterTag(getOpCtxt(), mIds, mItemType, Flag.ID_FLAG_UNREAD, !mFlagValue, mTargetConstraint);
break;
case TAG:
getMailbox().alterTag(getOpCtxt(), mIds, mItemType, mTagId, mFlagValue, mTargetConstraint);
break;
case COLOR:
getMailbox().setColor(getOpCtxt(), mIds, mItemType, mColor);
break;
case HARD_DELETE:
getMailbox().delete(getOpCtxt(), mIds, mItemType, mTargetConstraint);
break;
case MOVE:
getMailbox().move(getOpCtxt(), mIds, mItemType, mIidFolder.getId(), mTargetConstraint);
break;
case COPY:
List<MailItem> copies = getMailbox().copy(getOpCtxt(), mIds, mItemType, mIidFolder.getId());
mCreatedIds = new ArrayList<String>(mIds.length);
for (MailItem item : copies)
mCreatedIds.add(mIdFormatter.formatItemId(item));
break;
case SPAM:
getMailbox().move(getOpCtxt(), mIds, mItemType, mFolderId, mTargetConstraint);
for (int id : mIds)
SpamHandler.getInstance().handle(getMailbox(), id, mItemType, mFlagValue);
break;
case TRASH:
try {
// in general, everything will work fine, so just blindly try to move the targets to trash
getMailbox().move(getOpCtxt(), mIds, mItemType, Mailbox.ID_FOLDER_TRASH, mTargetConstraint);
} catch (ServiceException e) {
if (!e.getCode().equals(MailServiceException.ALREADY_EXISTS))
throw e;
moveWithRename(Mailbox.ID_FOLDER_TRASH);
}
break;
case RENAME:
for (int id : mIds)
getMailbox().rename(getOpCtxt(), id, mItemType, mName, mIidFolder.getId());
break;
case UPDATE:
if (mName != null) {
for (int id : mIds)
getMailbox().rename(getOpCtxt(), id, mItemType, mName, mIidFolder.getId());
} else if (mIidFolder.getId() > 0) {
getMailbox().move(getOpCtxt(), mIds, mItemType, mIidFolder.getId(), mTargetConstraint);
}
if (mTags != null || mFlags != null)
getMailbox().setTags(getOpCtxt(), mIds, mItemType, mFlags, mTags, mTargetConstraint);
if (mColor >= 0)
getMailbox().setColor(getOpCtxt(), mIds, mItemType, mColor);
break;
default:
throw ServiceException.INVALID_REQUEST("unknown operation: " + mOperation, null);
}
}
private void moveWithRename(int targetId) throws ServiceException {
// naming conflict; handle on an item-by-item basis
for (int id : mIds) {
try {
// still more likely than not to succeed...
getMailbox().move(getOpCtxt(), id, mItemType, targetId, mTargetConstraint);
} catch (ServiceException e) {
if (!e.getCode().equals(MailServiceException.ALREADY_EXISTS))
throw e;
// rename the item being moved instead of the one already there...
String name = getMailbox().getItemById(getOpCtxt(), id, mItemType).getName();
String uuid = '{' + UUID.randomUUID().toString() + '}', newName;
if (name.length() + uuid.length() > MailItem.MAX_NAME_LENGTH)
newName = name.substring(0, MailItem.MAX_NAME_LENGTH - uuid.length()) + uuid;
else
newName = name + uuid;
// FIXME: relying on the fact that conversations collect things that don't cause naming conflicts
getMailbox().rename(getOpCtxt(), id, mItemType, newName, targetId);
}
}
}
private void executeRemote() throws ServiceException, IOException {
String authtoken;
try {
authtoken = new AuthToken(mAuthenticatedAccount).getEncoded();
} catch (AuthTokenException e) {
throw ServiceException.FAILURE("could not get auth token", e);
}
Account target = Provisioning.getInstance().get(Provisioning.AccountBy.id, mIidFolder.getAccountId());
ZMailbox.Options zoptions = new ZMailbox.Options(authtoken, AccountUtil.getSoapUri(target));
zoptions.setNoSession(true);
ZMailbox zmbx = ZMailbox.getMailbox(zoptions);
boolean deleteOriginal = mOperation != Op.COPY;
String folderStr = mIidFolder.toString();
mCreatedIds = new ArrayList<String>(mIds.length);
for (MailItem item : mMailbox.getItemById(mOpCtxt, mIds, mItemType)) {
if (item == null)
continue;
if (deleteOriginal && (mMailbox.getEffectivePermissions(mOpCtxt, item.getId(), item.getType()) & ACL.RIGHT_DELETE) == 0)
throw ServiceException.PERM_DENIED("cannot delete existing copy of " + MailItem.getNameForType(item) + " " + item.getId());
// since we can't apply tags to a remote object, hardwiring "tags" to null below...
String flags = (mOperation == Op.UPDATE && mFlags != null ? mFlags : item.getFlagString());
String name = ((mOperation == Op.RENAME || mOperation == Op.UPDATE) && mName != null ? mName : item.getName());
String createdId = null;
switch (item.getType()) {
case MailItem.TYPE_CONTACT:
createdId = zmbx.createContact(folderStr, null, ((Contact) item).getFields());
mCreatedIds.add(createdId);
break;
case MailItem.TYPE_VIRTUAL_CONVERSATION:
item = mMailbox.getMessageById(mOpCtxt, ((VirtualConversation) item).getMessageId());
// fall through...
case MailItem.TYPE_MESSAGE:
createdId = zmbx.addMessage(folderStr, flags, null, item.getDate(), ((Message) item).getContent(), true);
mCreatedIds.add(createdId);
break;
case MailItem.TYPE_CONVERSATION:
for (Message msg : mMailbox.getMessagesByConversation(mOpCtxt, item.getId(), Conversation.SORT_DATE_ASCENDING)) {
if (!TargetConstraint.checkItem(mTargetConstraint, msg))
continue;
flags = (mOperation == Op.UPDATE && mFlags != null ? mFlags : msg.getFlagString());
createdId = zmbx.addMessage(folderStr, flags, null, msg.getDate(), msg.getContent(), true);
mCreatedIds.add(createdId);
}
break;
case MailItem.TYPE_DOCUMENT:
Document doc = (Document) item;
byte[] content = ByteUtil.getContent(doc.getRawDocument(), doc.getSize());
String uploadId = zmbx.uploadAttachment(name, content, doc.getContentType(), 4000);
createdId = zmbx.createDocument(folderStr, name, uploadId);
mCreatedIds.add(createdId);
break;
case MailItem.TYPE_WIKI:
createdId = zmbx.createWiki(folderStr, name, new String(((WikiItem) item).getMessageContent(), "utf-8"));
mCreatedIds.add(createdId);
break;
case MailItem.TYPE_APPOINTMENT:
case MailItem.TYPE_TASK:
QName qname = (item.getType() == MailItem.TYPE_TASK ? MailConstants.SET_TASK_REQUEST : MailConstants.SET_APPOINTMENT_REQUEST);
Element request = new Element.XMLElement(qname).addAttribute(MailConstants.A_FOLDER, folderStr).addAttribute(MailConstants.A_FLAGS, flags);
CalendarItem cal = (CalendarItem) item;
Invite invDefault = cal.getDefaultInviteOrNull();
if (invDefault == null)
throw ServiceException.FAILURE("cannot copy: no default invite for " + MailItem.getNameForType(item) + " " + item.getId(), null);
addCalendarPart(request.addUniqueElement(MailConstants.A_DEFAULT), cal, invDefault, zmbx, target);
for (Invite inv : cal.getInvites()) {
if (inv == null || inv == invDefault)
continue;
else if (inv.isCancel())
addCalendarPart(request.addUniqueElement(MailConstants.E_CAL_CANCEL), cal, inv, zmbx, target);
else
addCalendarPart(request.addUniqueElement(MailConstants.E_CAL_EXCEPT), cal, inv, zmbx, target);
}
createdId = zmbx.invoke(request).getAttribute(MailConstants.A_CAL_ID);
mCreatedIds.add(createdId);
break;
default:
throw MailServiceException.CANNOT_COPY(item.getId());
}
try {
if (deleteOriginal && !mIdFormatter.formatItemId(item).equals(createdId))
mMailbox.delete(mOpCtxt, item.getId(), item.getType());
} catch (ServiceException e) {
if (e.getCode() != ServiceException.PERM_DENIED)
throw e;
// something funky happened permissions-wise between the getEffectivePermissions check and here...
ZimbraLog.misc.info("could not delete original item " + item.getId() + "; treating operation as a copy instead");
}
}
}
private Element addCalendarPart(Element parent, CalendarItem cal, Invite inv, ZMailbox zmbx, Account target) throws ServiceException {
Element m = parent.addUniqueElement(MailConstants.E_MSG);
Pair<MimeMessage, Integer> spinfo = cal.getSubpartMessageData(inv.getMailItemId());
if (spinfo != null) {
try {
ByteArrayOutputStream baos = new ByteArrayOutputStream(spinfo.getSecond());
spinfo.getFirst().writeTo(baos);
String uploadId = zmbx.uploadAttachment("message", baos.toByteArray(), Mime.CT_MESSAGE_RFC822, 6000);
m.addAttribute(MailConstants.A_ATTACHMENT_ID, uploadId);
} catch (IOException ioe) {
ZimbraLog.misc.info("could not read subpart message for part " + inv.getComponentNum() + " of item " + cal.getId(), ioe);
} catch (MessagingException me) {
ZimbraLog.misc.info("could not read subpart message for part " + inv.getComponentNum() + " of item " + cal.getId(), me);
}
}
// explicitly add the invite metadata here
ToXML.encodeInvite(m, mIdFormatter, cal, inv);
// fix up the Organizer if needed
for (Element comp : m.getElement(MailConstants.E_INVITE).listElements(MailConstants.E_INVITE_COMPONENT)) {
if (comp.getAttributeBool(MailConstants.A_CAL_ISORG, false) && comp.getOptionalElement(MailConstants.E_CAL_ORGANIZER) != null) {
comp.getOptionalElement(MailConstants.E_CAL_ORGANIZER).detach();
comp.addUniqueElement(MailConstants.E_CAL_ORGANIZER).addAttribute(MailConstants.A_ADDRESS, target.getName())
.addAttribute(MailConstants.A_DISPLAY, target.getAttr(Provisioning.A_displayName));
}
}
return m;
}
}
The table below shows all metrics for ItemActionHelper.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 55.00 | Number of blocks | |
| BLOCK_COMMENT | 24.00 | Number of block comment lines | |
| COMMENTS | 42.00 | Comment lines | |
| COMMENT_DENSITY | 0.10 | Comment density | |
| COMPARISONS | 81.00 | Number of comparison operators | |
| CYCLOMATIC | 116.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 7.00 | Comments in declarations | |
| DOC_COMMENT | 0.00 | Number of javadoc comment lines | |
| ELOC | 419.00 | Effective lines of code | |
| EXEC_COMMENTS | 12.00 | Comments in executable code | |
| EXITS | 111.00 | Procedure exits | |
| FUNCTIONS | 31.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 94.86 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 199.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 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 | 1.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 | 27.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 | 1.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 | 1.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 | 1.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 | 0.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 | 1.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 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 23.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.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 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 10.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 10.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.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 | 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 | 1.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 587.00 | Number of lines in the source file | |
| LINE_COMMENT | 18.00 | Number of line comments | |
| LOC | 467.00 | Lines of code | |
| LOGICAL_LINES | 250.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 3.00 | Maximum nesting depth | |
| OPERANDS | 1541.00 | Number of operands | |
| OPERATORS | 2459.00 | Number of operators | |
| PARAMS | 92.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 4000.00 | Halstead program length | |
| PROGRAM_VOCAB | 520.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 107.00 | Number of return points from functions | |
| SIZE | 24384.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 463.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 57.00 | Number of unique operators | |
| WHITESPACE | 78.00 | Number of whitespace lines | |