PageLoaderProcessor.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.tapestry.internal.services |
 |
 |
Apache Tapestry 5 |
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 | |
|---|---|---|
| LINE_COMMENT | Number of line comments |  |
| EXEC_COMMENTS | Comments in executable code | |
| EXITS | Procedure exits | |
| JAVA0020 | JAVA0020 Field name does not have required form | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| SIZE | Size of the file in bytes | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| PARAMS | Number of formal parameter declarations | |
| WHITESPACE | Number of whitespace lines | |
| LINES | Number of lines in the source file | |
| LOC | Lines of code | |
| ELOC | Effective lines of code | |
| LOGICAL_LINES | Number of statements | |
| OPERANDS | Number of operands | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| PROGRAM_LENGTH | Halstead program length | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0040 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| OPERATORS | Number of operators | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| FUNCTIONS | Number of function declarations | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| PROGRAM_VOLUME | Halstead program volume | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| RETURNS | Number of return points from functions | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LOOPS | Number of loops | |
| DOC_COMMENT | Number of javadoc comment lines | |
| COMPARISONS | Number of comparison operators | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| UNIQUE_OPERATORS | Number of unique operators | |
// Copyright 2007 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.internal.services;
import org.apache.tapestry.Binding;
import org.apache.tapestry.ComponentResources;
import org.apache.tapestry.TapestryConstants;
import org.apache.tapestry.internal.bindings.LiteralBinding;
import org.apache.tapestry.internal.parser.*;
import org.apache.tapestry.internal.structure.*;
import org.apache.tapestry.ioc.Location;
import static org.apache.tapestry.ioc.internal.util.CollectionFactory.*;
import org.apache.tapestry.ioc.internal.util.IdAllocator;
import static org.apache.tapestry.ioc.internal.util.InternalUtils.isBlank;
import static org.apache.tapestry.ioc.internal.util.InternalUtils.isNonBlank;
import org.apache.tapestry.ioc.internal.util.OneShotLock;
import org.apache.tapestry.ioc.internal.util.TapestryException;
import org.apache.tapestry.ioc.util.Stack;
import org.apache.tapestry.model.ComponentModel;
import org.apache.tapestry.model.EmbeddedComponentModel;
import org.apache.tapestry.services.BindingSource;
import org.apache.tapestry.services.PersistentFieldManager;
import org.slf4j.Logger;
import java.util.Locale;
import java.util.Map;
/**
* Contains all the work-state related to the {@link PageLoaderImpl}.
*/
class PageLoaderProcessor
{
private static final String INHERIT_PREFIX = "inherit:";
private static Runnable NO_OP = new Runnable()
{
public void run()
{
// Do nothing.
}
};
private Stack<ComponentPageElement> _activeElementStack = newStack();
private boolean _addAttributesAsComponentBindings = false;
private boolean _dtdAdded;
private final Stack<BodyPageElement> _bodyPageElementStack = newStack();
// You can use a stack as a queue
private final Stack<ComponentPageElement> _componentQueue = newStack();
private final Stack<Boolean> _discardEndTagStack = newStack();
private final Stack<Runnable> _endElementCommandStack = newStack();
private final IdAllocator _idAllocator = new IdAllocator();
private final LinkFactory _linkFactory;
private ComponentModel _loadingComponentModel;
private ComponentPageElement _loadingElement;
private final Map<String, Map<String, Binding>> _componentIdToBindingMap = newMap();
private Locale _locale;
private final OneShotLock _lock = new OneShotLock();
private Page _page;
private final PageElementFactory _pageElementFactory;
private final PersistentFieldManager _persistentFieldManager;
private final ComponentTemplateSource _templateSource;
public PageLoaderProcessor(ComponentTemplateSource templateSource,
PageElementFactory pageElementFactory, LinkFactory linkFactory,
PersistentFieldManager persistentFieldManager)
{
_templateSource = templateSource;
_pageElementFactory = pageElementFactory;
_linkFactory = linkFactory;
_persistentFieldManager = persistentFieldManager;
}
private void bindParameterFromTemplate(ComponentPageElement component, AttributeToken token)
{
String name = token.getName();
ComponentResources resources = component.getComponentResources();
// If already bound (i.e., from the component class, via @Component), then
// ignore the value in the template. This may need improving to just ignore
// the value if it is an unprefixed literal string.
if (resources.isBound(name)) return;
// Meta default of literal for the template.
String defaultBindingPrefix = determineDefaultBindingPrefix(
component,
name,
TapestryConstants.LITERAL_BINDING_PREFIX);
Binding binding = findBinding(
_loadingElement,
component,
name,
token.getValue(),
defaultBindingPrefix,
token.getLocation());
if (binding != null)
{
component.bindParameter(name, binding);
Map<String, Binding> bindingMap = _componentIdToBindingMap.get(component
.getCompleteId());
bindingMap.put(name, binding);
}
}
private void addMixinsToComponent(ComponentPageElement component, EmbeddedComponentModel model,
String mixins)
{
if (model != null)
{
for (String mixinClassName : model.getMixinClassNames())
_pageElementFactory.addMixinByClassName(component, mixinClassName);
}
if (mixins != null)
{
for (String type : mixins.split(","))
_pageElementFactory.addMixinByTypeName(component, type);
}
}
private void bindParametersFromModel(EmbeddedComponentModel model,
ComponentPageElement loadingComponent, ComponentPageElement component,
Map<String, Binding> bindingMap)
{
for (String name : model.getParameterNames())
{
String value = model.getParameterValue(name);
String defaultBindingPrefix = determineDefaultBindingPrefix(
component,
name,
TapestryConstants.PROP_BINDING_PREFIX);
Binding binding = findBinding(
loadingComponent,
component,
name,
value,
defaultBindingPrefix,
component.getLocation());
if (binding != null)
{
component.bindParameter(name, binding);
// So that the binding can be shared if inherited by a subcomponent
bindingMap.put(name, binding);
}
}
}
/**
* Creates a new binding, or returns an existing binding (or null) for the "inherit:" binding
* prefix. Mostly a wrapper around
* {@link BindingSource#newBinding(String, ComponentResources, ComponentResources, String, String, Location)
*
* @return the new binding, or an existing binding (if inherited), or null (if inherited, and
* the containing parameter is not bound)
*/
private Binding findBinding(ComponentPageElement loadingComponent,
ComponentPageElement component, String name, String value, String defaultBindingPrefix,
Location location)
{
if (value.startsWith(INHERIT_PREFIX))
{
String loadingParameterName = value.substring(INHERIT_PREFIX.length());
Map<String, Binding> loadingComponentBindingMap = _componentIdToBindingMap
.get(loadingComponent.getCompleteId());
// This may return null if the parameter is not bound in the loading component.
Binding existing = loadingComponentBindingMap.get(loadingParameterName);
if (existing == null) return null;
String description = String.format(
"InheritedBinding[parameter %s %s(inherited from %s of %s)]",
name,
component.getCompleteId(),
loadingParameterName,
loadingComponent.getCompleteId());
// This helps with debugging, and re-orients any thrown exceptions
// to the location of the inherited binding, rather than the container component's
// binding.
return new InheritedBinding(description, existing, location);
}
return _pageElementFactory.newBinding(
name,
loadingComponent.getComponentResources(),
component.getComponentResources(),
defaultBindingPrefix,
value,
location);
}
/**
* Determines the default binding prefix for a particular parameter.
*
* @param component the component which will have a parameter bound
* @param parameterName the name of the parameter
* @param informalParameterBindingPrefix the default to use for informal parameters
* @return the binding prefix
*/
private String determineDefaultBindingPrefix(ComponentPageElement component,
String parameterName, String informalParameterBindingPrefix)
{
String defaultBindingPrefix = component.getDefaultBindingPrefix(parameterName);
return defaultBindingPrefix != null ? defaultBindingPrefix : informalParameterBindingPrefix;
}
private PageElement newRenderBodyElement()
{
return _pageElementFactory.newRenderBodyElement(_loadingElement);
}
private void addToBody(PageElement element)
{
_bodyPageElementStack.peek().addToBody(element);
}
private void attribute(AttributeToken token)
{
// This kind of bookkeeping is ugly, we probably should have distinct (if very similar)
// tokens for attributes and for parameter bindings.
if (_addAttributesAsComponentBindings)
{
ComponentPageElement activeElement = _activeElementStack.peek();
bindParameterFromTemplate(activeElement, token);
return;
}
PageElement element = _pageElementFactory.newAttributeElement(_loadingElement
.getComponentResources(), token);
addToBody(element);
}
private void body(BodyToken token)
{
addToBody(newRenderBodyElement());
// BODY tokens are *not* matched by END_ELEMENT tokens. Nor will there be
// text or comment content "inside" the BODY.
}
private void comment(CommentToken token)
{
PageElement commentElement = _pageElementFactory.newCommentElement(token);
addToBody(commentElement);
}
/**
* Invoked whenever a token (start, startComponent, etc.) is encountered that will eventually
* have a matching end token. Sets up the behavior for the end token.
*
* @param discard if true, the end is discarded (if false the end token is added to the active body
* element)
* @param command command to execute to return processor state back to what it was before the
* command executed
*/
private void configureEnd(boolean discard, Runnable command)
{
_discardEndTagStack.push(discard);
_endElementCommandStack.push(command);
}
private void endElement(EndElementToken token)
{
// discard will be false if the matching start token was for a static element, and will be
// true otherwise (component, block, parameter).
boolean discard = _discardEndTagStack.pop();
if (!discard)
{
PageElement element = _pageElementFactory.newEndElement();
addToBody(element);
}
Runnable command = _endElementCommandStack.pop();
// Used to return environment to prior state.
command.run();
}
private void expansion(ExpansionToken token)
{
PageElement element = _pageElementFactory.newExpansionElement(_loadingElement
.getComponentResources(), token);
addToBody(element);
}
private String generateEmbeddedId(String embeddedType, IdAllocator idAllocator)
{
// Component types may be in folders; strip off the folder part for starters.
int slashx = embeddedType.lastIndexOf("/");
String baseId = embeddedType.substring(slashx + 1).toLowerCase();
// The idAllocator is pre-loaded with all the component ids from the template, so even
// if the lower-case type matches the id of an existing component, there won't be a name
// collision.
return idAllocator.allocateId(baseId);
}
/**
* As currently implemented, this should be invoked just once and then the PageLoaderProcessor
* instance should be discarded.
*/
public Page loadPage(String logicalPageName, String pageClassName, Locale locale)
{
// Ensure that loadPage() may only be invoked once.
_lock.lock();
_locale = locale;
_page = new PageImpl(logicalPageName, _locale, _linkFactory, _persistentFieldManager);
loadRootComponent(pageClassName);
workComponentQueue();
// The page is *loaded* before it is attached to the request.
// This is to help ensure that no client-specific information leaks
// into the page.
_page.loaded();
return _page;
}
private void loadRootComponent(String className)
{
ComponentPageElement rootComponent = _pageElementFactory.newRootComponentElement(
_page,
className);
_page.setRootElement(rootComponent);
_componentQueue.push(rootComponent);
}
/**
* Do you smell something? I'm smelling that this class needs to be redesigned to not need a
* central method this large and hard to test. I think a lot of instance and local variables
* need to be bundled up into some kind of process object. This code is effectively too big to
* be tested except through integration testing.
*/
private void loadTemplateForComponent(ComponentPageElement loadingElement)
{
_loadingElement = loadingElement;
_loadingComponentModel = loadingElement.getComponentResources().getComponentModel();
String componentClassName = _loadingComponentModel.getComponentClassName();
ComponentTemplate template = _templateSource.getTemplate(_loadingComponentModel, _locale);
// When the template for a component is missing, we pretend it consists of just a RenderBody
// phase. Missing is not an error ... many component simply do not have a template.
if (template.isMissing())
{
_loadingElement.addToTemplate(newRenderBodyElement());
return;
}
// Pre-allocate ids to avoid later name collisions.
Logger logger = _loadingComponentModel.getLogger();
// Don't have a case-insensitive Set, so we'll make due with a Map
Map<String, Boolean> embeddedIds = newCaseInsensitiveMap();
for (String id : _loadingComponentModel.getEmbeddedComponentIds())
embeddedIds.put(id, true);
_idAllocator.clear();
for (String id : template.getComponentIds())
{
_idAllocator.allocateId(id);
embeddedIds.remove(id);
}
if (!embeddedIds.isEmpty())
logger.error(ServicesMessages.embeddedComponentsNotInTemplate(
embeddedIds.keySet(),
componentClassName));
_addAttributesAsComponentBindings = false;
// The outermost elements of the template belong in the loading component's template list,
// not its body list. This shunt allows everyone else to not have to make that decision,
// they can add to the "body" and (if there isn't an active component), the shunt will
// add the element to the component's template.
BodyPageElement shunt = new BodyPageElement()
{
public void addToBody(PageElement element)
{
_loadingElement.addToTemplate(element);
}
};
_bodyPageElementStack.push(shunt);
for (TemplateToken token : template.getTokens())
{
switch (token.getTokenType())
{
case TEXT:
text((TextToken) token);
break;
case EXPANSION:
expansion((ExpansionToken) token);
break;
case BODY:
body((BodyToken) token);
break;
case START_ELEMENT:
startElement((StartElementToken) token);
break;
case START_COMPONENT:
startComponent((StartComponentToken) token);
break;
case ATTRIBUTE:
attribute((AttributeToken) token);
break;
case END_ELEMENT:
endElement((EndElementToken) token);
break;
case COMMENT:
comment((CommentToken) token);
break;
case BLOCK:
block((BlockToken) token);
break;
case PARAMETER:
parameter((ParameterToken) token);
break;
case DTD:
dtd((DTDToken) token);
break;
default:
throw new IllegalStateException("Not implemented yet: " + token);
}
}
// For neatness / symmetry:
_bodyPageElementStack.pop(); // the shunt
// TODO: Check that all stacks are empty. That should never happen, as long
// as the ComponentTemplate is valid.
}
private void parameter(ParameterToken token)
{
BlockImpl block = new BlockImpl(token.getLocation());
String name = token.getName();
Binding binding = new LiteralBinding("block parameter " + name, block, token.getLocation());
// TODO: Check that the t:parameter doesn't appear outside of an embedded component.
_activeElementStack.peek().bindParameter(name, binding);
setupBlock(block);
}
private void setupBlock(BodyPageElement block)
{
_bodyPageElementStack.push(block);
Runnable cleanup = new Runnable()
{
public void run()
{
_bodyPageElementStack.pop();
}
};
configureEnd(true, cleanup);
}
private void block(BlockToken token)
{
// Don't use the page element factory here becauses we need something that is both Block and
// BodyPageElement and don't want to use casts.
BlockImpl block = new BlockImpl(token.getLocation());
String id = token.getId();
if (id != null) _loadingElement.addBlock(id, block);
setupBlock(block);
}
private void startComponent(StartComponentToken token)
{
String elementName = token.getElementName();
// Initial guess: the type from the token (but this may be null in many cases).
String embeddedType = token.getComponentType();
String embeddedId = token.getId();
String embeddedComponentClassName = null;
// We know that if embeddedId is null, embeddedType is not.
if (embeddedId == null) embeddedId = generateEmbeddedId(embeddedType, _idAllocator);
EmbeddedComponentModel embeddedModel = _loadingComponentModel
.getEmbeddedComponentModel(embeddedId);
if (embeddedModel != null)
{
String modelType = embeddedModel.getComponentType();
if (isNonBlank(modelType) && embeddedType != null)
{
Logger log = _loadingComponentModel.getLogger();
log.error(ServicesMessages.compTypeConflict(embeddedId, embeddedType, modelType));
}
embeddedType = modelType;
embeddedComponentClassName = embeddedModel.getComponentClassName();
}
if (isBlank(embeddedType) && isBlank(embeddedComponentClassName))
throw new TapestryException(ServicesMessages.noTypeForEmbeddedComponent(
embeddedId,
_loadingComponentModel.getComponentClassName()), token, null);
ComponentPageElement newComponent = _pageElementFactory.newComponentElement(
_page,
_loadingElement,
embeddedId,
embeddedType,
embeddedComponentClassName,
elementName,
token.getLocation());
addMixinsToComponent(newComponent, embeddedModel, token.getMixins());
Map<String, Binding> bindingMap = newMap();
_componentIdToBindingMap.put(newComponent.getCompleteId(), bindingMap);
if (embeddedModel != null)
bindParametersFromModel(embeddedModel, _loadingElement, newComponent, bindingMap);
addToBody(newComponent);
// Remember to load the template for this new component
_componentQueue.push(newComponent);
// Any attribute tokens that immediately follow should be
// used to bind parameters.
_addAttributesAsComponentBindings = true;
// Any attributes (including component parameters) that come up belong on this component.
_activeElementStack.push(newComponent);
// Set things up so that content inside the component is added to the component's body.
_bodyPageElementStack.push(newComponent);
// And clean that up when the end element is reached.
Runnable cleanup = new Runnable()
{
public void run()
{
_activeElementStack.pop();
_bodyPageElementStack.pop();
}
};
// The start tag is not added to the body of the component, so neither should
// the end tag.
configureEnd(true, cleanup);
}
private void startElement(StartElementToken token)
{
PageElement element = _pageElementFactory.newStartElement(token);
addToBody(element);
// Controls how attributes are interpretted.
_addAttributesAsComponentBindings = false;
// Start will be matched by end:
// Do NOT discard the end tag; add it to the body.
configureEnd(false, NO_OP);
}
private void text(TextToken token)
{
PageElement element = _pageElementFactory.newTextElement(token);
addToBody(element);
}
private void dtd(DTDToken token)
{
// first DTD encountered wins.
if (_dtdAdded) return;
PageElement element = _pageElementFactory.newDTDElement(token);
// since rendering via the markup writer is to the document tree,
// we don't really care where this gets placed in the tree; the
// DTDPageElement will set the dtd of the document directly, rather than
// writing anything to the markup writer
_page.getRootElement().addToTemplate(element);
_dtdAdded = true;
}
/**
* Works the component queue, until exausted.
*/
private void workComponentQueue()
{
while (!_componentQueue.isEmpty())
{
ComponentPageElement componentElement = _componentQueue.pop();
loadTemplateForComponent(componentElement);
}
}
}
The table below shows all metrics for PageLoaderProcessor.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 44.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 112.00 | Comment lines | |
| COMMENT_DENSITY | 0.35 | Comment density | |
| COMPARISONS | 19.00 | Number of comparison operators | |
| CYCLOMATIC | 64.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 21.00 | Comments in declarations | |
| DOC_COMMENT | 41.00 | Number of javadoc comment lines | |
| ELOC | 317.00 | Effective lines of code | |
| EXEC_COMMENTS | 35.00 | Comments in executable code | |
| EXITS | 117.00 | Procedure exits | |
| FUNCTIONS | 30.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 0.34 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 83.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 | 7.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 | 8.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 1.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 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 | 1.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 | 10.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 1.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 | 1.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 2.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 | 0.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 | 2.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 | 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 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 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 | 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 | |
| JAVA0289 | 2.00 | null | |
| LINES | 694.00 | Number of lines in the source file | |
| LINE_COMMENT | 71.00 | Number of line comments | |
| LOC | 413.00 | Lines of code | |
| LOGICAL_LINES | 194.00 | Number of statements | |
| LOOPS | 1.00 | Number of loops | |
| NEST_DEPTH | 3.00 | Maximum nesting depth | |
| OPERANDS | 893.00 | Number of operands | |
| OPERATORS | 1444.00 | Number of operators | |
| PARAMS | 45.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2337.00 | Halstead program length | |
| PROGRAM_VOCAB | 375.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 38.00 | Number of return points from functions | |
| SIZE | 23510.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 333.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 42.00 | Number of unique operators | |
| WHITESPACE | 169.00 | Number of whitespace lines | |