TemplateParserImpl.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.tapestry5.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 |  |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| EXEC_COMMENTS | Comments in executable code | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| SIZE | Size of the file in bytes | |
| EXITS | Procedure exits | |
| WHITESPACE | Number of whitespace lines | |
| PARAMS | Number of formal parameter declarations | |
| RETURNS | Number of return points from functions | |
| DECL_COMMENTS | Comments in declarations | |
| LINES | Number of lines in the source file | |
| UNIQUE_OPERANDS | Number of unique operands | |
| CYCLOMATIC | Cyclomatic complexity | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LOGICAL_LINES | Number of statements | |
| FUNCTIONS | Number of function declarations | |
| LOC | Lines of code | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERANDS | Number of operands | |
| ELOC | Effective lines of code | |
| BLOCKS | Number of blocks | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| UNIQUE_OPERATORS | Number of unique operators | |
| COMPARISONS | Number of comparison operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| 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' | |
| JAVA0075 | JAVA0075 Method parameter hides field | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| COMMENTS | Comment lines | |
// Copyright 2006, 2007, 2008 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.tapestry5.internal.services;
import org.apache.tapestry5.SymbolConstants;
import org.apache.tapestry5.internal.parser.*;
import static org.apache.tapestry5.ioc.IOCConstants.PERTHREAD_SCOPE;
import org.apache.tapestry5.ioc.Location;
import org.apache.tapestry5.ioc.Resource;
import org.apache.tapestry5.ioc.annotations.Scope;
import org.apache.tapestry5.ioc.annotations.Symbol;
import org.apache.tapestry5.ioc.internal.util.CollectionFactory;
import static org.apache.tapestry5.ioc.internal.util.CollectionFactory.newList;
import org.apache.tapestry5.ioc.internal.util.InternalUtils;
import org.apache.tapestry5.ioc.internal.util.LocationImpl;
import org.apache.tapestry5.ioc.internal.util.TapestryException;
import org.apache.tapestry5.ioc.util.Stack;
import org.slf4j.Logger;
import org.xml.sax.*;
import org.xml.sax.ext.LexicalHandler;
import org.xml.sax.helpers.XMLReaderFactory;
import java.io.IOException;
import java.net.URL;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* Non-threadsafe implementation; the IOC service uses the perthread lifecycle.
*/
@Scope(PERTHREAD_SCOPE)
public class TemplateParserImpl implements TemplateParser, LexicalHandler, ContentHandler, EntityResolver
{
private static final String MIXINS_ATTRIBUTE_NAME = "mixins";
private static final String TYPE_ATTRIBUTE_NAME = "type";
private static final String ID_ATTRIBUTE_NAME = "id";
public static final String XML_NAMESPACE_URI = "http://www.w3.org/XML/1998/namespace";
/**
* Used as the namespace URI for Tapestry templates.
*/
public static final String TAPESTRY_SCHEMA_5_0_0 = "http://tapestry.apache.org/schema/tapestry_5_0_0.xsd";
private static final Pattern ID_PATTERN = Pattern.compile("^[a-z]\\w*$", Pattern.CASE_INSENSITIVE);
/**
* Any amount of mixed simple whitespace (space, tab, form feed) mixed with at least one carriage return or line
* feed, followed by any amount of whitespace. Will be reduced to a single linefeed.
*/
private static final Pattern REDUCE_LINEBREAKS_PATTERN = Pattern.compile("[ \\t\\f]*[\\r\\n]\\s*",
Pattern.MULTILINE);
/**
* Used when compressing whitespace, matches any sequence of simple whitespace (space, tab, formfeed). Applied after
* REDUCE_LINEBREAKS_PATTERN.
*/
private static final Pattern REDUCE_WHITESPACE_PATTERN = Pattern.compile("[ \\t\\f]+", Pattern.MULTILINE);
// Note the use of the non-greedy modifier; this prevents the pattern from merging multiple
// expansions on the same text line into a single large
// but invalid expansion.
private static final String EXPANSION_REGEXP = "\\$\\{\\s*(.*?)\\s*}";
private static final Pattern EXPANSION_PATTERN = Pattern.compile(EXPANSION_REGEXP);
private XMLReader reader;
// Resource being parsed
private Resource templateResource;
private Locator locator;
private final List<TemplateToken> tokens = CollectionFactory.newList();
private final boolean compressWhitespaceDefault;
/**
* Because {@link org.xml.sax.ContentHandler#startPrefixMapping(String, String)} events arrive before the
* corresponding {@link org.xml.sax.ContentHandler#startElement(String, String, String, org.xml.sax.Attributes)}
* events, we need to accumlate the {@link org.apache.tapestry5.internal.parser.DefineNamespacePrefixToken}s ahead
* of time to get the correct ordering in the output tokens list.
*/
private final List<DefineNamespacePrefixToken> defineNamespaceTokens = newList();
// Non-blank ids from start component elements
private final Set<String> componentIds = CollectionFactory.newSet();
// Used to accumulate text provided by the characters() method. Even contiguous characters may
// be broken up across multiple invocations due to parser internals. We accumulate those
// together before forming a text token.
private final StringBuilder textBuffer = new StringBuilder();
private Location textStartLocation;
private boolean textIsCData;
private boolean insideBody;
private boolean insideBodyErrorLogged;
private boolean ignoreEvents;
private final Logger logger;
private final Map<String, URL> configuration;
private final Stack<Runnable> endTagHandlerStack = new Stack<Runnable>();
private boolean compressWhitespace;
private final Stack<Boolean> compressWhitespaceStack = new Stack<Boolean>();
private final Runnable endOfElementHandler = new Runnable()
{
public void run()
{
tokens.add(new EndElementToken(getCurrentLocation()));
// Restore the flag to how it was before the element was parsed.
compressWhitespace = compressWhitespaceStack.pop();
}
};
private final Runnable ignoreEndElement = new Runnable()
{
public void run()
{
compressWhitespace = compressWhitespaceStack.pop();
}
};
public TemplateParserImpl(Logger logger, Map<String, URL> configuration,
@Symbol(SymbolConstants.COMPRESS_WHITESPACE)
boolean compressWhitespaceDefault)
{
this.logger = logger;
this.configuration = configuration;
this.compressWhitespaceDefault = compressWhitespaceDefault;
reset();
}
private void reset()
{
tokens.clear();
defineNamespaceTokens.clear();
componentIds.clear();
templateResource = null;
locator = null;
textBuffer.setLength(0);
textStartLocation = null;
textIsCData = false;
insideBody = false;
insideBodyErrorLogged = false;
ignoreEvents = true;
endTagHandlerStack.clear();
compressWhitespaceStack.clear();
}
public ComponentTemplate parseTemplate(Resource templateResource)
{
compressWhitespace = compressWhitespaceDefault;
if (reader == null)
{
try
{
reader = XMLReaderFactory.createXMLReader();
reader.setContentHandler(this);
reader.setEntityResolver(this);
reader.setFeature("http://xml.org/sax/features/namespace-prefixes", true);
reader.setProperty("http://xml.org/sax/properties/lexical-handler", this);
}
catch (Exception ex)
{
throw new RuntimeException(ServicesMessages.newParserError(templateResource, ex), ex);
}
}
if (!templateResource.exists())
throw new RuntimeException(ServicesMessages.missingTemplateResource(templateResource));
this.templateResource = templateResource;
try
{
InputSource source = new InputSource(templateResource.openStream());
reader.parse(source);
return new ComponentTemplateImpl(this.templateResource, tokens, componentIds);
}
catch (Exception ex)
{
// Some parsers get in an unknown state when an error occurs, and are are not
// subsequently useable.
reader = null;
throw new TapestryException(ServicesMessages.templateParseError(templateResource, ex), getCurrentLocation(),
ex);
}
finally
{
reset();
}
}
public void setDocumentLocator(Locator locator)
{
this.locator = locator;
}
/**
* Accumulates the characters into a text buffer.
*/
public void characters(char[] ch, int start, int length) throws SAXException
{
if (ignoreEvents) return;
if (insideBody()) return;
if (textBuffer.length() == 0) textStartLocation = getCurrentLocation();
textBuffer.append(ch, start, length);
}
/**
* Adds tokens corresponding to the content in the text buffer. For a non-CDATA section, we also search for
* expansions (thus we may add more than one token). Clears the text buffer.
*/
private void processTextBuffer()
{
if (textBuffer.length() == 0) return;
String text = textBuffer.toString();
textBuffer.setLength(0);
if (textIsCData)
{
tokens.add(new CDATAToken(text, textStartLocation));
return;
}
if (compressWhitespace)
{
text = compressWhitespaceInText(text);
if (InternalUtils.isBlank(text)) return;
}
addTokensForText(text);
}
private String compressWhitespaceInText(String text)
{
String linebreaksReduced = REDUCE_LINEBREAKS_PATTERN.matcher(text).replaceAll("\n");
return REDUCE_WHITESPACE_PATTERN.matcher(linebreaksReduced).replaceAll(" ");
}
/**
* Scans the text, using a regular expression pattern, for expansion patterns, and adds appropriate tokens for what
* it finds.
*
* @param text to add as {@link org.apache.tapestry5.internal.parser.TextToken}s and {@link
* org.apache.tapestry5.internal.parser.ExpansionToken}s
*/
private void addTokensForText(String text)
{
Matcher matcher = EXPANSION_PATTERN.matcher(text);
int startx = 0;
// The big problem with all this code is that everything gets assigned to the
// start of the text block, even if there are line breaks leading up to it.
// That's going to take a lot more work and there are bigger fish to fry. In addition,
// TAPESTRY-2028 means that the whitespace has likely been stripped out of the text
// already anyway.
while (matcher.find())
{
int matchStart = matcher.start();
if (matchStart != startx)
{
String prefix = text.substring(startx, matchStart);
tokens.add(new TextToken(prefix, textStartLocation));
}
// Group 1 includes the real text of the expansion, with whitespace around the
// expression (but inside the curly braces) excluded.
String expression = matcher.group(1);
tokens.add(new ExpansionToken(expression, textStartLocation));
startx = matcher.end();
}
// Catch anything after the final regexp match.
if (startx < text.length())
tokens.add(new TextToken(text.substring(startx, text.length()), textStartLocation));
}
public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException
{
ignoreEvents = false;
if (insideBody) throw new IllegalStateException(ServicesMessages
.mayNotNestElementsInsideBody(localName));
// Add any accumulated text into a text token
processTextBuffer();
if (TAPESTRY_SCHEMA_5_0_0.equals(uri))
{
startTapestryElement(localName, attributes);
return;
}
startPossibleComponent(attributes, uri, localName, null);
}
/**
* Checks to see if currently inside a t:body element (which should always be empty). Content is ignored inside a
* body. If inside a body, then a warning is logged (but only one warning per body element).
*
* @return true if inside t:body, false otherwise
*/
private boolean insideBody()
{
if (insideBody)
{
// Limit to one logged error per infraction.
if (!insideBodyErrorLogged)
logger.error(ServicesMessages.contentInsideBodyNotAllowed(getCurrentLocation()));
insideBodyErrorLogged = true;
}
return insideBody;
}
private void startTapestryElement(String localName, Attributes attributes)
{
if (localName.equalsIgnoreCase("body"))
{
startBody();
return;
}
if (localName.equalsIgnoreCase("parameter"))
{
startParameter(attributes);
return;
}
if (localName.equalsIgnoreCase("block"))
{
startBlock(attributes);
return;
}
if (localName.equalsIgnoreCase("container"))
{
startContainer(localName, attributes);
return;
}
// The component type is derived from the element name. Since element names may not contain
// slashes, we convert periods to slashes. Later down the pipeline, they'll probably be
// converted back into periods, as part of a fully qualified class name.
String componentType = localName.replace('.', '/');
// With a component type specified, it's not just possibly a component ...
startPossibleComponent(attributes, null, null, componentType);
}
private void startContainer(String elementName, Attributes attributes)
{
compressWhitespaceStack.push(compressWhitespace);
// Neither the container nor its end tag are considered tokens, just the contents inside.
endTagHandlerStack.push(ignoreEndElement);
for (int i = 0; i < attributes.getLength(); i++)
{
String name = attributes.getLocalName(i);
// The name will be blank for an xmlns: attribute
if (InternalUtils.isBlank(name)) continue;
String uri = attributes.getURI(i);
String value = attributes.getValue(i);
if (isXMLSpaceAttribute(uri, name, value)) continue;
throw new TapestryException(ServicesMessages.attributeNotAllowed(elementName), getCurrentLocation(), null);
}
}
private void startBlock(Attributes attributes)
{
addEndOfElementHandler();
String blockId = findSingleParameter("block", "id", attributes);
validateId(blockId, "invalid-block-id");
// null is ok for blockId
tokens.add(new BlockToken(blockId, getCurrentLocation()));
// TODO: Check for an xml:space attribute
}
private void startParameter(Attributes attributes)
{
addEndOfElementHandler();
String parameterName = findSingleParameter("parameter", "name", attributes);
if (InternalUtils.isBlank(parameterName))
throw new TapestryException(ServicesMessages.parameterElementNameRequired(), getCurrentLocation(), null);
tokens.add(new ParameterToken(parameterName, getCurrentLocation()));
}
/**
* Should be called *before* the _compressWhitespace is changed.
*/
private void addEndOfElementHandler()
{
// Record how the flag was set at the start of the element
compressWhitespaceStack.push(compressWhitespace);
endTagHandlerStack.push(endOfElementHandler);
}
private String findSingleParameter(String elementName, String attributeName, Attributes attributes)
{
String result = null;
for (int i = 0; i < attributes.getLength(); i++)
{
String uri = attributes.getURI(i);
String name = attributes.getLocalName(i);
String value = attributes.getValue(i);
if (isXMLSpaceAttribute(uri, name, value)) continue;
if (name.equals(attributeName))
{
result = value;
continue;
}
// Only the named attribute is allowed.
throw new TapestryException(ServicesMessages.undefinedTapestryAttribute(elementName, name, attributeName),
getCurrentLocation(), null);
}
return result;
}
private boolean isXMLSpaceAttribute(String uri, String name, String value)
{
if (uri.equals(XML_NAMESPACE_URI) && name.equals("space"))
{
// "preserve" turns off whitespace compression
// "default" (the other option, but we'll accept anything) turns it on (or leaves it on, more likely).
compressWhitespace = !"preserve".equalsIgnoreCase(value);
return true;
}
return false;
}
private String nullForBlank(String input)
{
return InternalUtils.isBlank(input) ? null : input;
}
/**
* @param attributes the attributes for the element
* @param namespaceURI the namespace URI for the element (or the empty string)
* @param elementName the name of the element (to be assigned to the new token), may be null for a component in
* the Tapestry namespace
* @param identifiedType the type of the element, usually null, but may be the component type derived from
*/
private void startPossibleComponent(Attributes attributes, String namespaceURI, String elementName,
String identifiedType)
{
// Add an end handler to match this start tag.
addEndOfElementHandler();
String id = null;
String type = identifiedType;
String mixins = null;
int count = attributes.getLength();
Location location = getCurrentLocation();
List<TemplateToken> attributeTokens = newList();
for (int i = 0; i < count; i++)
{
String name = attributes.getLocalName(i);
// The name will be blank for an xmlns: attribute
if (InternalUtils.isBlank(name)) continue;
String uri = attributes.getURI(i);
String value = attributes.getValue(i);
if (TAPESTRY_SCHEMA_5_0_0.equals(uri))
{
if (name.equalsIgnoreCase(ID_ATTRIBUTE_NAME))
{
id = nullForBlank(value);
validateId(id, "invalid-component-id");
continue;
}
if (type == null && name.equalsIgnoreCase(TYPE_ATTRIBUTE_NAME))
{
type = nullForBlank(value);
continue;
}
if (name.equalsIgnoreCase(MIXINS_ATTRIBUTE_NAME))
{
mixins = nullForBlank(value);
continue;
}
// Anything else is the name of a Tapestry component parameter that is simply
// not part of the template's doctype for the element being instrumented.
}
if (isXMLSpaceAttribute(uri, name, value)) continue;
attributeTokens.add(new AttributeToken(uri, name, value, location));
}
boolean isComponent = (id != null || type != null);
// If provided t:mixins but not t:id or t:type, then its not quite a component
if (mixins != null && !isComponent)
throw new TapestryException(ServicesMessages.mixinsInvalidWithoutIdOrType(elementName), location, null);
if (isComponent)
{
tokens.add(new StartComponentToken(elementName, id, type, mixins, location));
}
else
{
tokens.add(new StartElementToken(namespaceURI, elementName, location));
}
addDefineNamespaceTokens();
tokens.addAll(attributeTokens);
if (id != null) componentIds.add(id);
// TODO: Is there value in having different end elements for components vs. ordinary
// elements?
}
private void validateId(String id, String messageKey)
{
if (id == null) return;
if (ID_PATTERN.matcher(id).matches()) return;
// Not a match.
throw new TapestryException(ServicesMessages.invalidId(messageKey, id), getCurrentLocation(), null);
}
private void startBody()
{
tokens.add(new BodyToken(getCurrentLocation()));
insideBody = true;
insideBodyErrorLogged = false;
endTagHandlerStack.push(new Runnable()
{
public void run()
{
insideBody = false;
// And don't add an end element token.
}
});
}
public void endElement(String uri, String localName, String qName) throws SAXException
{
processTextBuffer();
endTagHandlerStack.pop().run();
}
private Location getCurrentLocation()
{
if (locator == null) return null;
return new LocationImpl(templateResource, locator.getLineNumber(), locator
.getColumnNumber());
}
/**
* Adds any namespace tokens accumulated from just before the current element. The list of namespace tokens is then
* cleared.
*/
private void addDefineNamespaceTokens()
{
tokens.addAll(defineNamespaceTokens);
defineNamespaceTokens.clear();
}
public void comment(char[] ch, int start, int length) throws SAXException
{
if (ignoreEvents || insideBody()) return;
processTextBuffer();
// Remove excess whitespace. The Comment DOM node will add a leadig and trailing space.
String comment = new String(ch, start, length).trim();
// TODO: Perhaps comments need to be "aggregated" the same way we aggregate text and CDATA.
// Hm. Probably not. Any whitespace between one comment and the next will become a
// TextToken.
// Unless we trim whitespace between consecutive comments ... and on down the rabbit hole.
// Oops -- unless a single comment may be passed into this method as multiple calls
// (have to check how multiline comments are handled).
// Tests against Sun's built in parser does show that multiline comments are still
// provided as a single call to comment(), so we're good for the meantime (until we find
// out some parsers aren't so compliant).
tokens.add(new CommentToken(comment, getCurrentLocation()));
}
public void endCDATA() throws SAXException
{
// Add a token for any accumulated CDATA.
processTextBuffer();
// Again, CDATA doesn't nest, so we know we're back to ordinary markup.
textIsCData = false;
}
public void startCDATA() throws SAXException
{
if (ignoreEvents || insideBody()) return;
processTextBuffer();
// Because CDATA doesn't mix with any other SAX/lexical events, we can simply turn on a flag
// here and turn it off when we see the end.
textIsCData = true;
}
// Empty methods defined by the various interfaces.
public void endDTD() throws SAXException
{
}
public void endEntity(String name) throws SAXException
{
}
public void startDTD(String name, String publicId, String systemId) throws SAXException
{
// notes:
// 1) a DTD has to occur at the very start of a document. Since we don't start
// recording characters until we hit the first element of a document (see
// characters and startElement), there should be no text to process.
// It's worth noting that the sax parser will puke if any of the following
// occur:
// 1) a doctype is encountered multiple times in the same document
// 2) a doctype is encountered anywhere other than the very first item
// in a document.
// Hence, the assumption made in 1 should hold.
// Since an exception is thrown for case #1 above, we can just add the DTDToken.
// When we go to process the token (in PageLoaderProcessor), we can make sure
// that the final page has only a single DTDToken (the first one).
tokens.add(new DTDToken(name, publicId, systemId, getCurrentLocation()));
}
public void startEntity(String name) throws SAXException
{
}
public void endDocument() throws SAXException
{
}
public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
{
}
public void processingInstruction(String target, String data) throws SAXException
{
}
public void skippedEntity(String name) throws SAXException
{
}
public void startDocument() throws SAXException
{
}
public void startPrefixMapping(String prefix, String uri) throws SAXException
{
// Not interested in the Tapestry namespace (that is never sent to the client).
if (uri.equals(TAPESTRY_SCHEMA_5_0_0)) return;
// The prefix may be blank, which happens when the xmlns attribute is used to define the
// namespace for the default namespace, and when a document has an explicit DOCTYPE.
DefineNamespacePrefixToken token = new DefineNamespacePrefixToken(uri, prefix, getCurrentLocation());
defineNamespaceTokens.add(token);
}
public void endPrefixMapping(String prefix) throws SAXException
{
}
public InputSource resolveEntity(String publicId, String systemId) throws SAXException, IOException
{
URL url = configuration.get(publicId);
if (url != null) return new InputSource(url.openStream());
return null;
}
}
The table below shows all metrics for TemplateParserImpl.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 69.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 140.00 | Comment lines | |
| COMMENT_DENSITY | 0.45 | Comment density | |
| COMPARISONS | 43.00 | Number of comparison operators | |
| CYCLOMATIC | 96.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 30.00 | Comments in declarations | |
| DOC_COMMENT | 54.00 | Number of javadoc comment lines | |
| ELOC | 308.00 | Effective lines of code | |
| EXEC_COMMENTS | 31.00 | Comments in executable code | |
| EXITS | 83.00 | Procedure exits | |
| FUNCTIONS | 42.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 72.19 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 122.00 | Interface complexity | |
| JAVA0001 | 1.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 | 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 | 24.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 | 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 | 1.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 | 1.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 1.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 | 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 | 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 | 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 | 2.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 | 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 | |
| LINES | 807.00 | Number of lines in the source file | |
| LINE_COMMENT | 86.00 | Number of line comments | |
| LOC | 451.00 | Lines of code | |
| LOGICAL_LINES | 227.00 | Number of statements | |
| LOOPS | 4.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 976.00 | Number of operands | |
| OPERATORS | 1822.00 | Number of operators | |
| PARAMS | 55.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2798.00 | Halstead program length | |
| PROGRAM_VOCAB | 388.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 67.00 | Number of return points from functions | |
| SIZE | 25850.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 338.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 50.00 | Number of unique operators | |
| WHITESPACE | 216.00 | Number of whitespace lines | |