GroovyPagesTemplateEngine.java
| Index Score | ||
|---|---|---|
 |
 |
org.codehaus.groovy.grails.web.pages |
 |
 |
Grails |
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 |  |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| DECL_COMMENTS | Comments in declarations | |
| EXITS | Procedure exits | |
| SIZE | Size of the file in bytes | |
| COMMENTS | Comment lines | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| RETURNS | Number of return points from functions | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0160 | JAVA0160 Method does not throw specified exception | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| FUNCTIONS | Number of function declarations | |
| BLOCKS | Number of blocks | |
| LINES | Number of lines in the source file | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| OPERANDS | Number of operands | |
| UNIQUE_OPERATORS | Number of unique operators | |
| PROGRAM_LENGTH | Halstead program length | |
| LOGICAL_LINES | Number of statements | |
| OPERATORS | Number of operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0288 | JAVA0288 Inconsistent null check | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| LOOPS | Number of loops | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| ELOC | Effective lines of code | |
| COMPARISONS | Number of comparison operators | |
| LOC | Lines of code | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/* Copyright 2004-2005 the original author or authors.
*
* 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.codehaus.groovy.grails.web.pages;
import grails.util.GrailsUtil;
import groovy.lang.GroovyClassLoader;
import groovy.text.Template;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.codehaus.groovy.control.CompilationFailedException;
import org.codehaus.groovy.grails.commons.GrailsResourceUtils;
import org.codehaus.groovy.grails.support.ResourceAwareTemplateEngine;
import org.codehaus.groovy.grails.web.pages.exceptions.GroovyPagesException;
import org.codehaus.groovy.grails.web.servlet.GrailsApplicationAttributes;
import org.codehaus.groovy.grails.web.servlet.mvc.GrailsWebRequest;
import org.codehaus.groovy.runtime.metaclass.ConcurrentReaderHashMap;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.core.io.*;
import org.springframework.web.context.ServletContextAware;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.support.ServletContextResourceLoader;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.net.URLConnection;
import java.util.Map;
/**
* A GroovyPagesTemplateEngine based on (but not extending) the existing TemplateEngine implementations
* within Groovy. It allows GSP pages to be re-used in different context using code like the below:
*
* <code>
* Template t = new GroovyPagesTemplateEngine()
* .createTemplate(context,request,response);
* t.make()
* .writeTo(out);
* </code>
*
* @author Graeme Rocher
*
* @since 0.1
*
* Created: 12-Jan-2006
*/
public class GroovyPagesTemplateEngine extends ResourceAwareTemplateEngine implements ApplicationContextAware, ServletContextAware {
private static final Log LOG = LogFactory.getLog(GroovyPagesTemplateEngine.class);
private static Map pageCache = new ConcurrentReaderHashMap();
private GroovyClassLoader classLoader = new GroovyClassLoader();
private int scriptNameCount;
private ResourceLoader resourceLoader;
public static final String BEAN_ID = "groovyPagesTemplateEngine";
public static final String RESOURCE_LOADER_BEAN_ID = "groovyPagesResourceLoader";
private boolean reloadEnabled;
private ServletContext servletContext;
private ServletContextResourceLoader servletContextLoader;
public GroovyPagesTemplateEngine() {
}
public GroovyPagesTemplateEngine(ServletContext servletContext) {
if(servletContext == null) throw new IllegalArgumentException("Argument [servletContext] cannot be null");
this.resourceLoader = new ServletContextResourceLoader(servletContext);
this.servletContext = servletContext;
this.servletContextLoader = new ServletContextResourceLoader(servletContext);
}
/**
* Sets the ClassLoader that the TemplateEngine should use to
* @param classLoader The ClassLoader to use when compilation of Groovy Pages occurs
*/
public void setClassLoader(GroovyClassLoader classLoader) {
this.classLoader = classLoader;
}
/**
* Sets a custom ResourceLoader that will be used to load GSPs for URIs
*
* @param resourceLoader The ResourceLoader instance
*/
public void setResourceLoader(ResourceLoader resourceLoader) {
this.resourceLoader = resourceLoader;
}
/**
* Retrieves a line number matrix for the specified page that can be used
* to retrieve the actual line number within the GSP page if the line number within the
* compiled GSP is known
*
* @param context The ServletContext instance
* @param url The URL of the page
* @return An array where the index is the line number witin the compiled GSP and the value is the line number within the source
*/
public int[] calculateLineNumbersForPage(ServletContext context,String url) {
try {
Resource r = getResourceForUri(url);
if(r != null) {
InputStream inputStream = r.getInputStream();
try {
GroovyPageMetaInfo metaInfo = buildPageMetaInfo(inputStream,r, null);
if(metaInfo!= null) {
return metaInfo.getLineNumbers();
}
} finally {
inputStream.close();
}
}
} catch (Exception e) {
// ignore, non critical method used for retrieving debug info
LOG.warn("Exception retrieving line numbers from GSP: " + url + ", message: " + e.getMessage());
LOG.debug("Full stack trace of error", e);
}
return new int[0];
}
/**
* Creates a Template for the given Spring Resource instance
*
* @param resource The Resource to create the Template for
* @return The Template instance
*/
public Template createTemplate(Resource resource) {
if(resource == null) {
GrailsWebRequest webRequest = getWebRequest();
throw new GroovyPagesException("No Groovy page found for URI: " + getCurrentRequestUri(webRequest.getCurrentRequest()));
}
String name = establishPageName(resource, null);
if(pageCache.containsKey(name)) {
GroovyPageMetaInfo meta = (GroovyPageMetaInfo)pageCache.get(name);
if(isGroovyPageReloadable(resource, meta)) {
try {
return createTemplateWithResource(resource);
} catch (IOException e) {
throw new GroovyPagesException("I/O error reading stream for resource ["+resource+"]: " + e.getMessage(),e);
}
}
else {
return new GroovyPageTemplate(meta);
}
}
else {
try {
return createTemplateWithResource(resource);
} catch (IOException e) {
throw new GroovyPagesException("I/O error reading stream for resource ["+resource+"]: " + e.getMessage(),e);
}
}
}
/**
* Creates a Template using the given URI.
*
* @param uri The URI of the page to create the template for
* @return The Template instance
* @throws CompilationFailedException
*/
public Template createTemplate(String uri) {
return createTemplate(getResourceForUri(uri));
}
/**
* Creates a Template using the given text for the Template and the given name. The name
* of the template is required
*
* @param txt The URI of the page to create the template for
* @param pageName The name of the page being parsed
*
* @return The Template instance
* @throws CompilationFailedException
* @throws java.io.IOException Thrown if an IO exception occurs creating the Template
*/
public Template createTemplate(String txt, String pageName) throws IOException {
if(StringUtils.isBlank(txt)) throw new IllegalArgumentException("Argument [txt] cannot be null or blank");
if(StringUtils.isBlank(pageName)) throw new IllegalArgumentException("Argument [pageName] cannot be null or blank");
return createTemplate(new ByteArrayResource(txt.getBytes(), pageName), pageName);
}
private Template createTemplate(Resource resource, String pageName) throws IOException {
InputStream in = resource.getInputStream();
try {
return createTemplate(in, resource, pageName);
}
finally {
in.close();
}
}
/**
* Creates a Template for the currently executing Request
*
* @return The Template for the currently executing request
* @throws java.io.IOException Thrown when an exception occurs Reading the Template
* @throws ClassNotFoundException Thrown when the class of the template was not found
*/
public Template createTemplate() throws IOException, ClassNotFoundException {
GrailsWebRequest webRequest = getWebRequest();
String uri = getCurrentRequestUri(webRequest.getCurrentRequest());
return createTemplate(uri);
}
/**
* Creates a Template for the given file
*
* @param file The File to use to construct the template with
* @return A Groovy Template instance
*
* @throws CompilationFailedException When an error occured compiling the Template
* @throws ClassNotFoundException When a Class cannot be found within the given Template
* @throws IOException When a I/O Exception occurs reading the Template
*/
public Template createTemplate(File file) throws CompilationFailedException, ClassNotFoundException, IOException {
return createTemplate(new FileSystemResource(file));
}
/**
* Creates a Template for the given URL
*
* @param url The URL to use to construct the template with
* @return A Groovy Template instance
*
* @throws CompilationFailedException When an error occured compiling the Template
* @throws ClassNotFoundException When a Class cannot be found within the given Template
* @throws IOException When a I/O Exception occurs reading the Template
*/
public Template createTemplate(URL url) throws CompilationFailedException, ClassNotFoundException, IOException {
return createTemplate(new UrlResource(url));
}
/**
* Create a Template for the given InputStream
* @param inputStream The InputStream to create the Template for
* @return The Template instance
*/
public Template createTemplate(InputStream inputStream) {
GroovyPageMetaInfo metaInfo = buildPageMetaInfo(inputStream, null, null);
return new GroovyPageTemplate(metaInfo);
}
/**
* Creates a Template for the given Spring Resource instance
*
* @param resource The Spring resource instance
* @return A Groovy Template
* @throws java.io.IOException Thrown when an error occurs reading the template
*/
private Template createTemplateWithResource(Resource resource) throws IOException {
InputStream in = resource.getInputStream();
try {
return createTemplate(in, resource, null);
}
finally {
in.close();
}
}
/**
* Constructs a Groovy Template from the given InputStream and Spring Resource object
*
* @param inputStream The InputStream to use
* @param resource The Resource to use
* @param pageName The name of the page
* @return The Groovy Template
*/
protected Template createTemplate(InputStream inputStream, Resource resource, String pageName) {
GroovyPageMetaInfo metaInfo = buildPageMetaInfo(inputStream, resource, pageName);
return new GroovyPageTemplate(metaInfo);
}
/**
* Establishes whether a Groovy page is reloadable. A GSP is only reloadable in the development environment.
*
* @param resource The Resource to check.
* @param meta The current GroovyPageMetaInfo instance
* @return True if it is reloadable
*/
private boolean isGroovyPageReloadable(Resource resource, GroovyPageMetaInfo meta) {
return isReloadEnabled() && (establishLastModified(resource) > meta.getLastModified());
}
/**
* Return whether reload is enabled for the GroovyPagesTemplateEngine
*
* @return True if it is
*/
public boolean isReloadEnabled() {
return this.reloadEnabled;
}
/**
* Sets whether reloading is enabled
*
* @param b True if it is enabled
*/
public void setReloadEnabled(boolean b) {
this.reloadEnabled = true;
}
/**
* Attempts to retrieve a reference to a GSP as a Spring Resource instance for the given URI.
*
* @param uri The URI to check
* @return A Resource instance
*/
public Resource getResourceForUri(String uri) {
Resource r;
r = getResourceWithinContext(uri);
if(r == null || !r.exists()) {
// try plugin
String pluginUri = GrailsResourceUtils.WEB_INF + uri;
r = getResourceWithinContext(pluginUri);
if(r == null || !r.exists()) {
uri = getUriWithinGrailsViews(uri);
return getResourceWithinContext(uri);
}
}
return r;
}
private Resource getResourceWithinContext(String uri) {
if(resourceLoader == null) throw new IllegalStateException("TemplateEngine not initialised correctly, no [resourceLoader] specified!");
Resource r = servletContextLoader.getResource(uri);
if(r.exists()) return r;
return resourceLoader.getResource(uri);
}
/**
* Attempts to establish what the last modified date of the given resource is. If the last modified date cannot
* be etablished -1 is returned
*
* @param resource The Resource to evaluate
* @return The last modified date or -1
*/
private long establishLastModified(Resource resource) {
if(resource ==null)return -1;
long lastModified;
try {
URLConnection urlc = resource.getURL().openConnection();
urlc.setDoInput(false);
urlc.setDoOutput(false);
lastModified = urlc.getLastModified();
} catch (FileNotFoundException fnfe) {
lastModified = -1;
} catch (IOException e) {
lastModified = -1;
}
return lastModified;
}
/**
* Constructs a GroovyPageMetaInfo instance which holds the script class, modified date and so on
*
* @param inputStream The InputStream to construct the GroovyPageMetaInfo instance from
* @param res The Spring Resource to construct the MetaInfo from
* @param pageName The name of the page (can be null, in which case method responsible for calculating appropriate alternative)
* @return The GroovyPageMetaInfo instance
*/
protected GroovyPageMetaInfo buildPageMetaInfo(InputStream inputStream, Resource res, String pageName) {
String name = establishPageName(res, pageName);
long lastModified = establishLastModified(res);
Parse parse;
try {
parse = new Parse(name, res.getDescription(), inputStream);
} catch (IOException e) {
throw new GroovyPagesException("I/O parsing Groovy page ["+(res != null ? res.getDescription() : name)+"]: " + e.getMessage(),e);
}
InputStream in = parse.parse();
// Make a new metaInfo
GroovyPageMetaInfo metaInfo = createPageMetaInfo(parse, lastModified, in);
metaInfo.setPageClass( compileGroovyPage(in, name) );
pageCache.put(name, metaInfo);
return metaInfo;
}
/**
* Attempts to compile the given InputStream into a Groovy script using the given name
* @param in The InputStream to read the Groovy code from
* @param name The name of the class to use
*
* @return The compiled java.lang.Class, which is an instance of groovy.lang.Script
*/
private Class compileGroovyPage(InputStream in, String name) {
// Compile the script into an object
Class scriptClass;
try {
scriptClass =
this.classLoader.parseClass(in, name);
} catch (CompilationFailedException e) {
LOG.error("Compilation error compiling GSP ["+name+"]:" + e.getMessage(), e);
throw new GroovyPagesException("Could not parse script [" + name + "]: " + e.getMessage(), e);
}
return scriptClass;
}
/**
* Creates a GroovyPageMetaInfo instance from the given Parse object, and initialises it with the the specified
* last modifed date and InputStream
*
* @param parse The Parse object
* @param lastModified The last modified date
* @param in The InputStream instance
* @return A GroovyPageMetaInfo instance
*/
private GroovyPageMetaInfo createPageMetaInfo(Parse parse, long lastModified, InputStream in) {
GroovyPageMetaInfo pageMeta = new GroovyPageMetaInfo();
pageMeta.setContentType(parse.getContentType());
pageMeta.setLineNumbers(parse.getLineNumberMatrix());
pageMeta.setLastModified(lastModified);
// just return groovy and don't compile if asked
if (isReloadEnabled() || GrailsUtil.isDevelopmentEnv()) {
pageMeta.setGroovySource(in);
}
return pageMeta;
}
private GrailsWebRequest getWebRequest() {
return (GrailsWebRequest) RequestContextHolder.currentRequestAttributes();
}
/**
* Establishes the name to use for the given resource
*
* @param res The Resource to calculate the name for
* @param pageName The name of the page, can be null, in which case method responsible for calculation
*
* @return The name as a String
*/
protected String establishPageName(Resource res, String pageName) {
if(res == null) {
return generateTemplateName();
}
String name;
try {
name = pageName != null ? pageName : res.getURL().getPath();
// As the name take the first / off and then replace all characters that aren't
// a word character or a digit with an underscore
if(name.startsWith("/")) name = name.substring(1);
name = name.replaceAll("[^\\w\\d]", "_");
} catch (IllegalStateException e) {
name = generateTemplateName();
}
catch (IOException ioex) {
name = generateTemplateName();
}
return name;
}
/**
* Generates the template name to use if it cannot be established from the Resource
*
* @return The template name
*/
private String generateTemplateName() {
return "gsp_script_"+ ++scriptNameCount;
}
/**
* Sets the ResourceLoader from the ApplicationContext
*
* @param applicationContext The ApplicationContext
* @throws BeansException Thrown when an error occurs with the ApplicationContext
*/
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
if(this.resourceLoader == null) {
this.resourceLoader = applicationContext;
}
}
/**
* Return the page identifier.
* @param request The HttpServletRequest instance
* @return The page id
*/
protected String getCurrentRequestUri(HttpServletRequest request) {
// Get the name of the Groovy script (intern the name so that we can
// lock on it)
Object includePath = request.getAttribute("javax.servlet.include.servlet_path");
if (includePath != null) {
return ((String) includePath).intern();
} else {
return request.getServletPath().intern();
}
}
/**
* Returns the path to the view of the relative URI within the Grails views directory
*
* @param relativeUri The relative URI
* @return The path of the URI within the Grails view directory
*/
protected String getUriWithinGrailsViews(String relativeUri) {
StringBuffer buf = new StringBuffer();
String[] tokens;
if(relativeUri.startsWith("/"))
relativeUri = relativeUri.substring(1);
if(relativeUri.indexOf('/')>-1)
tokens = relativeUri.split("/");
else
tokens = new String[]{relativeUri};
buf.append(GrailsApplicationAttributes.PATH_TO_VIEWS);
for (int i = 0; i < tokens.length; i++) {
String token = tokens[i];
buf.append('/').append(token);
}
if(!relativeUri.endsWith(GroovyPage.EXTENSION))
buf.append(GroovyPage.EXTENSION);
return buf.toString();
}
public void setServletContext(ServletContext servletContext) {
this.servletContext = servletContext;
this.servletContextLoader = new ServletContextResourceLoader(servletContext);
if(this.resourceLoader == null)
this.resourceLoader = new ServletContextResourceLoader(servletContext);
}
/**
* Clears the page cache. Views will be re-compiled.
*/
public void clearPageCache() {
pageCache.clear();
}
}
The table below shows all metrics for GroovyPagesTemplateEngine.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 69.00 | Number of blocks | |
| BLOCK_COMMENT | 14.00 | Number of block comment lines | |
| COMMENTS | 217.00 | Comment lines | |
| COMMENT_DENSITY | 0.94 | Comment density | |
| COMPARISONS | 39.00 | Number of comparison operators | |
| CYCLOMATIC | 70.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 28.00 | Comments in declarations | |
| DOC_COMMENT | 194.00 | Number of javadoc comment lines | |
| ELOC | 230.00 | Effective lines of code | |
| EXEC_COMMENTS | 7.00 | Comments in executable code | |
| EXITS | 68.00 | Procedure exits | |
| FUNCTIONS | 32.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 67.55 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 94.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 | 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 | 12.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 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 2.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 2.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 | 3.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 | 3.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 5.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 | 2.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 1.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 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 | 6.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 | 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 | 1.00 | JAVA0288 Inconsistent null check | |
| LINES | 569.00 | Number of lines in the source file | |
| LINE_COMMENT | 9.00 | Number of line comments | |
| LOC | 290.00 | Lines of code | |
| LOGICAL_LINES | 156.00 | Number of statements | |
| LOOPS | 1.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 747.00 | Number of operands | |
| OPERATORS | 1318.00 | Number of operators | |
| PARAMS | 38.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2065.00 | Halstead program length | |
| PROGRAM_VOCAB | 333.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 56.00 | Number of return points from functions | |
| SIZE | 21335.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 282.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 51.00 | Number of unique operators | |
| WHITESPACE | 62.00 | Number of whitespace lines | |