DocletTask.java
| Index Score | ||
|---|---|---|
 |
 |
xdoclet |
 |
|
XDoclet |
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 | |
|---|---|---|
| DECL_COMMENTS | Comments in declarations |  |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| SIZE | Size of the file in bytes | |
| FUNCTIONS | Number of function declarations | |
| COMMENTS | Comment lines | |
| EXITS | Procedure exits | |
| RETURNS | Number of return points from functions | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| LINES | Number of lines in the source file | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| BLOCKS | Number of blocks | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| LOC | Lines of code | |
| OPERATORS | Number of operators | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0259 | JAVA0259 Return of collection/array field | |
| CYCLOMATIC | Cyclomatic complexity | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0064 | JAVA0064 N variations of identifier name (maximum: M) | |
| OPERANDS | Number of operands | |
| PROGRAM_VOLUME | Halstead program volume | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| ELOC | Effective lines of code | |
| EXEC_COMMENTS | Comments in executable code | |
| LOOPS | Number of loops | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| LOGICAL_LINES | Number of statements | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0075 | JAVA0075 Method parameter hides field | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* Copyright (c) 2001, 2002 The XDoclet team
* All rights reserved.
*/
package xdoclet;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.DynamicConfigurator;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.types.FileSet;
import xjavadoc.ant.XJavadocTask;
import xdoclet.loader.ModuleFinder;
import xdoclet.loader.SubTaskDefinition;
import xdoclet.loader.XDocletModule;
import xdoclet.util.Translator;
/**
* A base class for all Tasks. It can also be used directly, useful for the case where you want to execute a template
* file but you don't want to bother writing a new task.
*
* @author Ara Abrahamian (ara_e@email.com)
* @author <a href="mailto:aslak.hellesoy@bekk.no">Aslak HellesÔøΩy</a>
* @created June 19, 2001
* @ant.element name="xdoclet" display-name="XDoclet Standard Task"
* @ant.attribute name="encoding" description="Specify the source file encoding name, such as Windows-31J, EUC-JP,
* UTF-8. In default, system default encoding is used."
* @ant.attribute name="docencoding" description="Specify encoding name for template engine. The generated file
* encoding may be this value. In default, system default encoding is used."
*/
public class DocletTask extends XJavadocTask implements DynamicConfigurator
{
// ant will replace the tag with the version property specified in build.xml
public final static String XDOCLET_VERSION = "@VERSION@";
/**
* subtask class -> logical name (java.lang.String) Used to look up names. Lazily created.
*/
private static Map subtaskNameMap;
/**
* logical name (java.lang.String) -> subtask (xdoclet.SubTask or a subclass of it). Lazily created.
*/
private static Map subtaskMap;
private List packageSubstitutions = new ArrayList();
private boolean isModulesRegistered = false;
private File destDir;
private File mergeDir;
private String excludedTags = null;
private boolean force = false;
private boolean verbose = false;
private String addedTags;
private List subTasks = new ArrayList();
private List configParams = new ArrayList();
public DocletTask()
{
ModuleFinder.initClasspath(getClass());
}
public static String getSubTaskName(Class subTaskClass)
{
return (String) getSubtaskNameMap().get(subTaskClass);
}
static Map getConfigParamsAsMap(List configParams)
{
HashMap map = new HashMap();
for (Iterator i = configParams.iterator(); i.hasNext(); ) {
ConfigParameter cp = (ConfigParameter) i.next();
map.put(cp.getName(), cp.getValue());
}
return map;
}
static void registerSubTaskName(SubTask subTask, String name)
{
getSubtaskNameMap().put(subTask.getClass(), name);
}
private static Map getSubtaskMap()
{
if (subtaskMap == null)
subtaskMap = new HashMap();
return subtaskMap;
}
private static Map getSubtaskNameMap()
{
if (subtaskNameMap == null)
subtaskNameMap = new HashMap();
return subtaskNameMap;
}
/**
* Gets the PackageSubstitutions attribute of the EjbDocletTask object
*
* @return The PackageSubstitutions value
*/
public List getPackageSubstitutions()
{
return packageSubstitutions;
}
/**
* Gets the ConfigParams attribute of the DocletTask object
*
* @return The ConfigParams value
*/
public List getConfigParams()
{
return configParams;
}
public Map getConfigParamsAsMap()
{
return getConfigParamsAsMap(getConfigParams());
}
/**
* Gets the MergeDir attribute of the DocletTask object
*
* @return The MergeDir value
*/
public File getMergeDir()
{
return mergeDir;
}
/**
* Gets the ExcludedTags attribute of the DocletTask object
*
* @return The ExcludedTags value
*/
public String getExcludedTags()
{
return excludedTags;
}
/**
* Gets the DestDir attribute of the DocletTask object
*
* @return The DestDir value
*/
public File getDestDir()
{
return destDir;
}
/**
* Gets the Force attribute of the DocletTask object.
*
* @return The Force value
*/
public boolean isForce()
{
return force;
}
/**
* Gets the Verbose attribute of the DocletTask object.
*
* @return The Verbose value
*/
public boolean isVerbose()
{
return verbose;
}
public String getAddedTags()
{
return addedTags;
}
/**
* Sets the PackageSubstitutions attribute of the EjbDocletTask object
*
* @param packageSubstitutions The new PackageSubstitutions value
* @ant.ignore
*/
public void setPackageSubstitutions(List packageSubstitutions)
{
this.packageSubstitutions = packageSubstitutions;
}
/**
* @param name
* @param value
*/
public void setDynamicAttribute(String name, String value)
{
throw new BuildException(Translator.getString(XDocletMessages.class, XDocletMessages.ATTRIBUTE_NOT_SUPPORTED, new String[]{getTaskName(), name}));
}
/**
* Sets the PackageNames attribute of the DocletTask object
*
* @param src The new PackageNames value
* @deprecated
* @ant.ignore
*/
public void setPackageNames(String src)
{
throw new BuildException(Translator.getString(XDocletMessages.class, XDocletMessages.OBSOLETE_TASK_ATTRIBUTE, new String[]{"packageNames"}));
}
/**
* Sets the ExcludePackageNames attribute of the DocletTask object
*
* @param src The new ExcludePackageNames value
* @deprecated
* @ant.ignore
*/
public void setExcludePackageNames(String src)
{
throw new BuildException(Translator.getString(XDocletMessages.class, XDocletMessages.OBSOLETE_TASK_ATTRIBUTE, new String[]{"excludePackageNames"}));
}
/**
* Specify tags that should not be automatically written to output files. The normal behaviour is to include all @
* tags from the source file to the output files. This may cause trouble if you use cvs-like tag like $Revision: 1.5
* $ that will be overwritten at each build and causes a difference for CVS even if the code himself is not changed.
* Example: excludedtags="@ version" For excluded tags, ejbdoclet will generate an hardcoded tag. Example: @ version
* XDOCLET 1.0
*
* @param tags The new ExcludedTags value
* @deprecated
*/
public void setExcludedTags(String tags)
{
excludedTags = tags;
}
/**
* Destination directory for output files
*
* @param dir The new DestDir value
* @ant.not-required Only if it's not specified for a subtask.
*/
public void setDestDir(File dir)
{
destDir = dir;
}
/**
* Directory where subtasks will look for files to be merged with generated files.
*
* @param dir The new MergeDir value
* @ant.not-required No, but should be set if you want to use the merge feature.
*/
public void setMergeDir(File dir)
{
mergeDir = dir;
}
/**
* Specify if the generation of files should be forced. In normal cases, the timestamp of generated file is checked
* against the timestamps of the class (and its super classes) we generate from. When this timestamp checking should
* be bypassed (for example after the installtion of a new xdoclet version) then the user should force the
* regeneration. The easiest way is to run the Ant build file with a parameter "-Dxdoclet.force=true" and add the
* option "force=${xdoclet.force}" to the doclet call.
*
* @param force The new Force value
*/
public void setForce(boolean force)
{
this.force = force;
}
/**
* Sets the Verbose attribute of the DocletTask object.
*
* @param verbose The new Verbose value
*/
public void setVerbose(boolean verbose)
{
this.verbose = verbose;
}
/**
* Add some JavaDoc tags (or comments) to the generated classes. A special case @ xdoclet-generated. If this is
* included, ejbdoclet will not consider the file if it is by error in the fileset of the ejbdoclet task.
*
* @param addedTags
*/
public void setAddedTags(String addedTags)
{
this.addedTags = addedTags;
}
/**
* Substitutes the package of the generated files.
*
* @param ps The feature to be added to the Fileset attribute
*/
public void addPackageSubstitution(xdoclet.tagshandler.PackageTagsHandler.PackageSubstitution ps)
{
packageSubstitutions.add(ps);
}
/**
* Ant's <fileset> definition. To define the files to parse.
*
* @param set a fileset to add
*/
public void addFileset(FileSet set)
{
// does nothing apart from calling super - it's only here for the
// javadocs, for the generated documentation.
super.addFileset(set);
}
/**
* @param name
* @return
* @exception BuildException
*/
public Object createDynamicElement(String name) throws BuildException
{
if (!isModulesRegistered) {
registerModules();
isModulesRegistered = true;
}
SubTask subTask = (SubTask) getSubtaskMap().get(name);
if (subTask == null) {
throw new BuildException(Translator.getString(XDocletMessages.class, XDocletMessages.CREATE_TASK_ERROR, new String[]{name, getTaskName()}));
}
subTasks.add(subTask);
return subTask;
}
/**
* Generic subtask.
*
* @param subtask The subtask to be added
* @ant.ignore
*/
public void addSubTask(SubTask subtask)
{
subTasks.add(subtask);
}
/**
* Generic subtask for processing a user-supplied template.
*
* @param subtask Describe the method parameter
* @exception BuildException
* @ant.ignore
*/
public void addTemplate(TemplateSubTask subtask) throws BuildException
{
if (subtask.getSubTaskClassName() == null) {
addSubTask(subtask);
}
else {
try {
Class subtaskClass = Class.forName(subtask.getSubTaskClassName());
TemplateSubTask alias = (TemplateSubTask) subtaskClass.newInstance();
// now copy from subtask to real alias
alias.copyAttributesFrom(subtask);
addSubTask(alias);
}
catch (ClassNotFoundException e) {
throw new BuildException(Translator.getString(XDocletMessages.class,
XDocletMessages.CLASS_NOT_FOUND_EXCEPTION,
new String[]{subtask.getSubTaskClassName(), e.getMessage()}), e, location);
}
catch (InstantiationException e) {
throw new BuildException(Translator.getString(XDocletMessages.class,
XDocletMessages.INSTANTIATION_EXCEPTION,
new String[]{subtask.getSubTaskClassName(), e.getMessage()}), e, location);
}
catch (IllegalAccessException e) {
throw new BuildException(Translator.getString(XDocletMessages.class,
XDocletMessages.ILLEGAL_ACCESS_EXCEPTION,
new String[]{subtask.getSubTaskClassName(), e.getMessage()}), e, location);
}
}
}
/**
* Generic subtask for processing a user-supplied template, to generate an XML document.
*
* @param subtask Describe the method parameter
* @ant.ignore
*/
public void addXmlTemplate(XmlSubTask subtask)
{
addTemplate(subtask);
}
/**
* Allows to set configuration parameters that will be included in the element as attribute value pair.
*
* @param configParam Describe the method parameter
*/
public void addConfigParam(ConfigParameter configParam)
{
configParams.add(configParam);
}
/**
* Gets the SubTasks attribute of the DocletTask object
*
* @return The SubTasks value
*/
protected final List getSubTasks()
{
return subTasks;
}
/**
* Gets the ConfigParams attribute of the DocletTask object
*
* @param subtasks Describe what the parameter does
* @return The ConfigParams value
*/
protected HashMap getConfigParams(List subtasks)
{
HashMap configs = new HashMap();
// config params of task
ConfigParamIntrospector.fillConfigParamsFor(this, configs);
// config params of substask
for (int i = 0; i < subtasks.size(); i++) {
SubTask subtask = (SubTask) subtasks.get(i);
if (subtask != null) {
ConfigParamIntrospector.fillConfigParamsFor(subtask, configs);
// user defined params of SubTask
fillWithUserDefinedConfigParams(configs, subtask.getConfigParams(), subtask.getSubTaskName() + '.');
}
}
// user defined params of DocletTask
fillWithUserDefinedConfigParams(configs, getConfigParams(), "");
return configs;
}
/**
* @exception BuildException
*/
protected void start() throws BuildException
{
try {
new XDocletMain().start(getXJavaDoc());
}
catch (XDocletException e) {
throw new BuildException(Translator.getString(XDocletMessages.class, XDocletMessages.XDOCLET_FAILED), e, location);
}
finally {
DocletContext.setSingleInstance(null);
subtaskNameMap = null;
subtaskMap = null;
destDir = null;
mergeDir = null;
subTasks = null;
configParams = null;
ModuleFinder.resetFoundModules();
}
}
/**
* Called by superclass before start() is called
*
* @exception BuildException Describe the exception
*/
protected void validateOptions() throws BuildException
{
super.validateOptions();
if (destDir == null) {
throw new BuildException(Translator.getString(XDocletMessages.class, XDocletMessages.ATTRIBUTE_NOT_PRESENT_ERROR, new String[]{"destDir"}), location);
}
validateSubTasks();
}
/**
* Throws BuildException if a specific class is not on the CP. Should be called from subclasses' validateOptions()
* to verify that classpath is OK.
*
* @param className
*/
protected void checkClass(String className)
{
try {
Class.forName(className);
}
catch (Exception e) {
throw new BuildException(Translator.getString(XDocletMessages.class, XDocletMessages.CHECK_CLASS_FAILED, new String[]{className, getTaskName()}));
}
}
/**
* Describe what the method does
*
* @exception BuildException Describe the exception
*/
protected void validateSubTasks() throws BuildException
{
DocletContext context = createContext();
SubTask[] subtasks = context.getSubTasks();
for (int i = 0; i < subtasks.length; i++) {
SubTask subtask = subtasks[i];
if (subtask != null) {
log("validating subTask: " + subtask.getSubTaskName() + " class: " + subtask.getClass(), Project.MSG_DEBUG);
try {
subtask.validateOptions();
}
catch (XDocletException ex) {
throw new BuildException(subtask.getSubTaskName() + ": " + ex.getMessage(), location);
}
}
}
}
private void registerModules()
{
// Register subtasks that apply to us (they do if they in xdoclet.xml have declared us as parent)
List modules = ModuleFinder.findModules();
Iterator i = modules.iterator();
while (i.hasNext()) {
XDocletModule module = (XDocletModule) i.next();
List subTaskDefinitions = module.getSubTaskDefinitions();
Iterator j = subTaskDefinitions.iterator();
while (j.hasNext()) {
SubTaskDefinition subTaskDefinition = (SubTaskDefinition) j.next();
try {
Class parentTaskClass = Class.forName(subTaskDefinition.parentTaskClass);
if (parentTaskClass.isAssignableFrom(getClass())) {
if (getSubtaskMap().containsKey(subTaskDefinition.name)) {
String conflictingSubTaskClassName = getSubtaskMap().get(subTaskDefinition.name).getClass().getName();
if (!subTaskDefinition.implementationClass.equals(conflictingSubTaskClassName)) {
// duplicate subtask definition, and it's not the same classname (which occurs
// if a module is twice or more on classpath - which is OK)
throw new BuildException(Translator.getString(XDocletMessages.class,
XDocletMessages.AMBIGUOUS_SUBTASK_DEFINITION,
new String[]{subTaskDefinition.name, conflictingSubTaskClassName,
subTaskDefinition.implementationClass}));
}
//make sure a new subtask is not created when we can use an already created one. This happens
//when you run the task several times.
continue;
}
Class subTaskClass = Class.forName(subTaskDefinition.implementationClass);
SubTask subTask = (SubTask) subTaskClass.newInstance();
log("Registering SubTask " + subTaskDefinition.name + " (" + subTaskDefinition.implementationClass + ") to DocletTask " + getClass().getName(), Project.MSG_DEBUG);
getSubtaskMap().put(subTaskDefinition.name, subTask);
registerSubTaskName(subTask, subTaskDefinition.name);
}
}
catch (ClassNotFoundException e) {
throw new BuildException(Translator.getString(XDocletMessages.class,
XDocletMessages.DEPENDENT_CLASS_FOR_SUBTASK_NOT_FOUND,
new String[]{subTaskDefinition.parentTaskClass, ModuleFinder.getClasspath()}), e);
}
catch (InstantiationException e) {
throw new BuildException(Translator.getString(XDocletMessages.class,
XDocletMessages.INSTANTIATION_EXCEPTION,
new String[]{subTaskDefinition.implementationClass, e.getMessage()}), e);
}
catch (IllegalAccessException e) {
throw new BuildException(Translator.getString(XDocletMessages.class,
XDocletMessages.ILLEGAL_ACCESS_EXCEPTION,
new String[]{subTaskDefinition.implementationClass, e.getMessage()}), e);
}
catch (ClassCastException e) {
throw new BuildException(Translator.getString(XDocletMessages.class,
XDocletMessages.CLASS_CAST_EXCEPTION,
new String[]{subTaskDefinition.implementationClass, SubTask.class.getName()}), e);
}
}
}
}
/**
* Returns the singleton context object and creates it if not already created and registers it as the single
* instance.
*
* @return the singleton context object
*/
private DocletContext createContext()
{
if (DocletContext.getInstance() != null) {
return DocletContext.getInstance();
}
List subtasks = getSubTasks();
HashMap configs = getConfigParams(subtasks);
DocletContext context = new DocletContext(
this.destDir.toString(),
this.mergeDir != null ? this.mergeDir.toString() : null,
this.excludedTags,
(SubTask[]) subtasks.toArray(new SubTask[0]),
project.getProperties(),
configs,
force,
verbose,
addedTags
);
// now register this single instance
DocletContext.setSingleInstance(context);
return context;
}
/**
* Describe what the method does
*
* @param configs Describe what the parameter does
* @param configParams Describe what the parameter does
* @param prefix Describe what the parameter does
*/
private void fillWithUserDefinedConfigParams(HashMap configs, List configParams, String prefix)
{
// config params declared with <configParam name="nnn" value="val"/>
for (int i = 0; i < configParams.size(); i++) {
ConfigParameter configParam = (ConfigParameter) configParams.get(i);
configs.put((prefix + configParam.getName()).toLowerCase(), configParam.getValue());
}
}
}
The table below shows all metrics for DocletTask.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 74.00 | Number of blocks | |
| BLOCK_COMMENT | 4.00 | Number of block comment lines | |
| COMMENTS | 221.00 | Comment lines | |
| COMMENT_DENSITY | 0.93 | Comment density | |
| COMPARISONS | 26.00 | Number of comparison operators | |
| CYCLOMATIC | 70.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 37.00 | Comments in declarations | |
| DOC_COMMENT | 202.00 | Number of javadoc comment lines | |
| ELOC | 238.00 | Effective lines of code | |
| EXEC_COMMENTS | 11.00 | Comments in executable code | |
| EXITS | 64.00 | Procedure exits | |
| FUNCTIONS | 41.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 67.70 | 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 | 1.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 | 2.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 | 1.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 | 1.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 | 3.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 | 1.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 | 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 | 1.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 4.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 | 5.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 1.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 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 | 7.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 1.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 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 | 3.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 1.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 | 3.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 1.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 658.00 | Number of lines in the source file | |
| LINE_COMMENT | 15.00 | Number of line comments | |
| LOC | 355.00 | Lines of code | |
| LOGICAL_LINES | 142.00 | Number of statements | |
| LOOPS | 6.00 | Number of loops | |
| NEST_DEPTH | 7.00 | Maximum nesting depth | |
| OPERANDS | 725.00 | Number of operands | |
| OPERATORS | 1450.00 | Number of operators | |
| PARAMS | 27.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2175.00 | Halstead program length | |
| PROGRAM_VOCAB | 305.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 56.00 | Number of return points from functions | |
| SIZE | 21689.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 257.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 48.00 | Number of unique operators | |
| WHITESPACE | 82.00 | Number of whitespace lines | |