Configuration.java
| Index Score | ||
|---|---|---|
 |
 |
com.espertech.esper.client |
 |
 |
Esper |
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 | |
| COMMENTS | Comment lines | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| SIZE | Size of the file in bytes | |
| FUNCTIONS | Number of function declarations | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| RETURNS | Number of return points from functions | |
| JAVA0259 | JAVA0259 Return of collection/array field | |
| LINES | Number of lines in the source file | |
| UNIQUE_OPERANDS | Number of unique operands | |
| EXITS | Procedure exits | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LOC | Lines of code | |
| BLOCKS | Number of blocks | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| EXEC_COMMENTS | Comments in executable code | |
| LINE_COMMENT | Number of line comments | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| OPERANDS | Number of operands | |
| COMPARISONS | Number of comparison operators | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| LOOPS | Number of loops | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| CYCLOMATIC | Cyclomatic complexity | |
| LOGICAL_LINES | Number of statements | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/**************************************************************************************
* Copyright (C) 2006 Esper Team. All rights reserved. *
* http://esper.codehaus.org *
* ---------------------------------------------------------------------------------- *
* The software in this package is published under the terms of the GPL license *
* a copy of which has been included with this distribution in the license.txt file. *
**************************************************************************************/
package com.espertech.esper.client;
import java.io.*;
import java.net.URL;
import java.util.*;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.w3c.dom.*;
/**
* An instance of <tt>Configuration</tt> allows the application
* to specify properties to be used when
* creating a <tt>EPServiceProvider</tt>. Usually an application will create
* a single <tt>Configuration</tt>, then get one or more instances of
* {@link EPServiceProvider} via {@link EPServiceProviderManager}.
* The <tt>Configuration</tt> is meant
* only as an initialization-time object. <tt>EPServiceProvider</tt>s are
* immutable and do not retain any association back to the
* <tt>Configuration</tt>.
* <br>
* The format of an Esper XML configuration file is defined in
* <tt>esper-configuration-2.0.xsd</tt>.
*/
public class Configuration implements ConfigurationOperations, ConfigurationInformation, Serializable
{
private static Log log = LogFactory.getLog( Configuration.class );
/**
* Default name of the configuration file.
*/
protected static final String ESPER_DEFAULT_CONFIG = "esper.cfg.xml";
/**
* Map of event name and fully-qualified class name.
*/
protected Map<String, String> eventClasses;
/**
* Map of event type alias and XML DOM configuration.
*/
protected Map<String, ConfigurationEventTypeXMLDOM> eventTypesXMLDOM;
/**
* Map of event type alias and Legacy-type event configuration.
*/
protected Map<String, ConfigurationEventTypeLegacy> eventTypesLegacy;
/**
* The type aliases for events that are backed by java.util.Map,
* not containing strongly-typed nested maps.
*/
protected Map<String, Properties> mapAliases;
/**
* The type aliases for events that are backed by java.util.Map,
* possibly containing strongly-typed nested maps.
* <p>
* Each entrie's value must be either a Class or a Map<String,Object> to
* define nested maps.
*/
protected Map<String, Map<String, Object>> nestableMapAliases;
/**
* The class and package name imports that
* will be used to resolve partial class names.
*/
protected List<String> imports;
/**
* The class and package name imports that
* will be used to resolve partial class names.
*/
protected Map<String, ConfigurationDBRef> databaseReferences;
/**
* True until the user calls addAutoImport().
*/
private boolean isUsingDefaultImports = true;
/**
* Optional classname to use for constructing services context.
*/
protected String epServicesContextFactoryClassName;
/**
* List of configured plug-in views.
*/
protected List<ConfigurationPlugInView> plugInViews;
/**
* List of configured plug-in pattern objects.
*/
protected List<ConfigurationPlugInPatternObject> plugInPatternObjects;
/**
* List of configured plug-in aggregation functions.
*/
protected List<ConfigurationPlugInAggregationFunction> plugInAggregationFunctions;
/**
* List of adapter loaders.
*/
protected List<ConfigurationPluginLoader> pluginLoaders;
/**
* Saves engine default configs such as threading settings
*/
protected ConfigurationEngineDefaults engineDefaults;
/**
* Saves the packages to search to resolve event type aliases.
*/
protected Set<String> eventTypeAutoAliasPackages;
/**
* Map of variables.
*/
protected Map<String, ConfigurationVariable> variables;
/**
* Map of class name and configuration for method invocations on that class.
*/
protected Map<String, ConfigurationMethodRef> methodInvocationReferences;
/**
* Constructs an empty configuration. The auto import values
* are set by default to java.lang, java.math, java.text and
* java.util.
*/
public Configuration()
{
reset();
}
/**
* Sets the class name of the services context factory class to use.
* @param epServicesContextFactoryClassName service context factory class name
*/
public void setEPServicesContextFactoryClassName(String epServicesContextFactoryClassName)
{
this.epServicesContextFactoryClassName = epServicesContextFactoryClassName;
}
public String getEPServicesContextFactoryClassName()
{
return epServicesContextFactoryClassName;
}
public void addPlugInAggregationFunction(String functionName, String aggregationClassName)
{
ConfigurationPlugInAggregationFunction entry = new ConfigurationPlugInAggregationFunction();
entry.setFunctionClassName(aggregationClassName);
entry.setName(functionName);
plugInAggregationFunctions.add(entry);
}
/**
* Add an alias for an event type represented by Java-bean plain-old Java object events.
* @param eventTypeAlias is the alias for the event type
* @param eventClassName fully-qualified class name of the event type
*/
public void addEventTypeAlias(String eventTypeAlias, String eventClassName)
{
eventClasses.put(eventTypeAlias, eventClassName);
}
/**
* Add an alias for an event type represented by Java-bean plain-old Java object events.
* @param eventTypeAlias is the alias for the event type
* @param eventClass is the Java event class for which to create the alias
*/
public void addEventTypeAlias(String eventTypeAlias, Class eventClass)
{
addEventTypeAlias(eventTypeAlias, eventClass.getName());
}
/**
* Add an alias for an event type represented by Java-bean plain-old Java object events,
* and the alias is the simple class name of the class.
* @param eventClass is the Java event class for which to create the alias
*/
public void addEventTypeAliasSimpleName(Class eventClass)
{
addEventTypeAlias(eventClass.getSimpleName(), eventClass.getName());
}
/**
* Add an alias for an event type that represents java.util.Map events.
* @param eventTypeAlias is the alias for the event type
* @param typeMap maps the name of each property in the Map event to the type
* (fully qualified classname) of its value in Map event instances.
*/
public void addEventTypeAlias(String eventTypeAlias, Properties typeMap)
{
mapAliases.put(eventTypeAlias, typeMap);
}
/**
* Add an alias for an event type that represents java.util.Map events,
* and for which each property may itself be a Map of further properties,
* with unlimited nesting levels.
* <p>
* Each entry in the type mapping must contain the String property name
* and either a Class or further Map<String, Object> value.
* @param eventTypeAlias is the alias for the event type
* @param typeMap maps the name of each property in the Map event to the type
* (fully qualified classname) of its value in Map event instances.
*/
public void addNestableEventTypeAlias(String eventTypeAlias, Map<String, Object> typeMap)
{
nestableMapAliases.put(eventTypeAlias, typeMap);
}
/**
* Add an alias for an event type that represents java.util.Map events, taking a Map of
* event property and class name as a parameter.
* <p>
* This method is provided for convenience and is same in function to method
* taking a Properties object that contain fully qualified class name as values.
* @param eventTypeAlias is the alias for the event type
* @param typeMap maps the name of each property in the Map event to the type of its value in the Map object
*/
public void addEventTypeAlias(String eventTypeAlias, Map<String, Class> typeMap)
{
Properties properties = new Properties();
for (Map.Entry<String, Class> entry : typeMap.entrySet())
{
properties.put(entry.getKey(), entry.getValue().getName());
}
addEventTypeAlias(eventTypeAlias, properties);
}
/**
* Add an alias for an event type that represents org.w3c.dom.Node events.
* @param eventTypeAlias is the alias for the event type
* @param xmlDOMEventTypeDesc descriptor containing property and mapping information for XML-DOM events
*/
public void addEventTypeAlias(String eventTypeAlias, ConfigurationEventTypeXMLDOM xmlDOMEventTypeDesc)
{
eventTypesXMLDOM.put(eventTypeAlias, xmlDOMEventTypeDesc);
}
/**
* Add a database reference with a given database name.
* @param name is the database name
* @param configurationDBRef descriptor containing database connection and access policy information
*/
public void addDatabaseReference(String name, ConfigurationDBRef configurationDBRef)
{
databaseReferences.put(name, configurationDBRef);
}
/**
* Add an alias for an event type that represents legacy Java type (non-JavaBean style) events.
* @param eventTypeAlias is the alias for the event type
* @param eventClass fully-qualified class name of the event type
* @param legacyEventTypeDesc descriptor containing property and mapping information for Legacy Java type events
*/
public void addEventTypeAlias(String eventTypeAlias, String eventClass, ConfigurationEventTypeLegacy legacyEventTypeDesc)
{
eventClasses.put(eventTypeAlias, eventClass);
eventTypesLegacy.put(eventTypeAlias, legacyEventTypeDesc);
}
public void addImport(String autoImport)
{
if(isUsingDefaultImports)
{
isUsingDefaultImports = false;
imports.clear();
}
imports.add(autoImport);
}
/**
* Adds a cache configuration for a class providing methods for use in the from-clause.
* @param className is the class name (simple or fully-qualified) providing methods
* @param methodInvocationConfig is the cache configuration
*/
public void addMethodRef(String className, ConfigurationMethodRef methodInvocationConfig)
{
this.methodInvocationReferences.put(className, methodInvocationConfig);
}
/**
* Adds a cache configuration for a class providing methods for use in the from-clause.
* @param clazz is the class providing methods
* @param methodInvocationConfig is the cache configuration
*/
public void addMethodRef(Class clazz, ConfigurationMethodRef methodInvocationConfig)
{
this.methodInvocationReferences.put(clazz.getName(), methodInvocationConfig);
}
public Map<String, String> getEventTypeAliases()
{
return eventClasses;
}
public Map<String, Properties> getEventTypesMapEvents()
{
return mapAliases;
}
public Map<String, Map<String, Object>> getEventTypesNestableMapEvents()
{
return nestableMapAliases;
}
public Map<String, ConfigurationEventTypeXMLDOM> getEventTypesXMLDOM()
{
return eventTypesXMLDOM;
}
public Map<String, ConfigurationEventTypeLegacy> getEventTypesLegacy()
{
return eventTypesLegacy;
}
public List<String> getImports()
{
return imports;
}
public Map<String, ConfigurationDBRef> getDatabaseReferences()
{
return databaseReferences;
}
public List<ConfigurationPlugInView> getPlugInViews()
{
return plugInViews;
}
public List<ConfigurationPluginLoader> getPluginLoaders()
{
return pluginLoaders;
}
public List<ConfigurationPlugInAggregationFunction> getPlugInAggregationFunctions()
{
return plugInAggregationFunctions;
}
public List<ConfigurationPlugInPatternObject> getPlugInPatternObjects()
{
return plugInPatternObjects;
}
public Map<String, ConfigurationVariable> getVariables()
{
return variables;
}
public Map<String, ConfigurationMethodRef> getMethodInvocationReferences()
{
return methodInvocationReferences;
}
/**
* Add a plugin loader (f.e. an input/output adapter loader).
* @param loaderName is the name of the loader
* @param className is the fully-qualified classname of the loader class
* @param configuration is loader cofiguration entries
*/
public void addPluginLoader(String loaderName, String className, Properties configuration)
{
ConfigurationPluginLoader pluginLoader = new ConfigurationPluginLoader();
pluginLoader.setLoaderName(loaderName);
pluginLoader.setClassName(className);
pluginLoader.setConfigProperties(configuration);
pluginLoaders.add(pluginLoader);
}
/**
* Add a view for plug-in.
* @param namespace is the namespace the view should be available under
* @param name is the name of the view
* @param viewFactoryClass is the view factory class to use
*/
public void addPlugInView(String namespace, String name, String viewFactoryClass)
{
ConfigurationPlugInView configurationPlugInView = new ConfigurationPlugInView();
configurationPlugInView.setNamespace(namespace);
configurationPlugInView.setName(name);
configurationPlugInView.setFactoryClassName(viewFactoryClass);
plugInViews.add(configurationPlugInView);
}
/**
* Add a pattern event observer for plug-in.
* @param namespace is the namespace the observer should be available under
* @param name is the name of the observer
* @param observerFactoryClass is the observer factory class to use
*/
public void addPlugInPatternObserver(String namespace, String name, String observerFactoryClass)
{
ConfigurationPlugInPatternObject entry = new ConfigurationPlugInPatternObject();
entry.setNamespace(namespace);
entry.setName(name);
entry.setFactoryClassName(observerFactoryClass);
entry.setPatternObjectType(ConfigurationPlugInPatternObject.PatternObjectType.OBSERVER);
plugInPatternObjects.add(entry);
}
/**
* Add a pattern guard for plug-in.
* @param namespace is the namespace the guard should be available under
* @param name is the name of the guard
* @param guardFactoryClass is the guard factory class to use
*/
public void addPlugInPatternGuard(String namespace, String name, String guardFactoryClass)
{
ConfigurationPlugInPatternObject entry = new ConfigurationPlugInPatternObject();
entry.setNamespace(namespace);
entry.setName(name);
entry.setFactoryClassName(guardFactoryClass);
entry.setPatternObjectType(ConfigurationPlugInPatternObject.PatternObjectType.GUARD);
plugInPatternObjects.add(entry);
}
public void addEventTypeAutoAlias(String packageName)
{
eventTypeAutoAliasPackages.add(packageName);
}
public void addVariable(String variableName, Class type, Object initializationValue)
{
ConfigurationVariable configVar = new ConfigurationVariable();
configVar.setType(type);
configVar.setInitializationValue(initializationValue);
variables.put(variableName, configVar);
}
public Set<String> getEventTypeAutoAliasPackages()
{
return eventTypeAutoAliasPackages;
}
public ConfigurationEngineDefaults getEngineDefaults()
{
return engineDefaults;
}
/**
* Use the configuration specified in an application
* resource named <tt>esper.cfg.xml</tt>.
* @return Configuration initialized from the resource
* @throws EPException thrown to indicate error reading configuration
*/
public Configuration configure() throws EPException
{
configure('/' + ESPER_DEFAULT_CONFIG);
return this;
}
/**
* Use the configuration specified in the given application
* resource. The format of the resource is defined in
* <tt>esper-configuration-2.0.xsd</tt>.
* <p/>
* The resource is found via <tt>getConfigurationInputStream(resource)</tt>.
* That method can be overridden to implement an arbitrary lookup strategy.
* <p/>
* See <tt>getResourceAsStream</tt> for information on how the resource name is resolved.
* @param resource if the file name of the resource
* @return Configuration initialized from the resource
* @throws EPException thrown to indicate error reading configuration
*/
public Configuration configure(String resource) throws EPException
{
if (log.isDebugEnabled())
{
log.debug( "configuring from resource: " + resource );
}
InputStream stream = getConfigurationInputStream( resource );
ConfigurationParser.doConfigure(this, stream, resource );
return this;
}
/**
* Get the configuration file as an <tt>InputStream</tt>. Might be overridden
* by subclasses to allow the configuration to be located by some arbitrary
* mechanism.
* <p>
* See <tt>getResourceAsStream</tt> for information on how the resource name is resolved.
* @param resource is the resource name
* @return input stream for resource
* @throws EPException thrown to indicate error reading configuration
*/
protected static InputStream getConfigurationInputStream(String resource) throws EPException
{
if (log.isDebugEnabled())
{
log.debug( "Configuration resource: " + resource );
}
return getResourceAsStream(resource);
}
/**
* Use the configuration specified by the given URL.
* The format of the document obtained from the URL is defined in
* <tt>esper-configuration-2.0.xsd</tt>.
*
* @param url URL from which you wish to load the configuration
* @return A configuration configured via the file
* @throws EPException is thrown when the URL could not be access
*/
public Configuration configure(URL url) throws EPException
{
if (log.isDebugEnabled())
{
log.debug( "configuring from url: " + url.toString() );
}
try {
ConfigurationParser.doConfigure(this, url.openStream(), url.toString());
return this;
}
catch (IOException ioe) {
throw new EPException("could not configure from URL: " + url, ioe );
}
}
/**
* Use the configuration specified in the given application
* file. The format of the file is defined in
* <tt>esper-configuration-2.0.xsd</tt>.
*
* @param configFile <tt>File</tt> from which you wish to load the configuration
* @return A configuration configured via the file
* @throws EPException when the file could not be found
*/
public Configuration configure(File configFile) throws EPException
{
if (log.isDebugEnabled())
{
log.debug( "configuring from file: " + configFile.getName() );
}
try {
ConfigurationParser.doConfigure(this, new FileInputStream(configFile), configFile.toString());
}
catch (FileNotFoundException fnfe) {
throw new EPException( "could not find file: " + configFile, fnfe );
}
return this;
}
/**
* Use the mappings and properties specified in the given XML document.
* The format of the file is defined in
* <tt>esper-configuration-2.0.xsd</tt>.
*
* @param document an XML document from which you wish to load the configuration
* @return A configuration configured via the <tt>Document</tt>
* @throws EPException if there is problem in accessing the document.
*/
public Configuration configure(Document document) throws EPException
{
if (log.isDebugEnabled())
{
log.debug( "configuring from XML document" );
}
ConfigurationParser.doConfigure(this, document);
return this;
}
/**
* Returns an input stream from an application resource in the classpath.
* <p>
* The method first removes the '/' character from the resource name if
* the first character is '/'.
* <p>
* The lookup order is as follows:
* <p>
* If a thread context class loader exists, use <tt>Thread.currentThread().getResourceAsStream</tt>
* to obtain an InputStream.
* <p>
* If no input stream was returned, use the <tt>Configuration.class.getResourceAsStream</tt>.
* to obtain an InputStream.
* <p>
* If no input stream was returned, use the <tt>Configuration.class.getClassLoader().getResourceAsStream</tt>.
* to obtain an InputStream.
* <p>
* If no input stream was returned, throw an Exception.
*
* @param resource to get input stream for
* @return input stream for resource
*/
protected static InputStream getResourceAsStream(String resource)
{
String stripped = resource.startsWith("/") ?
resource.substring(1) : resource;
InputStream stream = null;
ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
if (classLoader!=null) {
stream = classLoader.getResourceAsStream( stripped );
}
if ( stream == null ) {
stream = Configuration.class.getResourceAsStream( resource );
}
if ( stream == null ) {
stream = Configuration.class.getClassLoader().getResourceAsStream( stripped );
}
if ( stream == null ) {
throw new EPException( resource + " not found" );
}
return stream;
}
/**
* Reset to an empty configuration.
*/
protected void reset()
{
eventClasses = new HashMap<String, String>();
mapAliases = new HashMap<String, Properties>();
nestableMapAliases = new HashMap<String, Map<String, Object>>();
eventTypesXMLDOM = new HashMap<String, ConfigurationEventTypeXMLDOM>();
eventTypesLegacy = new HashMap<String, ConfigurationEventTypeLegacy>();
databaseReferences = new HashMap<String, ConfigurationDBRef>();
imports = new ArrayList<String>();
addDefaultImports();
isUsingDefaultImports = true;
plugInViews = new ArrayList<ConfigurationPlugInView>();
pluginLoaders = new ArrayList<ConfigurationPluginLoader>();
plugInAggregationFunctions = new ArrayList<ConfigurationPlugInAggregationFunction>();
plugInPatternObjects = new ArrayList<ConfigurationPlugInPatternObject>();
engineDefaults = new ConfigurationEngineDefaults();
eventTypeAutoAliasPackages = new LinkedHashSet<String>();
variables = new HashMap<String, ConfigurationVariable>();
methodInvocationReferences = new HashMap<String, ConfigurationMethodRef>();
}
/**
* Use these imports until the user specifies something else.
*/
private void addDefaultImports()
{
imports.add("java.lang.*");
imports.add("java.math.*");
imports.add("java.text.*");
imports.add("java.util.*");
}
/**
* Enumeration of different resolution styles for resolving property names.
*/
public static enum PropertyResolutionStyle
{
/**
* Properties are only matched if the names are identical in name
* and case to the original property name.
*/
CASE_SENSITIVE,
/**
* Properties are matched if the names are identical. A case insensitive
* search is used and will choose the first property that matches
* the name exactly or the first property that matches case insensitively
* should no match be found.
*/
CASE_INSENSITIVE,
/**
* Properties are matched if the names are identical. A case insensitive
* search is used and will choose the first property that matches
* the name exactly case insensitively. If more than one 'name' can be
* mapped to the property an exception is thrown.
*/
DISTINCT_CASE_INSENSITIVE;
/**
* Returns the default property resolution style.
* @return is the case-sensitive resolution
*/
public static PropertyResolutionStyle getDefault()
{
return CASE_SENSITIVE;
}
}
}
The table below shows all metrics for Configuration.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 62.00 | Number of blocks | |
| BLOCK_COMMENT | 0.00 | Number of block comment lines | |
| COMMENTS | 289.00 | Comment lines | |
| COMMENT_DENSITY | 1.38 | Comment density | |
| COMPARISONS | 13.00 | Number of comparison operators | |
| CYCLOMATIC | 60.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 51.00 | Comments in declarations | |
| DOC_COMMENT | 289.00 | Number of javadoc comment lines | |
| ELOC | 209.00 | Effective lines of code | |
| EXEC_COMMENTS | 0.00 | Comments in executable code | |
| EXITS | 58.00 | Procedure exits | |
| FUNCTIONS | 47.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 49.04 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 105.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 | 0.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 | 1.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 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 | 6.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 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 103.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 | 1.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 | 6.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 | 692.00 | Number of lines in the source file | |
| LINE_COMMENT | 0.00 | Number of line comments | |
| LOC | 329.00 | Lines of code | |
| LOGICAL_LINES | 142.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 2.00 | Maximum nesting depth | |
| OPERANDS | 665.00 | Number of operands | |
| OPERATORS | 1150.00 | Number of operators | |
| PARAMS | 48.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 1815.00 | Halstead program length | |
| PROGRAM_VOCAB | 319.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 57.00 | Number of return points from functions | |
| SIZE | 25416.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 278.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 41.00 | Number of unique operators | |
| WHITESPACE | 74.00 | Number of whitespace lines | |