ClassTransformation.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.tapestry5.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 | |
|---|---|---|
| DECL_COMMENTS | Comments in declarations |  |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| COMMENTS | Comment lines | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| FUNCTIONS | Number of function declarations | |
| SIZE | Size of the file in bytes | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| COMMENT_DENSITY | Comment density | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| COMPARISONS | Number of comparison operators | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| LOGICAL_LINES | Number of statements | |
| BLOCKS | Number of blocks | |
| RETURNS | Number of return points from functions | |
| OPERANDS | Number of operands | |
| LOOPS | Number of loops | |
| EXITS | Procedure exits | |
| UNIQUE_OPERATORS | Number of unique operators | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
// 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.services;
import javassist.CtBehavior;
import org.apache.tapestry5.ioc.AnnotationProvider;
import org.slf4j.Logger;
import java.lang.annotation.Annotation;
import java.util.List;
/**
* Contains class-specific information used when transforming a raw component class into an executable component class.
* An executable class is one that has been transformed to work within Tapestry. This includes adding interfaces
* ({@link org.apache.tapestry5.runtime.Component}) but also transforming access to fields, based on annotations and
* naming conventions. Most of the changes are provided by different implementations of {@link
* ComponentClassTransformWorker}.
* <p/>
* Much of this information is somewhat like ordinary reflection, but applies to a class that has not yet been loaded.
* <p/>
* Transformation is primarily about identifying annotations on fields and on methods and changing the class, adding new
* interfaces, fields and methods, and deleting some existing fields.
* <p/>
* A ClassTransformation contains all the state data specific to a particular class being transformed. A number of
* <em>workers</em> will operate upon the ClassTransformation to effect the desired changes before the true class is
* loaded into memory.
* <p/>
* Instances of this class are not designed to be thread safe, access to an instance should be restricted to a single
* thread. In fact, the design of this type is to allow stateless singletons in multiple threads to work on
* thread-specific data (within the ClassTransformation).
* <p/>
* The majority of methods concern the <em>declared</em> members (field and methods) of a specific class, rather than
* any fields or methods inherited from a base class.
*
* @see org.apache.tapestry5.services.TapestryModule#contributeComponentClassTransformWorker(org.apache.tapestry5.ioc.OrderedConfiguration,
* org.apache.tapestry5.ioc.ObjectLocator, InjectionProvider, ComponentClassResolver)
*/
public interface ClassTransformation extends AnnotationProvider
{
/**
* Returns the fully qualified class name of the class being transformed.
*/
String getClassName();
/**
* Returns the name of a new member (field or method). Ensures that the resulting name does not conflict with any
* existing member (declared by the underlying class, or inherited from a base class).
*
* @param suggested the suggested value for the member
* @return a unique name for the member
*/
String newMemberName(String suggested);
/**
* As with {@link #newMemberName(String)}, but the suggested name is constructed from the prefix and base name. An
* underscore will seperate the prefix from the base name.
*
* @param prefix for the generated name
* @param baseName an name, often of an existing field or method
* @return a unique name
*/
String newMemberName(String prefix, String baseName);
/**
* Generates a list of the names of declared instance fields that have the indicated annotation. Non-private and
* static fields are ignored. Only the names of private instance fields are returned.
*/
List<String> findFieldsWithAnnotation(Class<? extends Annotation> annotationClass);
/**
* Finds all methods defined in the class that are marked with the provided annotation.
*
* @param annotationClass
* @return a list of method signature (which may be empty) in ascending order
* @see #findMethods(MethodFilter)
*/
List<TransformMethodSignature> findMethodsWithAnnotation(Class<? extends Annotation> annotationClass);
/**
* Finds all methods matched by the provided filter.
*
* @param filter Passed each method signature, it may include or exclude each potential
* @return a list of matching method signatures (which may be empty) in ascending order (by method name), but
* descending order (by parameter count) within overrides of a single method name.
*/
List<TransformMethodSignature> findMethods(MethodFilter filter);
/**
* Finds all unclaimed fields matched by the provided filter. Only considers private instance fields.
*
* @param filter passed each field name and field type
* @return the names of all matched fields, in ascending order
*/
List<String> findFields(FieldFilter filter);
/**
* Finds an annotation on a declared instance field.
*
* @param <T> constrains parameter and return value to Annotation types
* @param fieldName the name of the field, which must exist
* @param annotationClass the type of annotation to access
* @return the annotation if present, or null otherwise
* @throws IllegalArgumentException if the fieldName does not correspond to a declared field
*/
<T extends Annotation> T getFieldAnnotation(String fieldName, Class<T> annotationClass);
/**
* Finds an annotation on a declared method.
*
* @param <T> constrains parameter and return value to Annotation types
* @param method the method signature to search
* @param annotationClass the type of annotation to access
* @return the annotation if present, or null otherwise
* @throws IllegalArgumentException if the method signature does not correspond to a declared method
*/
<T extends Annotation> T getMethodAnnotation(TransformMethodSignature method, Class<T> annotationClass);
/**
* Claims a field so as to ensure that only a single annotation is applied to any single field. When a
* transformation occurs (driven by a field annotation), the field is claimed (using the annotation object
* as the tag). If a field has multiple conflicting annotations, this will be discovered
* when the code attempts to claim the field a second time.
*
* @param fieldName the name of the field that is being claimed
* @param tag a non-null object that represents why the field is being tagged (this is typically a specific
* annotation on the field)
* @throws IllegalArgumentException if the fieldName does not correspond to a declared instance field
* @throws IllegalStateException if the field is already claimed for some other tag
*/
void claimField(String fieldName, Object tag);
/**
* Changes the field to be read only. Any existing code that changes the field will cause a runtime exception.
*
* @param fieldName name of field to so change
*/
void makeReadOnly(String fieldName);
/**
* Finds any declared <em>instance</em> fields that have not been claimed (via {@link #claimField(String, Object)})
* and returns the names of those fields. May return an empty array.
*/
List<String> findUnclaimedFields();
/**
* Obtains the type of a declared instance field.
*
* @param fieldName
* @return the type of the field, as a string
* @throws IllegalArgumentException if the fieldName does not correspond to a declared instance field
*/
String getFieldType(String fieldName);
/**
* Returns true if the indicated name is a private instance field.
*
* @param fieldName
* @return true if field exists
*/
boolean isField(String fieldName);
/**
* Defines a new declared field for the class. The suggestedName may be modified to ensure uniqueness.
*
* @param modifiers modifiers for the field (typically, {@link java.lang.reflect.Modifier#PRIVATE})
* @param type the type for the field, as a string
* @param suggestedName the desired name for the field, which may be modified (for uniqueness) when returned
* @return the (uniqued) name for the field
*/
String addField(int modifiers, String type, String suggestedName);
/**
* Defines a new <strong>protected</strong> instance variable whose initial value is provided statically, via a
* constructor parameter. The transformation caches the result, so calling this method repeatedly with the same type
* and value will return the same field name. Caching extends to the parent transformation, so that a value injected
* into a parent class will be available (via the protected instance variable) to subclasses.
*
* @param type the type of object to inject
* @param suggestedName the suggested name for the new field
* @param value to be injected. This value is retained.
* @return the actual name of the injected field
*/
String addInjectedField(Class type, String suggestedName, Object value);
/**
* Converts the field into a read only field whose value is the provided value. This is used when converting an
* existing field into a read-only injected value.
*
* @param fieldName name of field to convert
* @param value the value provided by the field
*/
void injectField(String fieldName, Object value);
/**
* Transforms the class to implement the indicated interface. If the class (or its super class) does not already
* implement the interface, then the interface is added, and default implementations of any methods of the interface
* are added.
* <p/>
* TODO: Checking that the names of methods in the interface do not conflict with the names of methods present in
* the (unmodified) class.
*
* @param interfaceClass the interface to be implemented by the class
* @throws IllegalArgumentException if the interfaceClass argument does not represent an interface
*/
void addImplementedInterface(Class interfaceClass);
/**
* Extends an existing method. The provided method body is inserted at the end of the existing method (i.e. {@link
* javassist.CtBehavior#insertAfter(java.lang.String)}). To access or change the return value, use the
* <code>$_</code> pseudo variable.
* <p/>
* The method may be declared in the class, or may be inherited from a super-class. For inherited methods, a method
* is added that first invokes the super implementation. Use {@link #addMethod(TransformMethodSignature, String)}
* when it is necessary to control when the super-class method is invoked.
* <p/>
* The extended method is considered <em>new</em>. New methods <em>are not</em> scanned for {@linkplain
* #removeField(String)} removed}, {@linkplain #replaceReadAccess(String, String)} read replaced}, or {@linkplain
* #replaceWriteAccess(String, String) write replaced} fields. Generally that's what you want!
*
* @param methodSignature the signature of the method to extend
* @param methodBody the body of code
* @throws org.apache.tapestry5.internal.services.MethodCompileException
* if the provided Javassist method body can not be compiled
* @see #extendExistingMethod(TransformMethodSignature, String)
*/
void extendMethod(TransformMethodSignature methodSignature, String methodBody);
/**
* Like {@link #extendMethod(TransformMethodSignature, String)}, but the extension does not mark the method as new,
* and field changes <em>will</em> be processed.
*
* @param methodSignature signature of the method to extend
* @param methodBody the body of code
* @throws org.apache.tapestry5.internal.services.MethodCompileException
* if the provided method body can not be compiled
* @see #prefixMethod(TransformMethodSignature, String)
*/
void extendExistingMethod(TransformMethodSignature methodSignature, String methodBody);
/**
* Inserts code at the beginning of a method body (i.e. {@link CtBehavior#insertBefore(String)}.
* <p/>
* The method may be declared in the class, or may be inherited from a super-class. For inherited methods, a method
* is added that first invokes the super implementation. Use {@link #addMethod(TransformMethodSignature, String)}
* when it is necessary to control when the super-class method is invoked.
* <p/>
* <p/>
* Like {@link #extendExistingMethod(TransformMethodSignature, String)}, this method is generally used to "wrap" an
* existing method adding additional functionality such as caching or transaction support.
*
* @param methodSignature
* @param methodBody
* @throws org.apache.tapestry5.internal.services.MethodCompileException
* if the provided method body can not be compiled
*/
void prefixMethod(TransformMethodSignature methodSignature, String methodBody);
/**
* Returns the name of a field that provides the {@link org.apache.tapestry5.ComponentResources} for the transformed
* component. This will be a protected field, accessible to the class and subclasses.
*
* @return name of field
*/
String getResourcesFieldName();
/**
* Adds a new method to the transformed class. Replaces any existing method declared for the class. When overriding
* a super-class method, you should use {@link #extendMethod(TransformMethodSignature, String)}, or you should
* remember to invoke the super class implemetation explicitly. Use this method to control when the super-class
* implementation is invoked.
*/
void addMethod(TransformMethodSignature signature, String methodBody);
/**
* As with {@link #addMethod(TransformMethodSignature, String)}, but field references inside the method
* <em>will</em> be transformed.
*/
void addTransformedMethod(TransformMethodSignature methodSignature, String methodBody);
/**
* Adds a statement to the constructor. The statement is added as is, though a newline is added.
*
* @param statement the statement to add, which should end with a semicolon
*/
void extendConstructor(String statement);
/**
* Replaces all read-references to the specified field with invocations of the specified method name. Replacements
* do not occur in methods added via {@link #addMethod(TransformMethodSignature, String)} or {@link
* #extendMethod(TransformMethodSignature, String)}.
*/
void replaceReadAccess(String fieldName, String methodName);
/**
* Replaces all write accesses to the specified field with invocations of the specified method name. The method
* should take a single parameter of the same type as the field. Replacements do not occur in methods added via
* {@link #addMethod(TransformMethodSignature, String)} or {@link #extendMethod(TransformMethodSignature, String)}.
*/
void replaceWriteAccess(String fieldName, String methodName);
/**
* Removes a field entirely; this is useful for fields that are replaced entirely by computed values.
*
* @param fieldName the name of the field to remove
* @see #replaceReadAccess(String, String)
* @see #replaceWriteAccess(String, String)
*/
void removeField(String fieldName);
/**
* Converts a type name into a corresponding class (possibly, a transformed class). Primitive type names are
* returned as wrapper types.
*/
Class toClass(String type);
/**
* Returns a logger, based on the class name being transformed, to which warnings or errors concerning the class
* being transformed may be logged.
*/
Logger getLogger();
/**
* Returns the modifiers for the named field.
*/
int getFieldModifiers(String fieldName);
/**
* Converts a signature to a string used to identify the method; this consists of the {@link
* TransformMethodSignature#getMediumDescription()} appended with source file information and line number
* information (when available).
*
* @param signature
* @return a string that identifies the class, method name, types of parameters, source file and source line number
*/
String getMethodIdentifier(TransformMethodSignature signature);
/**
* Returns true if this transformation represents a root class (one that extends directly from Object), or false if
* this transformation is an extension of another transformed class.
*
* @return true if root class, false if sub-class
*/
boolean isRootTransformation();
/**
* Adds a catch block to the method. The body should end with a return or a throw. The special Javassist variable
* $e is the exception instance.
*
* @param methodSignature method to be extended.
* @param exceptionType fully qualified class name of exception
* @param body code to execute
*/
void addCatch(TransformMethodSignature methodSignature, String exceptionType, String body);
/**
* Adds method advice for the indicated method.
*/
void advise(TransformMethodSignature methodSignature, ComponentMethodAdvice advice);
/**
* Returns true if the method is an override of a method from the parent class.
*
* @param methodSignature signature of method to check
* @return true if the parent class contains a method with the name signature
*/
boolean isMethodOverride(TransformMethodSignature methodSignature);
}
The table below shows all metrics for ClassTransformation.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 0.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 295.00 | Comment lines | |
| COMMENT_DENSITY | 6.86 | Comment density | |
| COMPARISONS | 0.00 | Number of comparison operators | |
| CYCLOMATIC | 36.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 50.00 | Comments in declarations | |
| DOC_COMMENT | 282.00 | Number of javadoc comment lines | |
| ELOC | 43.00 | Effective lines of code | |
| EXEC_COMMENTS | 0.00 | Comments in executable code | |
| EXITS | 0.00 | Procedure exits | |
| FUNCTIONS | 36.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 14.46 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 50.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 | 0.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 | 13.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 6.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.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 | 0.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 | 1.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 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 | 381.00 | Number of lines in the source file | |
| LINE_COMMENT | 13.00 | Number of line comments | |
| LOC | 45.00 | Lines of code | |
| LOGICAL_LINES | 42.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 0.00 | Maximum nesting depth | |
| OPERANDS | 188.00 | Number of operands | |
| OPERATORS | 207.00 | Number of operators | |
| PARAMS | 50.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 395.00 | Halstead program length | |
| PROGRAM_VOCAB | 135.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 0.00 | Number of return points from functions | |
| SIZE | 17937.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 117.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 18.00 | Number of unique operators | |
| WHITESPACE | 41.00 | Number of whitespace lines | |