MessageResources.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.struts.util |
 |
 |
Struts 1 |
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 | |
|---|---|---|
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag |  |
| DECL_COMMENTS | Comments in declarations | |
| DOC_COMMENT | Number of javadoc comment lines | |
| COMMENTS | Comment lines | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| SIZE | Size of the file in bytes | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0143 | JAVA0143 Synchronized method | |
| FUNCTIONS | Number of function declarations | |
| JAVA0016 | JAVA0016 Abstract class contains public constructor | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| LINES | Number of lines in the source file | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0132 | JAVA0132 Method overload with compatible signature | |
| LINE_COMMENT | Number of line comments | |
| LOOPS | Number of loops | |
| COMPARISONS | Number of comparison operators | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| ELOC | Effective lines of code | |
| LOGICAL_LINES | Number of statements | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* $Id: MessageResources.java 471754 2006-11-06 14:55:09Z husted $
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.struts.util;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.io.Serializable;
import java.text.MessageFormat;
import java.util.HashMap;
import java.util.Locale;
/**
* General purpose abstract class that describes an API for retrieving
* Locale-sensitive messages from underlying resource locations of an
* unspecified design, and optionally utilizing the <code>MessageFormat</code>
* class to produce internationalized messages with parametric replacement.
* <p> Calls to <code>getMessage()</code> variants without a
* <code>Locale</code> argument are presumed to be requesting a message string
* in the default <code>Locale</code> for this JVM. <p> Calls to
* <code>getMessage()</code> with an unknown key, or an unknown
* <code>Locale</code> will return <code>null</code> if the
* <code>returnNull</code> property is set to <code>true</code>. Otherwise, a
* suitable error message will be returned instead. <p> <strong>IMPLEMENTATION
* NOTE</strong> - Classes that extend this class must be Serializable so that
* instances may be used in distributable application server environments.
*
* @version $Rev: 471754 $ $Date: 2005-08-29 23:57:50 -0400 (Mon, 29 Aug 2005)
* $
*/
public abstract class MessageResources implements Serializable {
// ------------------------------------------------------------- Properties
/**
* Commons Logging instance.
*/
protected static Log log = LogFactory.getLog(MessageResources.class);
// --------------------------------------------------------- Static Methods
/**
* The default MessageResourcesFactory used to create MessageResources
* instances.
*/
protected static MessageResourcesFactory defaultFactory = null;
/**
* The configuration parameter used to initialize this MessageResources.
*/
protected String config = null;
/**
* The default Locale for our environment.
*/
protected Locale defaultLocale = Locale.getDefault();
/**
* The <code>MessageResourcesFactory</code> that created this instance.
*/
protected MessageResourcesFactory factory = null;
/**
* The set of previously created MessageFormat objects, keyed by the key
* computed in <code>messageKey()</code>.
*/
protected HashMap formats = new HashMap();
/**
* Indicate is a <code>null</code> is returned instead of an error message
* string when an unknown Locale or key is requested.
*/
protected boolean returnNull = false;
/**
* Indicates whether 'escape processing' should be performed on the error
* message string.
*/
private boolean escape = true;
// ----------------------------------------------------------- Constructors
/**
* Construct a new MessageResources according to the specified
* parameters.
*
* @param factory The MessageResourcesFactory that created us
* @param config The configuration parameter for this MessageResources
*/
public MessageResources(MessageResourcesFactory factory, String config) {
this(factory, config, false);
}
/**
* Construct a new MessageResources according to the specified
* parameters.
*
* @param factory The MessageResourcesFactory that created us
* @param config The configuration parameter for this
* MessageResources
* @param returnNull The returnNull property we should initialize with
*/
public MessageResources(MessageResourcesFactory factory, String config,
boolean returnNull) {
super();
this.factory = factory;
this.config = config;
this.returnNull = returnNull;
}
/**
* The configuration parameter used to initialize this MessageResources.
*
* @return parameter used to initialize this MessageResources
*/
public String getConfig() {
return (this.config);
}
/**
* The <code>MessageResourcesFactory</code> that created this instance.
*
* @return <code>MessageResourcesFactory</code> that created instance
*/
public MessageResourcesFactory getFactory() {
return (this.factory);
}
/**
* Indicates that a <code>null</code> is returned instead of an error
* message string if an unknown Locale or key is requested.
*
* @return true if null is returned if unknown key or locale is requested
*/
public boolean getReturnNull() {
return (this.returnNull);
}
/**
* Indicates that a <code>null</code> is returned instead of an error
* message string if an unknown Locale or key is requested.
*
* @param returnNull true Indicates that a <code>null</code> is returned
* if an unknown Locale or key is requested.
*/
public void setReturnNull(boolean returnNull) {
this.returnNull = returnNull;
}
/**
* Indicates whether 'escape processing' should be performed on the error
* message string.
*
* @since Struts 1.2.8
*/
public boolean isEscape() {
return escape;
}
/**
* Set whether 'escape processing' should be performed on the error
* message string.
*
* @since Struts 1.2.8
*/
public void setEscape(boolean escape) {
this.escape = escape;
}
// --------------------------------------------------------- Public Methods
/**
* Returns a text message for the specified key, for the default Locale.
*
* @param key The message key to look up
*/
public String getMessage(String key) {
return this.getMessage((Locale) null, key, null);
}
/**
* Returns a text message after parametric replacement of the specified
* parameter placeholders.
*
* @param key The message key to look up
* @param args An array of replacement parameters for placeholders
*/
public String getMessage(String key, Object[] args) {
return this.getMessage((Locale) null, key, args);
}
/**
* Returns a text message after parametric replacement of the specified
* parameter placeholders.
*
* @param key The message key to look up
* @param arg0 The replacement for placeholder {0} in the message
*/
public String getMessage(String key, Object arg0) {
return this.getMessage((Locale) null, key, arg0);
}
/**
* Returns a text message after parametric replacement of the specified
* parameter placeholders.
*
* @param key The message key to look up
* @param arg0 The replacement for placeholder {0} in the message
* @param arg1 The replacement for placeholder {1} in the message
*/
public String getMessage(String key, Object arg0, Object arg1) {
return this.getMessage((Locale) null, key, arg0, arg1);
}
/**
* Returns a text message after parametric replacement of the specified
* parameter placeholders.
*
* @param key The message key to look up
* @param arg0 The replacement for placeholder {0} in the message
* @param arg1 The replacement for placeholder {1} in the message
* @param arg2 The replacement for placeholder {2} in the message
*/
public String getMessage(String key, Object arg0, Object arg1, Object arg2) {
return this.getMessage((Locale) null, key, arg0, arg1, arg2);
}
/**
* Returns a text message after parametric replacement of the specified
* parameter placeholders.
*
* @param key The message key to look up
* @param arg0 The replacement for placeholder {0} in the message
* @param arg1 The replacement for placeholder {1} in the message
* @param arg2 The replacement for placeholder {2} in the message
* @param arg3 The replacement for placeholder {3} in the message
*/
public String getMessage(String key, Object arg0, Object arg1, Object arg2,
Object arg3) {
return this.getMessage((Locale) null, key, arg0, arg1, arg2, arg3);
}
/**
* Returns a text message for the specified key, for the default Locale. A
* null string result will be returned by this method if no relevant
* message resource is found for this key or Locale, if the
* <code>returnNull</code> property is set. Otherwise, an appropriate
* error message will be returned. <p> This method must be implemented by
* a concrete subclass.
*
* @param locale The requested message Locale, or <code>null</code> for
* the system default Locale
* @param key The message key to look up
*/
public abstract String getMessage(Locale locale, String key);
/**
* Returns a text message after parametric replacement of the specified
* parameter placeholders. A null string result will be returned by this
* method if no resource bundle has been configured.
*
* @param locale The requested message Locale, or <code>null</code> for
* the system default Locale
* @param key The message key to look up
* @param args An array of replacement parameters for placeholders
*/
public String getMessage(Locale locale, String key, Object[] args) {
// Cache MessageFormat instances as they are accessed
if (locale == null) {
locale = defaultLocale;
}
MessageFormat format = null;
String formatKey = messageKey(locale, key);
synchronized (formats) {
format = (MessageFormat) formats.get(formatKey);
if (format == null) {
String formatString = getMessage(locale, key);
if (formatString == null) {
return returnNull ? null : ("???" + formatKey + "???");
}
format = new MessageFormat(escape(formatString));
format.setLocale(locale);
formats.put(formatKey, format);
}
}
return format.format(args);
}
/**
* Returns a text message after parametric replacement of the specified
* parameter placeholders. A null string result will never be returned by
* this method.
*
* @param locale The requested message Locale, or <code>null</code> for
* the system default Locale
* @param key The message key to look up
* @param arg0 The replacement for placeholder {0} in the message
*/
public String getMessage(Locale locale, String key, Object arg0) {
return this.getMessage(locale, key, new Object[] { arg0 });
}
/**
* Returns a text message after parametric replacement of the specified
* parameter placeholders. A null string result will never be returned by
* this method.
*
* @param locale The requested message Locale, or <code>null</code> for
* the system default Locale
* @param key The message key to look up
* @param arg0 The replacement for placeholder {0} in the message
* @param arg1 The replacement for placeholder {1} in the message
*/
public String getMessage(Locale locale, String key, Object arg0, Object arg1) {
return this.getMessage(locale, key, new Object[] { arg0, arg1 });
}
/**
* Returns a text message after parametric replacement of the specified
* parameter placeholders. A null string result will never be returned by
* this method.
*
* @param locale The requested message Locale, or <code>null</code> for
* the system default Locale
* @param key The message key to look up
* @param arg0 The replacement for placeholder {0} in the message
* @param arg1 The replacement for placeholder {1} in the message
* @param arg2 The replacement for placeholder {2} in the message
*/
public String getMessage(Locale locale, String key, Object arg0,
Object arg1, Object arg2) {
return this.getMessage(locale, key, new Object[] { arg0, arg1, arg2 });
}
/**
* Returns a text message after parametric replacement of the specified
* parameter placeholders. A null string result will never be returned by
* this method.
*
* @param locale The requested message Locale, or <code>null</code> for
* the system default Locale
* @param key The message key to look up
* @param arg0 The replacement for placeholder {0} in the message
* @param arg1 The replacement for placeholder {1} in the message
* @param arg2 The replacement for placeholder {2} in the message
* @param arg3 The replacement for placeholder {3} in the message
*/
public String getMessage(Locale locale, String key, Object arg0,
Object arg1, Object arg2, Object arg3) {
return this.getMessage(locale, key,
new Object[] { arg0, arg1, arg2, arg3 });
}
/**
* Return <code>true</code> if there is a defined message for the
* specified key in the system default locale.
*
* @param key The message key to look up
*/
public boolean isPresent(String key) {
return this.isPresent(null, key);
}
/**
* Return <code>true</code> if there is a defined message for the
* specified key in the specified Locale.
*
* @param locale The requested message Locale, or <code>null</code> for
* the system default Locale
* @param key The message key to look up
*/
public boolean isPresent(Locale locale, String key) {
String message = getMessage(locale, key);
if (message == null) {
return false;
} else if (message.startsWith("???") && message.endsWith("???")) {
return false; // FIXME - Only valid for default implementation
} else {
return true;
}
}
// ------------------------------------------------------ Protected Methods
/**
* Escape any single quote characters that are included in the specified
* message string.
*
* @param string The string to be escaped
*/
protected String escape(String string) {
if (!isEscape()) {
return string;
}
if ((string == null) || (string.indexOf('\'') < 0)) {
return string;
}
int n = string.length();
StringBuffer sb = new StringBuffer(n);
for (int i = 0; i < n; i++) {
char ch = string.charAt(i);
if (ch == '\'') {
sb.append('\'');
}
sb.append(ch);
}
return sb.toString();
}
/**
* Compute and return a key to be used in caching information by a Locale.
* <strong>NOTE</strong> - The locale key for the default Locale in our
* environment is a zero length String.
*
* @param locale The locale for which a key is desired
*/
protected String localeKey(Locale locale) {
return (locale == null) ? "" : locale.toString();
}
/**
* Compute and return a key to be used in caching information by Locale
* and message key.
*
* @param locale The Locale for which this format key is calculated
* @param key The message key for which this format key is calculated
*/
protected String messageKey(Locale locale, String key) {
return (localeKey(locale) + "." + key);
}
/**
* Compute and return a key to be used in caching information by locale
* key and message key.
*
* @param localeKey The locale key for which this cache key is calculated
* @param key The message key for which this cache key is
* calculated
*/
protected String messageKey(String localeKey, String key) {
return (localeKey + "." + key);
}
/**
* Create and return an instance of <code>MessageResources</code> for the
* created by the default <code>MessageResourcesFactory</code>.
*
* @param config Configuration parameter for this message bundle.
*/
public synchronized static MessageResources getMessageResources(
String config) {
if (defaultFactory == null) {
defaultFactory = MessageResourcesFactory.createFactory();
}
return defaultFactory.createResources(config);
}
/**
* Log a message to the Writer that has been configured for our use.
*
* @param message The message to be logged
*/
public void log(String message) {
log.debug(message);
}
/**
* Log a message and exception to the Writer that has been configured for
* our use.
*
* @param message The message to be logged
* @param throwable The exception to be logged
*/
public void log(String message, Throwable throwable) {
log.debug(message, throwable);
}
}
The table below shows all metrics for MessageResources.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 40.00 | Number of blocks | |
| BLOCK_COMMENT | 20.00 | Number of block comment lines | |
| COMMENTS | 297.00 | Comment lines | |
| COMMENT_DENSITY | 2.61 | Comment density | |
| COMPARISONS | 15.00 | Number of comparison operators | |
| CYCLOMATIC | 42.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 44.00 | Comments in declarations | |
| DOC_COMMENT | 271.00 | Number of javadoc comment lines | |
| ELOC | 114.00 | Effective lines of code | |
| EXEC_COMMENTS | 1.00 | Comments in executable code | |
| EXITS | 29.00 | Procedure exits | |
| FUNCTIONS | 29.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 57.05 | 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 | 2.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 | 1.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 | 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 | 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 | 1.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 20.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 | 0.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 | 2.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 1.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 1.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 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 | 510.00 | Number of lines in the source file | |
| LINE_COMMENT | 6.00 | Number of line comments | |
| LOC | 153.00 | Lines of code | |
| LOGICAL_LINES | 69.00 | Number of statements | |
| LOOPS | 1.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 398.00 | Number of operands | |
| OPERATORS | 711.00 | Number of operators | |
| PARAMS | 60.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1109.00 | Halstead program length | |
| PROGRAM_VOCAB | 193.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 34.00 | Number of return points from functions | |
| SIZE | 17935.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 150.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 43.00 | Number of unique operators | |
| WHITESPACE | 60.00 | Number of whitespace lines | |