DojoAjaxResponseBuilder.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.tapestry.services.impl |
 |
 |
Apache Tapestry 4 |
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 |  |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0020 | JAVA0020 Field name does not have required form | |
| PARAMS | Number of formal parameter declarations | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| LINE_COMMENT | Number of line comments | |
| EXITS | Procedure exits | |
| RETURNS | Number of return points from functions | |
| DOC_COMMENT | Number of javadoc comment lines | |
| CYCLOMATIC | Cyclomatic complexity | |
| LINES | Number of lines in the source file | |
| SIZE | Size of the file in bytes | |
| FUNCTIONS | Number of function declarations | |
| UNIQUE_OPERANDS | Number of unique operands | |
| COMMENTS | Comment lines | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LOC | Lines of code | |
| OPERANDS | Number of operands | |
| LOGICAL_LINES | Number of statements | |
| PROGRAM_LENGTH | Halstead program length | |
| WHITESPACE | Number of whitespace lines | |
| ELOC | Effective lines of code | |
| OPERATORS | Number of operators | |
| COMPARISONS | Number of comparison operators | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| BLOCKS | Number of blocks | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0035 | JAVA0035 Missing braces in for statement | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0256 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
// Copyright May 8, 2006 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package org.apache.tapestry.services.impl;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.hivemind.Resource;
import org.apache.hivemind.util.Defense;
import org.apache.tapestry.*;
import org.apache.tapestry.asset.AssetFactory;
import org.apache.tapestry.engine.IEngineService;
import org.apache.tapestry.engine.NullWriter;
import org.apache.tapestry.markup.MarkupWriterSource;
import org.apache.tapestry.markup.NestedMarkupWriterImpl;
import org.apache.tapestry.services.RequestLocaleManager;
import org.apache.tapestry.services.ResponseBuilder;
import org.apache.tapestry.services.ServiceConstants;
import org.apache.tapestry.util.ContentType;
import org.apache.tapestry.util.PageRenderSupportImpl;
import org.apache.tapestry.util.ScriptUtils;
import org.apache.tapestry.web.WebResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.*;
/**
* Main class that handles dojo based ajax responses. These responses are wrapped
* by an xml document format that segments off invididual component/javascript response
* types into easy to manage xml elements that can then be interpreted and managed by
* running client-side javascript.
*
*/
public class DojoAjaxResponseBuilder implements ResponseBuilder
{
private static final Log _log = LogFactory.getLog(DojoAjaxResponseBuilder.class);
private static final String NEWLINE = System.getProperty("line.separator");
private final AssetFactory _assetFactory;
private final String _namespace;
private PageRenderSupportImpl _prs;
// used to create IMarkupWriter
private RequestLocaleManager _localeManager;
private MarkupWriterSource _markupWriterSource;
private WebResponse _response;
private List _errorPages;
private ContentType _contentType;
// our response writer
private IMarkupWriter _writer;
// Parts that will be updated.
private List _parts = new ArrayList();
// Map of specialized writers, like scripts
private Map _writers = new HashMap();
// List of status messages.
private List _statusMessages;
private IRequestCycle _cycle;
private IEngineService _pageService;
/**
* Keeps track of renders involving a whole page response, such
* as exception pages or pages activated via {@link IRequestCycle#activate(IPage)}.
*/
private boolean _pageRender = false;
/**
* Used to keep track of whether or not the appropriate xml response start
* block has been started.
*/
private boolean _responseStarted = false;
/**
* Creates a builder with a pre-configured {@link IMarkupWriter}.
* Currently only used for testing.
*
* @param cycle
* The current cycle.
* @param writer
* The markup writer to render all "good" content to.
* @param parts
* A set of string ids of the components that may have
* their responses rendered.
* @param errorPages
* List of page names known to be exception pages.
*/
public DojoAjaxResponseBuilder(IRequestCycle cycle, IMarkupWriter writer, List parts, List errorPages)
{
Defense.notNull(cycle, "cycle");
Defense.notNull(writer, "writer");
_writer = writer;
_cycle = cycle;
if (parts != null)
_parts.addAll(parts);
_namespace = null;
_assetFactory = null;
_errorPages = errorPages;
}
/**
* Creates a builder with a pre-configured {@link IMarkupWriter}.
* Currently only used for testing.
*
* @param cycle
* Current request.
* @param writer
* The markup writer to render all "good" content to.
* @param parts
* A set of string ids of the components that may have
* their responses rendered.
*/
public DojoAjaxResponseBuilder(IRequestCycle cycle, IMarkupWriter writer, List parts)
{
this(cycle, writer, parts, null);
}
/**
* Creates a new response builder with the required services it needs
* to render the response when {@link #renderResponse(IRequestCycle)} is called.
*
* @param cycle
* The current request.
* @param localeManager
* Used to set the locale on the response.
* @param markupWriterSource
* Creates IJSONWriter instance to be used.
* @param webResponse
* Web response for output stream.
* @param errorPages
* List of page names known to be exception pages.
* @param assetFactory
* Used to manage asset source inclusions.
* @param namespace
* The core namespace to use for javascript/client side operations.
* @param pageService
* {@link org.apache.tapestry.engine.PageService} used to generate page urls.
*/
public DojoAjaxResponseBuilder(IRequestCycle cycle,
RequestLocaleManager localeManager,
MarkupWriterSource markupWriterSource,
WebResponse webResponse, List errorPages,
AssetFactory assetFactory, String namespace, IEngineService pageService)
{
Defense.notNull(cycle, "cycle");
Defense.notNull(assetFactory, "assetService");
_cycle = cycle;
_localeManager = localeManager;
_markupWriterSource = markupWriterSource;
_response = webResponse;
_errorPages = errorPages;
_pageService = pageService;
// Used by PageRenderSupport
_assetFactory = assetFactory;
_namespace = namespace;
_prs = new PageRenderSupportImpl(_assetFactory, _namespace, this, cycle);
}
/**
*
* {@inheritDoc}
*/
public boolean isDynamic()
{
return true;
}
/**
* {@inheritDoc}
*/
public void renderResponse(IRequestCycle cycle)
throws IOException
{
// if response was already started
if (_responseStarted)
{
// clear out any previous input
clearPartialWriters();
cycle.renderPage(this);
TapestryUtils.removePageRenderSupport(cycle);
endResponse();
_writer.close();
return;
}
_localeManager.persistLocale();
_contentType = new ContentType(CONTENT_TYPE + ";charset=" + cycle.getInfrastructure().getOutputEncoding());
String encoding = _contentType.getParameter(ENCODING_KEY);
if (encoding == null)
{
encoding = cycle.getEngine().getOutputEncoding();
_contentType.setParameter(ENCODING_KEY, encoding);
}
if (_writer == null)
{
parseParameters(cycle);
PrintWriter printWriter = _response.getPrintWriter(_contentType);
_writer = _markupWriterSource.newMarkupWriter(printWriter, _contentType);
}
// render response
TapestryUtils.storePageRenderSupport(cycle, _prs);
cycle.renderPage(this);
TapestryUtils.removePageRenderSupport(cycle);
endResponse();
_writer.close();
}
public void flush()
throws IOException
{
// Important - causes any cookies stored to properly be written out before the
// rest of the response starts being written - see TAPESTRY-825
_writer.flush();
if (!_responseStarted)
beginResponse();
}
/**
* {@inheritDoc}
*/
public void updateComponent(String id)
{
if (!_parts.contains(id))
_parts.add(id);
}
/**
* {@inheritDoc}
*/
public IMarkupWriter getWriter()
{
return _writer;
}
void setWriter(IMarkupWriter writer)
{
_writer = writer;
}
/**
* {@inheritDoc}
*/
public boolean isBodyScriptAllowed(IComponent target)
{
if (_pageRender)
return true;
if (target != null
&& IPage.class.isInstance(target)
|| (IForm.class.isInstance(target)
&& ((IForm)target).isFormFieldUpdating()))
return true;
return contains(target);
}
/**
* {@inheritDoc}
*/
public boolean isExternalScriptAllowed(IComponent target)
{
if (_pageRender)
return true;
if (target != null
&& IPage.class.isInstance(target)
|| (IForm.class.isInstance(target)
&& ((IForm)target).isFormFieldUpdating()))
return true;
return contains(target);
}
/**
* {@inheritDoc}
*/
public boolean isInitializationScriptAllowed(IComponent target)
{
if (_log.isDebugEnabled())
{
_log.debug("isInitializationScriptAllowed(" + target + ") contains?: " + contains(target) + " _pageRender: " + _pageRender);
}
if (_pageRender)
return true;
if (target != null
&& IPage.class.isInstance(target)
|| (IForm.class.isInstance(target)
&& ((IForm)target).isFormFieldUpdating()))
return true;
return contains(target);
}
/**
* {@inheritDoc}
*/
public boolean isImageInitializationAllowed(IComponent target)
{
if (_pageRender)
return true;
if (target != null
&& IPage.class.isInstance(target)
|| (IForm.class.isInstance(target)
&& ((IForm)target).isFormFieldUpdating()))
return true;
return contains(target);
}
/**
* {@inheritDoc}
*/
public String getPreloadedImageReference(IComponent target, IAsset source)
{
return _prs.getPreloadedImageReference(target, source);
}
/**
* {@inheritDoc}
*/
public String getPreloadedImageReference(IComponent target, String url)
{
return _prs.getPreloadedImageReference(target, url);
}
/**
* {@inheritDoc}
*/
public String getPreloadedImageReference(String url)
{
return _prs.getPreloadedImageReference(url);
}
/**
* {@inheritDoc}
*/
public void addBodyScript(IComponent target, String script)
{
_prs.addBodyScript(target, script);
}
/**
* {@inheritDoc}
*/
public void addBodyScript(String script)
{
_prs.addBodyScript(script);
}
/**
* {@inheritDoc}
*/
public void addExternalScript(IComponent target, Resource resource)
{
_prs.addExternalScript(target, resource);
}
/**
* {@inheritDoc}
*/
public void addExternalScript(Resource resource)
{
_prs.addExternalScript(resource);
}
/**
* {@inheritDoc}
*/
public void addInitializationScript(IComponent target, String script)
{
_prs.addInitializationScript(target, script);
}
/**
* {@inheritDoc}
*/
public void addInitializationScript(String script)
{
_prs.addInitializationScript(script);
}
public void addScriptAfterInitialization(IComponent target, String script)
{
_prs.addScriptAfterInitialization(target, script);
}
/**
* {@inheritDoc}
*/
public String getUniqueString(String baseValue)
{
return _prs.getUniqueString(baseValue);
}
/**
* {@inheritDoc}
*/
public void writeBodyScript(IMarkupWriter writer, IRequestCycle cycle)
{
_prs.writeBodyScript(writer, cycle);
}
/**
* {@inheritDoc}
*/
public void writeInitializationScript(IMarkupWriter writer)
{
_prs.writeInitializationScript(writer);
}
/**
* {@inheritDoc}
*/
public void beginBodyScript(IMarkupWriter normalWriter, IRequestCycle cycle)
{
IMarkupWriter writer = getWriter(ResponseBuilder.BODY_SCRIPT, ResponseBuilder.SCRIPT_TYPE);
writer.begin("script");
writer.printRaw(NEWLINE + "//<![CDATA[" + NEWLINE);
}
/**
* {@inheritDoc}
*/
public void endBodyScript(IMarkupWriter normalWriter, IRequestCycle cycle)
{
IMarkupWriter writer = getWriter(ResponseBuilder.BODY_SCRIPT, ResponseBuilder.SCRIPT_TYPE);
writer.printRaw(NEWLINE + "//]]>" + NEWLINE);
writer.end();
}
/**
* {@inheritDoc}
*/
public void writeBodyScript(IMarkupWriter normalWriter, String script, IRequestCycle cycle)
{
IMarkupWriter writer = getWriter(ResponseBuilder.BODY_SCRIPT, ResponseBuilder.SCRIPT_TYPE);
writer.printRaw(script);
}
/**
* {@inheritDoc}
*/
public void writeExternalScript(IMarkupWriter normalWriter, String url, IRequestCycle cycle)
{
IMarkupWriter writer = getWriter(ResponseBuilder.INCLUDE_SCRIPT, ResponseBuilder.SCRIPT_TYPE);
// causes asset includes to be loaded dynamically into document head
writer.beginEmpty("include");
writer.attribute("url", url);
}
/**
* {@inheritDoc}
*/
public void writeImageInitializations(IMarkupWriter normalWriter, String script, String preloadName, IRequestCycle cycle)
{
IMarkupWriter writer = getWriter(ResponseBuilder.BODY_SCRIPT, ResponseBuilder.SCRIPT_TYPE);
writer.printRaw(NEWLINE + preloadName + " = [];" + NEWLINE);
writer.printRaw("if (document.images) {" + NEWLINE);
writer.printRaw(script);
writer.printRaw("}" + NEWLINE);
}
/**
* {@inheritDoc}
*/
public void writeInitializationScript(IMarkupWriter normalWriter, String script)
{
IMarkupWriter writer = getWriter(ResponseBuilder.INITIALIZATION_SCRIPT, ResponseBuilder.SCRIPT_TYPE);
writer.begin("script");
// return is in XML so must escape any potentially non-xml compliant content
writer.printRaw(NEWLINE + "//<![CDATA[" + NEWLINE);
writer.printRaw(script);
writer.printRaw(NEWLINE + "//]]>" + NEWLINE);
writer.end();
}
public void addStatus(IMarkupWriter normalWriter, String text)
{
addStatusMessage(normalWriter, "info", text);
}
/**
* Adds a status message to the current response. This implementation keeps track
* of all messages and appends them to the XHR response. On the client side,
* the default behavior is to publish the message to a topic matching the category name
* using <code>dojo.event.topic.publish(category,text);</code>.
*
* @param normalWriter
* The markup writer to use, this may be ignored or swapped
* out for a different writer depending on the implementation being used.
* @param category
* Allows setting a category that best describes the type of the status message,
* i.e. info, error, e.t.c.
* @param text
* The status message.
*/
public void addStatusMessage(IMarkupWriter normalWriter, String category, String text)
{
if (_statusMessages==null)
{
_statusMessages = new ArrayList();
}
_statusMessages.add(category);
_statusMessages.add(text);
}
void writeStatusMessages() {
for (int i=0; i < _statusMessages.size(); i+=2)
{
IMarkupWriter writer = getWriter((String) _statusMessages.get(i), "status");
writer.printRaw((String) _statusMessages.get(i+1));
}
_statusMessages = null;
}
/**
* {@inheritDoc}
*/
public void render(IMarkupWriter writer, IRender render, IRequestCycle cycle)
{
// must be a valid writer already
if (NestedMarkupWriterImpl.class.isInstance(writer) && !NullWriter.class.isInstance(writer))
{
render.render(writer, cycle);
return;
}
// check for page exception renders and write content to writer so client can display them
if (IPage.class.isInstance(render))
{
IPage page = (IPage)render;
String errorPage = getErrorPage(page.getPageName());
if (errorPage != null)
{
_pageRender = true;
clearPartialWriters();
render.render(getWriter(errorPage, EXCEPTION_TYPE), cycle);
return;
}
// If a page other than the active page originally requested is rendered
// it means someone activated a new page, so we need to tell the client to handle
// this appropriately. (usually by replacing the current dom with whatever this renders)
if (_cycle.getParameter(ServiceConstants.PAGE) != null
&& !page.getPageName().equals(_cycle.getParameter(ServiceConstants.PAGE)))
{
IMarkupWriter urlwriter = _writer.getNestedWriter();
urlwriter.begin("response");
urlwriter.attribute("type", PAGE_TYPE);
urlwriter.attribute("url", _pageService.getLink(true, page.getPageName()).getAbsoluteURL());
_writers.put(PAGE_TYPE, urlwriter);
return;
}
}
if (IComponent.class.isInstance(render)
&& contains((IComponent)render, ((IComponent)render).peekClientId()))
{
render.render(getComponentWriter( ((IComponent)render).peekClientId() ), cycle);
return;
}
// Nothing else found, throw out response
render.render(NullWriter.getSharedInstance(), cycle);
}
private String getErrorPage(String pageName)
{
for (int i=0; i < _errorPages.size(); i++)
{
String page = (String)_errorPages.get(i);
if (pageName.indexOf(page) > -1)
return page;
}
return null;
}
IMarkupWriter getComponentWriter(String id)
{
return getWriter(id, ELEMENT_TYPE);
}
/**
*
* {@inheritDoc}
*/
public IMarkupWriter getWriter(String id, String type)
{
Defense.notNull(id, "id can't be null");
if (!_responseStarted)
beginResponse();
IMarkupWriter w = (IMarkupWriter)_writers.get(id);
if (w != null)
return w;
// Make component write to a "nested" writer
// so that element begin/ends don't conflict
// with xml element response begin/ends. This is very
// important.
IMarkupWriter nestedWriter = _writer.getNestedWriter();
nestedWriter.begin("response");
nestedWriter.attribute("id", id);
if (type != null)
nestedWriter.attribute("type", type);
_writers.put(id, nestedWriter);
return nestedWriter;
}
/**
* Called to start an ajax response. Writes xml doctype and starts
* the <code>ajax-response</code> element that will contain all of
* the returned content.
*/
void beginResponse()
{
_responseStarted = true;
_writer.printRaw("<?xml version=\"1.0\" encoding=\"" + _cycle.getInfrastructure().getOutputEncoding() + "\"?>");
_writer.printRaw("<!DOCTYPE html "
+ "PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" "
+ "\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\" [" + NEWLINE
+ "<!ENTITY nbsp ' '>" + NEWLINE
+ "]>" + NEWLINE);
_writer.printRaw("<ajax-response>");
}
/**
* Invoked to clear out tempoary partial writer buffers before rendering exception
* page.
*/
void clearPartialWriters()
{
_writers.clear();
}
/**
* Called after the entire response has been captured. Causes
* the writer buffer output captured to be segmented and written
* out to the right response elements for the client libraries to parse.
*/
void endResponse()
{
if (!_responseStarted)
{
beginResponse();
}
// write out captured content
if (_statusMessages != null)
writeStatusMessages();
Iterator keys = _writers.keySet().iterator();
String buffer;
while (keys.hasNext())
{
String key = (String)keys.next();
NestedMarkupWriter nw = (NestedMarkupWriter)_writers.get(key);
buffer = nw.getBuffer();
if (_log.isDebugEnabled())
{
_log.debug("Ajax markup buffer for key <" + key + " contains: " + buffer);
}
if (!isScriptWriter(key))
_writer.printRaw(ScriptUtils.ensureValidScriptTags(buffer));
else
_writer.printRaw(buffer);
}
// end response
_writer.printRaw("</ajax-response>");
_writer.flush();
}
/**
* Determines if the specified markup writer key is one of
* the pre-defined script keys from ResponseBuilder.
*
* @param key
* The key to check.
* @return True, if key is one of the ResponseBuilder keys.
* (BODY_SCRIPT,INCLUDE_SCRIPT,INITIALIZATION_SCRIPT)
*/
boolean isScriptWriter(String key)
{
if (key == null)
return false;
if (ResponseBuilder.BODY_SCRIPT.equals(key)
|| ResponseBuilder.INCLUDE_SCRIPT.equals(key)
|| ResponseBuilder.INITIALIZATION_SCRIPT.equals(key))
return true;
return false;
}
/**
* Grabs the incoming parameters needed for json responses, most notable the
* {@link ServiceConstants#UPDATE_PARTS} parameter.
*
* @param cycle
* The request cycle to parse from
*/
void parseParameters(IRequestCycle cycle)
{
Object[] updateParts = cycle.getParameters(ServiceConstants.UPDATE_PARTS);
if (updateParts == null)
return;
for(int i = 0; i < updateParts.length; i++)
_parts.add(updateParts[i].toString());
}
/**
* Determines if the specified component is contained in the
* responses requested update parts.
* @param target
* The component to check for.
* @return True if the request should capture the components output.
*/
public boolean contains(IComponent target)
{
if (target == null)
return false;
String id = target.getClientId();
return contains(target, id);
}
boolean contains(IComponent target, String id)
{
if (_parts.contains(id))
return true;
Iterator it = _cycle.renderStackIterator();
while (it.hasNext())
{
IComponent comp = (IComponent)it.next();
String compId = comp.getClientId();
if (comp != target && _parts.contains(compId))
return true;
}
return false;
}
/**
* {@inheritDoc}
*/
public boolean explicitlyContains(IComponent target)
{
if (target == null)
return false;
return _parts.contains(target.getId());
}
}
The table below shows all metrics for DojoAjaxResponseBuilder.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 63.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 241.00 | Comment lines | |
| COMMENT_DENSITY | 0.75 | Comment density | |
| COMPARISONS | 54.00 | Number of comparison operators | |
| CYCLOMATIC | 105.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 60.00 | Comments in declarations | |
| DOC_COMMENT | 203.00 | Number of javadoc comment lines | |
| ELOC | 320.00 | Effective lines of code | |
| EXEC_COMMENTS | 14.00 | Comments in executable code | |
| EXITS | 84.00 | Procedure exits | |
| FUNCTIONS | 47.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 64.45 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 147.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 14.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 1.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 | 25.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 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 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 | 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 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 1.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 1.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.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 | 1.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 | 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 | 2.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 1.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 844.00 | Number of lines in the source file | |
| LINE_COMMENT | 38.00 | Number of line comments | |
| LOC | 447.00 | Lines of code | |
| LOGICAL_LINES | 210.00 | Number of statements | |
| LOOPS | 5.00 | Number of loops | |
| NEST_DEPTH | 3.00 | Maximum nesting depth | |
| OPERANDS | 999.00 | Number of operands | |
| OPERATORS | 1674.00 | Number of operators | |
| PARAMS | 76.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2673.00 | Halstead program length | |
| PROGRAM_VOCAB | 385.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 71.00 | Number of return points from functions | |
| SIZE | 23983.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 341.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 44.00 | Number of unique operators | |
| WHITESPACE | 156.00 | Number of whitespace lines | |