UIUtil.java
| Index Score | ||
|---|---|---|
 |
 |
org.pentaho.core.util |
 |
 |
Pentaho |
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 | |
|---|---|---|
| LOOPS | Number of loops |  |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| OPERANDS | Number of operands | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| PROGRAM_LENGTH | Halstead program length | |
| SIZE | Size of the file in bytes | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| OPERATORS | Number of operators | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0174 | JAVA0174 Assigned local variable never used | |
| NEST_DEPTH | Maximum nesting depth | |
| LOGICAL_LINES | Number of statements | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| EXITS | Procedure exits | |
| BLOCKS | Number of blocks | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| COMPARISONS | Number of comparison operators | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| CYCLOMATIC | Cyclomatic complexity | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| EXEC_COMMENTS | Comments in executable code | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0067 | JAVA0067 Array descriptor on identifier name | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| DOC_COMMENT | Number of javadoc comment lines | |
| DECL_COMMENTS | Comments in declarations | |
| UNIQUE_OPERATORS | Number of unique operators | |
| COMMENTS | Comment lines | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| WHITESPACE | Number of whitespace lines | |
| RETURNS | Number of return points from functions | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* Copyright 2006 Pentaho Corporation. All rights reserved.
* This software was developed by Pentaho Corporation and is provided under the terms
* of the Mozilla Public License, Version 1.1, or any later version. You may not use
* this file except in compliance with the license. If you need a copy of the license,
* please go to http://www.mozilla.org/MPL/MPL-1.1.txt. The Original Code is the Pentaho
* BI Platform. The Initial Developer is Pentaho Corporation.
*
* Software distributed under the Mozilla Public License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. Please refer to
* the license for the specific language governing your rights and limitations.
*
* @created Jul 22, 2005 @author James Dixon
*
*/
package org.pentaho.core.util;
import java.text.NumberFormat;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import org.pentaho.commons.connection.IPentahoResultSet;
import org.pentaho.core.repository.ISolutionRepository;
import org.pentaho.core.runtime.IRuntimeContext;
import org.pentaho.core.session.BaseSession;
import org.pentaho.core.session.IPentahoSession;
import org.pentaho.core.session.PentahoHttpSession;
import org.pentaho.core.solution.ActionResource;
import org.pentaho.core.solution.IActionResource;
import org.pentaho.core.system.PentahoMessenger;
import org.pentaho.core.system.PentahoSystem;
import org.pentaho.messages.Messages;
import org.pentaho.messages.util.LocaleHelper;
import org.pentaho.util.IVersionHelper;
import com.pentaho.security.SecurityUtils;
public class UIUtil implements IUITemplater {
//TODO sbarkdull, find occurances in code of these mime types, and where appropriate, use these static final value
public static final String HTML_MIME_TYPE = "text/html"; //$NON-NLS-1$
public static final String TEXT_MIME_TYPE = "text/plain"; //$NON-NLS-1$
public static final int MAX_RESULT_THRESHOLD = 100;
private static String footerTemplate = null;
private static final String FOOTER_TEMPLATE_FILENAME = "template-footer.html"; //$NON-NLS-1$
public String processTemplate(String template, String title, String content, IPentahoSession session) {
template = processTemplate(template, title, session);
template = template.replaceFirst("\\{content\\}", content); //$NON-NLS-1$
return template;
}
/*
* TODO: This needs to be architected to be more performant
*/
public String processTemplate(String template, String title, IPentahoSession session) {
ISolutionRepository repository = PentahoSystem.getSolutionRepository(session);
if (footerTemplate == null) {
footerTemplate = getTemplate(FOOTER_TEMPLATE_FILENAME, session);
}
template = template.replaceFirst("\\{footer\\}", footerTemplate); //$NON-NLS-1$
template = template.replaceAll("\\{title\\}", title); //$NON-NLS-1$
template = template.replaceAll("\\{home\\}", Messages.getString("UI.USER_HOME")); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{navigate\\}", Messages.getString("UI.USER_NAVIGATE")); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{solutions\\}", Messages.getString("UI.USER_SOLUTIONS")); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{file-cache\\}", Messages.getString("UI.USER_FILE_CACHE")); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{new-content\\}", Messages.getString("UI.USER_NEW_CONTENT")); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{admin\\}", Messages.getString("UI.USER_ADMIN")); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{about\\}", Messages.getString("UI.USER_ABOUT")); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{pentaho.org\\}", Messages.getString("UI.USER_PENTAHO.COM")); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{close\\}", Messages.getString("UI.USER_CLOSE")); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{forums\\}", Messages.getString("UI.USER_FORUMS")); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{demos\\}", Messages.getString("UI.USER_DEMOS")); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{downloads\\}", Messages.getString("UI.USER_DOWNLOADS")); //$NON-NLS-1$ //$NON-NLS-2$
template = template
.replaceAll("text/html; charset=utf-8", "text/html; charset=" + LocaleHelper.getSystemEncoding()); //$NON-NLS-1$//$NON-NLS-2$
template = template.replaceAll("\\{text-direction\\}", LocaleHelper.getTextDirection()); //$NON-NLS-1$
template = template.replaceAll("\\{logout\\}", Messages.getString("UI.USER_LOGOUT")); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{portal\\}", Messages.getString("UI.USER_PORTAL")); //$NON-NLS-1$ //$NON-NLS-2$
IVersionHelper versionHelper = PentahoSystem.getVersionHelper(session);
template = template.replaceAll("\\{system\\}", PentahoSystem.getSystemName()); //$NON-NLS-1$
template = template.replaceAll("\\{version\\}", "Version: " + versionHelper.getVersionInformation()); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{isLoggedIn\\}", session.isAuthenticated() ? "true" : "false"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
template = template.replaceAll("\\{background-alert\\}", session.getBackgroundExecutionAlert() ? "true" : "false"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
template = template.replaceAll("\\{header-content\\}", ""); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{body-tag\\}", ""); //$NON-NLS-1$ //$NON-NLS-2$
template = template.replaceAll("\\{isAdmin\\}", SecurityUtils.isPentahoAdministrator(session) ? "true" : "false"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
template = template.replaceAll("\\{repository-name\\}", repository.getRepositoryName() ); //$NON-NLS-1$
template = template.replaceAll("\\{copyright\\}", Messages.getString("UI.USER_COPYRIGHT")); //$NON-NLS-1$ //$NON-NLS-2$
return template;
}
public String getTemplate(String templateName, IPentahoSession session) {
ActionResource resource = new ActionResource(
"", IActionResource.SOLUTION_FILE_RESOURCE, "text/xml", "system/custom/" + templateName); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
String template = null;
try {
template = PentahoSystem.getSolutionRepository(session).getResourceAsString(resource);
} catch (Throwable t) {
}
if (template == null) {
return Messages.getString("UI.ERROR_0001_BAD_TEMPLATE", resource.getAddress()); //$NON-NLS-1$
} else {
return template;
}
}
public String[] breakTemplate(String templateName, String title, IPentahoSession session) {
String template = getTemplate(templateName, session);
return breakTemplateString(template, title, session);
}
public String[] breakTemplateString(String template, String title, IPentahoSession session) {
String token = "{content}"; //$NON-NLS-1$
template = processTemplate(template, title, session);
int index = template.indexOf(token);
if (index == -1) {
return new String[] { template };
} else {
String sections[] = new String[2];
sections[0] = template.substring(0, index);
sections[1] = template.substring(index + token.length());
return sections;
}
}
public static IPentahoSession getPentahoSession(HttpServletRequest request) {
HttpSession session = request.getSession();
IPentahoSession userSession = (IPentahoSession) session.getAttribute(BaseSession.PENTAHO_SESSION_KEY);
LocaleHelper.setLocale(request.getLocale());
if (userSession != null) {
return userSession;
}
userSession = new PentahoHttpSession(request.getRemoteUser(), request.getSession(), request.getLocale());
// TODO sbarkdull delete following line?
LocaleHelper.setLocale(request.getLocale());
session.setAttribute(BaseSession.PENTAHO_SESSION_KEY, userSession);
return userSession;
}
public static void formatErrorMessage(String mimeType, String title, String message, StringBuffer messageBuffer) {
ArrayList messages = new ArrayList(1);
messages.add(message);
formatErrorMessage(mimeType, title, messages, messageBuffer);
}
/**
* If PentahoMessenger.getUserString("ERROR") returns the string:
* "Error: {0} ({1})" (which is the case for English)
* Find the substring before the first "{". In this case, that
* would be: "Error: ".
* Return the first string in the messages list that contains
* the string "Error: ". If no string in the list contains
* "Error: ", return null;
* @param messages
* @return
*/
public static String getFirstError(List messages) {
// returns something like: "Error: {0} ({1})"
String errorStart = PentahoMessenger.getUserString("ERROR"); //$NON-NLS-1$
int pos = errorStart.indexOf('{');
if (pos != -1) {
errorStart = errorStart.substring(0, pos);
}
Iterator messageIterator = messages.iterator();
while (messageIterator.hasNext()) {
String message = (String) messageIterator.next();
if (message.indexOf(errorStart) == 0) {
return message;
}
}
return null;
}
public static void formatErrorMessage(String mimeType, String title, List messages, StringBuffer messageBuffer) {
// TODO make this template or XSL based
if ("text/html".equals(mimeType)) { //$NON-NLS-1$
messageBuffer
.append("<html><head><title>") //$NON-NLS-1$
.append(Messages.getString("UIUtil.ERROR_PAGE_TITLE")) //$NON-NLS-1$
.append(
"</title><link rel=\"stylesheet\" type=\"text/css\" href=\"/pentaho-style/active/default.css\"></head>") //$NON-NLS-1$
.append("<body dir=\"").append(LocaleHelper.getTextDirection()).append("\"><table cellspacing=\"10\"><tr><td class=\"portlet-section\" colspan=\"3\">") //$NON-NLS-1$ //$NON-NLS-2$
.append(title).append("<hr size=\"1\"/></td></tr><tr><td class=\"portlet-font\" valign=\"top\">"); //$NON-NLS-1$
Iterator messageIterator = messages.iterator();
String errorStart = PentahoMessenger.getUserString("ERROR"); //$NON-NLS-1$
int pos = errorStart.indexOf('{');
if (pos != -1) {
errorStart = errorStart.substring(0, pos);
}
String firstMessage = getFirstError(messages);
if (firstMessage != null) {
messageBuffer.append("<span style=\"color:red\">").append(firstMessage).append("</span><p/>"); //$NON-NLS-1$ //$NON-NLS-2$
}
messageIterator = messages.iterator();
while (messageIterator.hasNext()) {
messageBuffer.append((String) messageIterator.next()).append("<br/>"); //$NON-NLS-1$
}
messageBuffer.append("</td></tr></table><p>"); //$NON-NLS-1$
IVersionHelper versionHelper = PentahoSystem.getVersionHelper(null);
messageBuffer
.append(" " + Messages.getString("UIUtil.USER_SERVER_VERSION", versionHelper.getVersionInformation())); //$NON-NLS-1$ //$NON-NLS-2$
messageBuffer.append("</body></html>"); //$NON-NLS-1$
} else {
// TODO support other mime types
}
}
public static void formatFailureMessage(String mimeType, IRuntimeContext context, StringBuffer messageBuffer,
List defaultMessages) {
// TODO handle error messages from the runtime context
if ((context == null) && (defaultMessages == null)) {
// something went badly wrong
formatErrorMessage(
mimeType,
Messages.getString("UIUtil.ERROR_0001_REQUEST_FAILED"), Messages.getString("UIUtil.ERROR_0002_COULD_NOT_PROCESS"), messageBuffer); //$NON-NLS-1$ //$NON-NLS-2$
} else {
List theMessages = (context == null) ? defaultMessages : context.getMessages();
// TODO handle error messages from the runtime context
formatErrorMessage(mimeType, "Failed", theMessages, messageBuffer); //$NON-NLS-1$
// formatErrorMessage( mimeType,
// Messages.getString("UIUtil.ERROR_0001_REQUEST_FAILED"), messages,
// messageBuffer ); //$NON-NLS-1$
}
}
public static void formatFailureMessage(String mimeType, IRuntimeContext context, StringBuffer messageBuffer) {
formatFailureMessage(mimeType, context, messageBuffer, null);
}
public static void formatResultSetAsHTMLRows(IPentahoResultSet resultSet, StringBuffer messageBuffer) {
boolean hasColumnHeaders = false;
boolean hasRowHeaders = false;
Object[][] columnHeaders = null;
Object[][] rowHeaders = null;
if (resultSet.getMetaData() != null) {
columnHeaders = resultSet.getMetaData().getColumnHeaders();
rowHeaders = resultSet.getMetaData().getRowHeaders();
hasColumnHeaders = columnHeaders != null;
hasRowHeaders = rowHeaders != null;
if (hasColumnHeaders) {
for (int row = columnHeaders.length-1; row >= 0; row--) {
messageBuffer.append("<tr>"); //$NON-NLS-1$
if (hasRowHeaders) {
for (int indent = 0; indent < rowHeaders[0].length; indent++) {
messageBuffer.append("<th></th>"); //$NON-NLS-1$
}
}
for (int column = 0; column < columnHeaders[row].length; column++) {
messageBuffer.append("<th>").append(columnHeaders[row][column]).append("</th>"); //$NON-NLS-1$//$NON-NLS-2$
}
messageBuffer.append("</tr>"); //$NON-NLS-1$
}
}
}
Object[] dataRow = resultSet.next();
int currentRow = 0;
while (dataRow != null && currentRow < MAX_RESULT_THRESHOLD) {
messageBuffer.append("<tr>"); //$NON-NLS-1$
if (hasRowHeaders) {
for (int rowHeaderCol = rowHeaders[currentRow].length - 1; rowHeaderCol >= 0; rowHeaderCol--) {
messageBuffer.append("<th>").append(rowHeaders[currentRow][rowHeaderCol].toString()).append("</th>"); //$NON-NLS-1$//$NON-NLS-2$
}
}
NumberFormat nf = NumberFormat.getInstance();
for (int column = 0; column < dataRow.length; column++) {
if (dataRow[column] != null) {
Object value = dataRow[column];
if (value instanceof Number) {
Number numVal = (Number) value;
value = nf.format(numVal);
messageBuffer.append("<td align=\"right\">").append(value.toString()).append("</td>"); //$NON-NLS-1$//$NON-NLS-2$
} else {
messageBuffer.append("<td>").append(value.toString()).append("</td>"); //$NON-NLS-1$ //$NON-NLS-2$
}
} else {
messageBuffer.append("<td>---</td>"); //$NON-NLS-1$
}
}
messageBuffer.append("</tr>"); //$NON-NLS-1$
dataRow = resultSet.next();
currentRow++;
}
}
public static void formatSuccessMessage(String mimeType, IRuntimeContext context, StringBuffer messageBuffer,
boolean doMessages) {
formatSuccessMessage(mimeType, context, messageBuffer, doMessages, true);
}
public static void formatSuccessMessage(String mimeType, IRuntimeContext context, StringBuffer messageBuffer,
boolean doMessages, boolean doWrapper) {
if (context == null) {
// something went badly wrong
formatFailureMessage(mimeType, context, messageBuffer);
} else if (mimeType.equalsIgnoreCase(HTML_MIME_TYPE)) {
// TODO make this template or XSL based
if (doWrapper) {
messageBuffer
.append("<html><head><title>") //$NON-NLS-1$
.append(Messages.getString("UIUtil.USER_START_ACTION")) //$NON-NLS-1$
.append(
"</title><link rel=\"stylesheet\" type=\"text/css\" href=\"/pentaho-style/active/default.css\"></head>") //$NON-NLS-1$
.append("<body dir=\"").append(LocaleHelper.getTextDirection()).append("\"><table cellspacing=\"10\"><tr><td class=\"portlet-section\" colspan=\"3\">") //$NON-NLS-1$ //$NON-NLS-2$
.append(Messages.getString("UIUtil.USER_ACTION_SUCCESSFUL")) //$NON-NLS-1$
.append("<hr size=\"1\"/></td></tr><tr><td class=\"portlet-font\" valign=\"top\">"); //$NON-NLS-1$
}
// hmm do we need this to be ordered?
Set outputNames = context.getOutputNames();
Iterator outputNameIterator = outputNames.iterator();
while (outputNameIterator.hasNext()) {
String outputName = (String) outputNameIterator.next();
Object value = context.getOutputParameter(outputName).getValue();
if (value == null) {
value = ""; //$NON-NLS-1$
} else if (value instanceof IPentahoResultSet) {
formatResultSetAsHTMLRows((IPentahoResultSet) value, messageBuffer);
} else {
if (doWrapper) {
messageBuffer.append(outputName).append("="); //$NON-NLS-1$
}
messageBuffer.append(value.toString());
if (doWrapper) {
messageBuffer.append("<br/>"); //$NON-NLS-1$
}
}
}
if (doMessages) {
if (doWrapper) {
messageBuffer.append("<p><br size=\"1\">"); //$NON-NLS-1$
}
List messages = context.getMessages();
Iterator messageIterator = messages.iterator();
while (messageIterator.hasNext()) {
messageBuffer.append((String) messageIterator.next());
if (doWrapper) {
messageBuffer.append("<br/>"); //$NON-NLS-1$
}
}
}
if (doWrapper) {
messageBuffer.append("</td></tr></table></body></html>"); //$NON-NLS-1$
}
} else if (mimeType.equalsIgnoreCase(TEXT_MIME_TYPE)) {
messageBuffer.append(Messages.getString("UIUtil.USER_START_ACTION" + "\n")) //$NON-NLS-1$ //$NON-NLS-2$
.append(Messages.getString("UIUtil.USER_ACTION_SUCCESSFUL" + "\n")); //$NON-NLS-1$ //$NON-NLS-2$
// hmm do we need this to be ordered?
Set outputNames = context.getOutputNames();
Iterator outputNameIterator = outputNames.iterator();
while (outputNameIterator.hasNext()) {
String outputName = (String) outputNameIterator.next();
Object value = context.getOutputParameter(outputName).getValue();
if (value == null) {
value = ""; //$NON-NLS-1$
} else if (value instanceof IPentahoResultSet) {
IPentahoResultSet resultSet = (IPentahoResultSet) value;
Object[][] columnHeaders = resultSet.getMetaData().getColumnHeaders();
Object[][] rowHeaders = resultSet.getMetaData().getRowHeaders();
boolean hasColumnHeaders = columnHeaders != null;
boolean hasRowHeaders = rowHeaders != null;
if (hasColumnHeaders) {
for (int row = 0; row < columnHeaders.length; row++) {
for (int column = 0; column < columnHeaders[row].length; column++) {
if (hasRowHeaders) {
for (int indent = 0; indent < rowHeaders[0].length; indent++) {
messageBuffer.append("\t"); //$NON-NLS-1$
}
}
messageBuffer.append(columnHeaders[row][column]).append("\t"); //$NON-NLS-1$
}
messageBuffer.append("\n"); //$NON-NLS-1$
}
}
int headerRow = 0;
Object[] dataRow = resultSet.next();
int currentRow = 0;
while (dataRow != null && currentRow < MAX_RESULT_THRESHOLD) {
if (hasRowHeaders) {
for (int rowHeaderCol = 0; rowHeaderCol < rowHeaders[headerRow].length; rowHeaderCol++) {
messageBuffer.append(rowHeaders[headerRow][rowHeaderCol].toString()).append("\t"); //$NON-NLS-1$
}
}
for (int column = 0; column < dataRow.length; column++) {
messageBuffer.append(dataRow[column].toString()).append("\t"); //$NON-NLS-1$
}
dataRow = resultSet.next();
currentRow++;
}
} else {
messageBuffer.append(outputName).append("=").append(value.toString()).append("\n"); //$NON-NLS-1$ //$NON-NLS-2$
}
}
if (doMessages) {
List messages = context.getMessages();
Iterator messageIterator = messages.iterator();
while (messageIterator.hasNext()) {
messageBuffer.append((String) messageIterator.next()).append("\n"); //$NON-NLS-1$
}
}
}
}
}
The table below shows all metrics for UIUtil.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 76.00 | Number of blocks | |
| BLOCK_COMMENT | 18.00 | Number of block comment lines | |
| COMMENTS | 44.00 | Comment lines | |
| COMMENT_DENSITY | 0.16 | Comment density | |
| COMPARISONS | 51.00 | Number of comparison operators | |
| CYCLOMATIC | 74.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 4.00 | Comments in declarations | |
| DOC_COMMENT | 11.00 | Number of javadoc comment lines | |
| ELOC | 279.00 | Effective lines of code | |
| EXEC_COMMENTS | 12.00 | Comments in executable code | |
| EXITS | 58.00 | Procedure exits | |
| FUNCTIONS | 14.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 75.25 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 61.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 | 1.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains 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 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 4.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 | 1.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 | 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 | 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 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 3.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 8.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 | 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 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 12.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 | 1.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 | 3.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 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 | 5.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 | 3.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 | 2.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 | 429.00 | Number of lines in the source file | |
| LINE_COMMENT | 15.00 | Number of line comments | |
| LOC | 343.00 | Lines of code | |
| LOGICAL_LINES | 200.00 | Number of statements | |
| LOOPS | 18.00 | Number of loops | |
| NEST_DEPTH | 9.00 | Maximum nesting depth | |
| OPERANDS | 1098.00 | Number of operands | |
| OPERATORS | 1813.00 | Number of operators | |
| PARAMS | 43.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2911.00 | Halstead program length | |
| PROGRAM_VOCAB | 365.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 18.00 | Number of return points from functions | |
| SIZE | 20855.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 321.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 44.00 | Number of unique operators | |
| WHITESPACE | 42.00 | Number of whitespace lines | |