FeedManager.java
| Index Score | ||
|---|---|---|
 |
 |
com.zimbra.cs.service |
 |
 |
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 |  |
| EXITS | Procedure exits | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| OPERANDS | Number of operands | |
| CYCLOMATIC | Cyclomatic complexity | |
| COMPARISONS | Number of comparison operators | |
| PROGRAM_LENGTH | Halstead program length | |
| EXEC_COMMENTS | Comments in executable code | |
| OPERATORS | Number of operators | |
| LOGICAL_LINES | Number of statements | |
| RETURNS | Number of return points from functions | |
| SIZE | Size of the file in bytes | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| ELOC | Effective lines of code | |
| JAVA0076 | JAVA0076 Use of magic number | |
| JAVA0008 | JAVA0008 Empty catch block | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| LINE_COMMENT | Number of line comments | |
| LOC | Lines of code | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0007 | JAVA0007 Should not declare public field | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| BLOCKS | Number of blocks | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| JAVA0035 | JAVA0035 Missing braces in for statement | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| LINES | Number of lines in the source file | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| DECL_COMMENTS | Comments in declarations | |
| DOC_COMMENT | Number of javadoc comment lines | |
| COMMENTS | Comment lines | |
| WHITESPACE | Number of whitespace lines | |
| 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) 2005, 2006 Zimbra, Inc.
* All Rights Reserved.
*
* Contributor(s):
*
* ***** END LICENSE BLOCK *****
*/
/*
* Created on Oct 23, 2005
*/
package com.zimbra.cs.service;
import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.StringReader;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.util.ArrayList;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import javax.mail.BodyPart;
import javax.mail.MessagingException;
import javax.mail.internet.ContentType;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeBodyPart;
import javax.mail.internet.MimeMessage;
import javax.mail.internet.MimeMultipart;
import javax.mail.internet.MimePart;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.httpclient.Header;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpException;
import org.apache.commons.httpclient.HttpURL;
import org.apache.commons.httpclient.HttpsURL;
import org.apache.commons.httpclient.UsernamePasswordCredentials;
import org.apache.commons.httpclient.auth.AuthScope;
import org.apache.commons.httpclient.methods.GetMethod;
import org.apache.commons.httpclient.params.HttpMethodParams;
import com.zimbra.cs.account.Account;
import com.zimbra.cs.account.ldap.LdapUtil;
import com.zimbra.cs.mailbox.Folder;
import com.zimbra.cs.mailbox.calendar.Invite;
import com.zimbra.cs.mailbox.calendar.ZCalendar.ZCalendarBuilder;
import com.zimbra.cs.mailbox.calendar.ZCalendar.ZVCalendar;
import com.zimbra.cs.mime.Mime;
import com.zimbra.cs.mime.ParsedMessage;
import com.zimbra.common.service.ServiceException;
import com.zimbra.common.util.DateUtil;
import com.zimbra.common.util.FileUtil;
import com.zimbra.common.soap.Element;
import com.zimbra.cs.util.JMSession;
import com.zimbra.cs.util.NetUtil;
/**
* @author dkarp
*/
public class FeedManager {
public static final class SubscriptionData {
public List items;
public String lastGuid;
public long lastDate = -1;
public long feedDate = System.currentTimeMillis();
SubscriptionData() { items = new ArrayList(); }
SubscriptionData(List list) { items = list; }
SubscriptionData(long fdate) { items = new ArrayList(); feedDate = fdate; }
void recordItem(String guid, long date, Object item) {
items.add(item);
if (date > lastDate) { lastGuid = guid; lastDate = date; }
}
}
public static final int MAX_REDIRECTS = 3;
public static final String HTTP_USER_AGENT = "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322) Zimbra/2.0";
public static final String HTTP_ACCEPT = "image/gif, image/x-xbitmap, image/jpeg, image/pjpeg, application/x-shockwave-flash, application/vnd.ms-powerpoint, application/vnd.ms-excel, application/msword, */*";
public static SubscriptionData retrieveRemoteDatasource(Account acct, String url, Folder.SyncData fsd) throws ServiceException {
HttpClient client = new HttpClient();
NetUtil.configureProxy(client);
client.setConnectionTimeout(10000);
client.setTimeout(20000);
HttpMethodParams params = new HttpMethodParams();
params.setParameter(HttpMethodParams.HTTP_CONTENT_CHARSET, Mime.P_CHARSET_UTF8);
GetMethod get = null;
BufferedInputStream content = null;
try {
String expectedCharset = Mime.P_CHARSET_UTF8;
int redirects = 0;
do {
if (url == null || url.equals(""))
return new SubscriptionData();
String lcurl = url.toLowerCase();
if (lcurl.startsWith("webcal:"))
url = "http:" + url.substring(7);
else if (lcurl.startsWith("feed:"))
url = "http:" + url.substring(5);
else if (!lcurl.startsWith("http:") && !lcurl.startsWith("https:"))
throw ServiceException.INVALID_REQUEST("url must begin with http: or https:", null);
// username and password are encoded in the URL as http://user:pass@host/...
if (url.indexOf('@') != -1) {
HttpURL httpurl = lcurl.startsWith("https:") ? new HttpsURL(url) : new HttpURL(url);
if (httpurl.getUser() != null) {
String user = httpurl.getUser();
if (user.indexOf('%') != -1)
try {
user = URLDecoder.decode(httpurl.getUser());
} catch (Throwable t) { }
UsernamePasswordCredentials creds = new UsernamePasswordCredentials(user, httpurl.getPassword());
client.getParams().setAuthenticationPreemptive(true);
client.getState().setCredentials(AuthScope.ANY, creds);
}
}
get = new GetMethod(url);
get.setParams(params);
get.setFollowRedirects(true);
get.setDoAuthentication(true);
get.addRequestHeader("User-Agent", HTTP_USER_AGENT);
get.addRequestHeader("Accept", HTTP_ACCEPT);
client.executeMethod(get);
Header locationHeader = get.getResponseHeader("location");
if (locationHeader != null) {
// update our target URL and loop again to do another HTTP GET
url = locationHeader.getValue();
get.releaseConnection();
} else if (get.getStatusCode() != HttpServletResponse.SC_OK) {
throw ServiceException.RESOURCE_UNREACHABLE(get.getStatusLine().toString(), null);
} else {
content = new BufferedInputStream(get.getResponseBodyAsStream());
expectedCharset = get.getResponseCharSet();
break;
}
} while (++redirects <= MAX_REDIRECTS);
if (redirects > MAX_REDIRECTS)
throw ServiceException.TOO_MANY_HOPS();
StringBuilder charset = new StringBuilder(expectedCharset);
switch (getLeadingChar(content, charset)) {
case -1:
throw ServiceException.PARSE_ERROR("empty body in response when fetching remote subscription", null);
case '<':
return parseRssFeed(Element.parseXML(content), fsd);
case 'B': case 'b':
Reader reader = new InputStreamReader(content, charset.toString());
List<ZVCalendar> icals = ZCalendarBuilder.buildMulti(reader);
List<Invite> invites = Invite.createFromCalendar(acct, null, icals, false);
// handle missing UIDs on remote calendars by generating them as needed
for (Invite inv : invites)
if (inv.getUid() == null)
inv.setUid(LdapUtil.generateUUID());
return new SubscriptionData(invites);
default:
throw ServiceException.PARSE_ERROR("unrecognized remote content", null);
}
} catch (org.dom4j.DocumentException e) {
throw ServiceException.PARSE_ERROR("could not parse feed", e);
} catch (HttpException e) {
throw ServiceException.RESOURCE_UNREACHABLE("HttpException: " + e, e);
} catch (IOException e) {
throw ServiceException.RESOURCE_UNREACHABLE("IOException: " + e, e);
} finally {
if (get != null)
get.releaseConnection();
}
}
private static int getLeadingChar(BufferedInputStream is, StringBuilder charset) throws IOException {
is.mark(10);
int ch = is.read();
switch (ch) {
case 0xEF:
if (is.read() == 0xBB && is.read() == 0xBF) {
is.mark(1);
ch = is.read(); charset.setLength(0); charset.append("utf-8");
}
break;
case 0xFE:
if (is.read() == 0xFF && is.read() == 0x00) {
ch = is.read(); charset.setLength(0); charset.append("utf-16");
}
break;
case 0xFF:
if (is.read() == 0xFE) {
ch = is.read(); charset.setLength(0); charset.append("utf-16");
}
break;
}
is.reset();
return ch;
}
// private static org.dom4j.QName QN_CONTENT_ENCODED = org.dom4j.QName.get("encoded", "content", "http://purl.org/rss/1.0/modules/content/");
private static final class Enclosure {
private String mUrl, mTitle, mCtype;
Enclosure(String url, String title, String ctype) {
mUrl = url; mTitle = title; mCtype = ctype;
}
String getLocation() { return mUrl; }
String getDescription() { return mTitle; }
String getContentType() {
ContentType ctype;
try {
ctype = new ContentType(mCtype == null ? "text/plain" : mCtype);
} catch (javax.mail.internet.ParseException e) {
ctype = new ContentType("text", "plain", null);
}
try {
ctype.setParameter("name", FileUtil.trimFilename(URLDecoder.decode(mUrl, "utf-8")));
} catch (UnsupportedEncodingException e) {
ctype.setParameter("name", FileUtil.trimFilename(mUrl));
}
return ctype.toString();
}
}
private static SubscriptionData parseRssFeed(Element root, Folder.SyncData fsd) throws ServiceException {
try {
String rname = root.getName();
if (rname.equals("feed"))
return parseAtomFeed(root, fsd);
Element channel = root.getElement("channel");
String hrefChannel = channel.getAttribute("link");
String subjChannel = channel.getAttribute("title");
InternetAddress addrChannel = new InternetAddress("", subjChannel, "utf-8");
Date dateChannel = DateUtil.parseRFC2822Date(channel.getAttribute("lastBuildDate", null), new Date());
List<Enclosure> enclosures = new ArrayList<Enclosure>();
SubscriptionData sdata = new SubscriptionData(dateChannel.getTime());
if (rname.equals("rss"))
root = root.getElement("channel");
else if (!rname.equals("RDF"))
throw ServiceException.PARSE_ERROR("unknown top-level rss element name: " + root.getQualifiedName(), null);
for (Iterator it = root.elementIterator("item"); it.hasNext(); ) {
Element item = (Element) it.next();
// get the item's date
Date date = DateUtil.parseRFC2822Date(item.getAttribute("pubDate", null), null);
if (date == null)
date = DateUtil.parseISO8601Date(item.getAttribute("date", null), dateChannel);
// construct an address for the author
InternetAddress addr = addrChannel;
try {
addr = new InternetAddress(item.getAttribute("author"));
} catch (Exception e) {
addr = parseDublinCreator(item.getAttribute("creator", null), addr);
}
// get the item's title and link, defaulting to the channel attributes
String title = parseTitle(item.getAttribute("title", subjChannel));
String href = item.getAttribute("link", hrefChannel);
String guid = item.getAttribute("guid", href);
// make sure we haven't already seen this item
if (fsd != null && fsd.alreadySeen(guid, date.getTime()))
continue;
// handle the enclosure (associated media link), if any
enclosures.clear();
Element enc = item.getOptionalElement("enclosure");
if (enc != null)
enclosures.add(new Enclosure(enc.getAttribute("url", null), null, enc.getAttribute("type", null)));
// get the feed item's content and guess at its type
String text = item.getAttribute("encoded", null);
boolean html = text != null;
if (text == null)
text = item.getAttribute("description", null);
if (text == null)
text = item.getAttribute("abstract", null);
if (text == null)
continue;
html |= text.indexOf("</") != -1 || text.indexOf("/>") != -1 || text.indexOf("<p>") != -1;
ParsedMessage pm = generateMessage(title, text, href, html, addr, date, enclosures);
sdata.recordItem(guid, date.getTime(), pm);
}
return sdata;
} catch (UnsupportedEncodingException e) {
throw ServiceException.FAILURE("error encoding rss channel name", e);
}
}
private static SubscriptionData parseAtomFeed(Element feed, Folder.SyncData fsd) throws ServiceException {
try {
// get defaults from the <feed> element
InternetAddress addrFeed = parseAtomAuthor(feed.getOptionalElement("author"), null);
if (addrFeed == null)
addrFeed = new InternetAddress("", feed.getAttribute("title"), "utf-8");
Date dateFeed = DateUtil.parseISO8601Date(feed.getAttribute("updated", null), new Date());
List<Enclosure> enclosures = new ArrayList<Enclosure>();
SubscriptionData sdata = new SubscriptionData(dateFeed.getTime());
for (Element item : feed.listElements("entry")) {
// get the item's date
Date date = DateUtil.parseISO8601Date(item.getAttribute("updated", null), null);
if (date == null)
date = DateUtil.parseISO8601Date(item.getAttribute("modified", null), dateFeed);
// construct an address for the author
InternetAddress addr = parseAtomAuthor(item.getOptionalElement("author"), addrFeed);
// get the item's title (may be html or xhtml)
Element tblock = item.getElement("title");
String type = tblock.getAttribute("type", "text").trim().toLowerCase();
String title = tblock.getText();
if (type.equals("html") || type.equals("xhtml") || type.equals("text/html") || type.equals("application/xhtml+xml"))
title = parseTitle(title);
// find the item's link and any enclosures (associated media links)
enclosures.clear();
String href = "";
for (Iterator itlink = item.elementIterator("link"); itlink.hasNext(); ) {
Element link = (Element) itlink.next();
String relation = link.getAttribute("rel", "alternate");
if (relation.equals("alternate"))
href = link.getAttribute("href");
else if (relation.equals("enclosure"))
enclosures.add(new Enclosure(link.getAttribute("href", null), link.getAttribute("title", null), link.getAttribute("type", null)));
}
String guid = item.getAttribute("id", href);
// make sure we haven't already seen this item
if (fsd != null && fsd.alreadySeen(guid, date.getTime()))
continue;
// get the content/summary and markup
Element content = item.getOptionalElement("content");
if (content == null)
content = item.getOptionalElement("summary");
if (content == null)
continue;
type = content.getAttribute("type", "text").trim().toLowerCase();
boolean html = false;
if (type.equals("html") || type.equals("xhtml") || type.equals("text/html") || type.equals("application/xhtml+xml"))
html = true;
else if (!type.equals("text") && !type.equals("text/plain"))
throw ServiceException.PARSE_ERROR("unsupported atom entry content type: " + type, null);
ParsedMessage pm = generateMessage(title, content.getText(), href, html, addr, date, enclosures);
sdata.recordItem(guid, date.getTime(), pm);
}
return sdata;
} catch (UnsupportedEncodingException e) {
throw ServiceException.FAILURE("error encoding atom feed name", e);
}
}
private static final String HTML_HEADER = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\">\n" +
"<HTML><HEAD><META HTTP-EQUIV=\"Content-Type\" CONTENT=\"text/html; charset=utf-8\"></HEAD><BODY>";
private static final String HTML_FOOTER = "</BODY></HTML>";
private static ParsedMessage generateMessage(String title, String text, String href, boolean html, InternetAddress addr, Date date, List<Enclosure> attach)
throws ServiceException {
String ctype = html ? "text/html; charset=\"utf-8\"" : "text/plain; charset=\"utf-8\"";
String content = html ? HTML_HEADER + text + "<p>" + href + HTML_FOOTER : text + "\r\n\r\n" + href;
// cull out invalid enclosures
if (attach != null)
for (Iterator it = attach.iterator(); it.hasNext(); )
if (((Enclosure) it.next()).getLocation() == null)
it.remove();
boolean hasAttachments = attach != null && attach.size() > 0;
// create the MIME message and wrap it
try {
MimeMessage mm = new Mime.FixedMimeMessage(JMSession.getSession());
MimePart body = (hasAttachments ? new MimeBodyPart() : (MimePart) mm);
body.setText(content, "utf-8");
body.setHeader("Content-Type", ctype);
if (hasAttachments) {
// encode each enclosure as an attachment with Content-Location set
MimeMultipart mmp = new MimeMultipart("mixed");
mmp.addBodyPart((BodyPart) body);
for (Enclosure enc : attach) {
MimeBodyPart part = new MimeBodyPart();
part.setText("");
part.addHeader("Content-Location", enc.getLocation());
part.addHeader("Content-Type", enc.getContentType());
if (enc.getDescription() != null)
part.addHeader("Content-Description", enc.getDescription());
mmp.addBodyPart(part);
}
mm.setContent(mmp);
}
mm.setSentDate(date);
mm.addFrom(new InternetAddress[] {addr});
mm.setSubject(title, "utf-8");
// more stuff here!
mm.saveChanges();
return new ParsedMessage(mm, date.getTime(), false);
} catch (MessagingException e) {
throw ServiceException.PARSE_ERROR("error wrapping feed item in MimeMessage", e);
}
}
private static InternetAddress parseDublinCreator(String creator, InternetAddress addrChannel) {
if (creator == null || creator.equals(""))
return addrChannel;
// check for a mailto: link
String lc = creator.trim().toLowerCase(), address = "", personal = creator;
int mailto = lc.indexOf("mailto:");
if (mailto == 0 && lc.length() <= 7)
return addrChannel;
else if (mailto == 0) {
personal = null; address = creator = creator.substring(7);
} else if (mailto != -1) {
// checking for "...[mailto:...]..." or "...(mailto:...)..."
char delimit = creator.charAt(mailto - 1), complement = 0;
if (delimit == '[') complement = ']';
else if (delimit == '(') complement = ')';
int closing = creator.indexOf(complement, mailto + 7);
if (closing != -1 && closing != mailto + 7) {
address = creator.substring(mailto + 7, closing);
personal = (creator.substring(0, mailto - 1) + creator.substring(closing + 1)).trim();
}
}
try { return new InternetAddress(address, personal, "utf-8"); } catch (UnsupportedEncodingException e) { }
try { return new InternetAddress("", creator, "utf-8"); } catch (UnsupportedEncodingException e) { }
return addrChannel;
}
private static InternetAddress parseAtomAuthor(Element author, InternetAddress addrChannel) {
if (author == null)
return addrChannel;
String address = author.getAttribute("email", "");
String personal = author.getAttribute("name", "");
if (personal.equals("") && address.equals(""))
return addrChannel;
try { return new InternetAddress(address, personal, "utf-8"); } catch (UnsupportedEncodingException e) { }
try { return new InternetAddress("", address + personal, "utf-8"); } catch (UnsupportedEncodingException e) { }
return addrChannel;
}
private static class UnescapedContent extends org.xml.sax.helpers.DefaultHandler {
private StringBuffer str = new StringBuffer();
private boolean continued;
public void startDocument() {
str.setLength(0); continued = false;
}
public void characters(char[] ch, int offset, int length) {
if (!continued && str.length() > 0)
str.append(' ');
str.append(ch, offset, length);
continued = true;
}
public void startElement(String uri, String localName, String qName, org.xml.sax.Attributes attributes) {
continued = localName.toUpperCase().equals("A");
}
public void endElement(String uri, String localName, String qName) {
continued = localName.toUpperCase().equals("A");
}
public String toString() {
return str.toString();
}
}
private static final String parseTitle(String title) {
if (title == null)
return "";
else if (title.indexOf('<') == -1 && title.indexOf('&') == -1)
return title;
org.xml.sax.XMLReader parser = new org.cyberneko.html.parsers.SAXParser();
org.xml.sax.ContentHandler handler = new UnescapedContent();
parser.setContentHandler(handler);
try {
parser.parse(new org.xml.sax.InputSource(new StringReader(title)));
return handler.toString();
} catch (Exception e) {
return title;
}
}
}
The table below shows all metrics for FeedManager.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 68.00 | Number of blocks | |
| BLOCK_COMMENT | 27.00 | Number of block comment lines | |
| COMMENTS | 53.00 | Comment lines | |
| COMMENT_DENSITY | 0.15 | Comment density | |
| COMPARISONS | 85.00 | Number of comparison operators | |
| CYCLOMATIC | 121.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 4.00 | Comments in declarations | |
| DOC_COMMENT | 3.00 | Number of javadoc comment lines | |
| ELOC | 363.00 | Effective lines of code | |
| EXEC_COMMENTS | 22.00 | Comments in executable code | |
| EXITS | 109.00 | Procedure exits | |
| FUNCTIONS | 21.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 88.63 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 110.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 | 4.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 5.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 | 1.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 | 1.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 39.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 1.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 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 10.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 | 1.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 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 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 7.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 1.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 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 1.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 1.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 | 6.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 3.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 | 3.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 1.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 | 2.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 1.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 | 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 | 1.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 | 503.00 | Number of lines in the source file | |
| LINE_COMMENT | 23.00 | Number of line comments | |
| LOC | 406.00 | Lines of code | |
| LOGICAL_LINES | 273.00 | Number of statements | |
| LOOPS | 4.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 1443.00 | Number of operands | |
| OPERATORS | 2406.00 | Number of operators | |
| PARAMS | 39.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3849.00 | Halstead program length | |
| PROGRAM_VOCAB | 521.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 71.00 | Number of return points from functions | |
| SIZE | 23835.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 464.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 57.00 | Number of unique operators | |
| WHITESPACE | 44.00 | Number of whitespace lines | |