DigesterRuleParser.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.commons.digester.xmlrules |
 |
 |
Commons Digester |
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 |  |
| JAVA0043 | JAVA0043 Inner class does not use outer class | |
| SIZE | Size of the file in bytes | |
| DOC_COMMENT | Number of javadoc comment lines | |
| RETURNS | Number of return points from functions | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| COMMENTS | Comment lines | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| LINES | Number of lines in the source file | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| OPERANDS | Number of operands | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_LENGTH | Halstead program length | |
| FUNCTIONS | Number of function declarations | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| LOGICAL_LINES | Number of statements | |
| OPERATORS | Number of operators | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| BLOCKS | Number of blocks | |
| EXITS | Procedure exits | |
| EXEC_COMMENTS | Comments in executable code | |
| LINE_COMMENT | Number of line comments | |
| PARAMS | Number of formal parameter declarations | |
| JAVA0058 | JAVA0058 Constructor calls super() | |
| JAVA0081 | JAVA0081 Boolean literal in comparison | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| COMPARISONS | Number of comparison operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| UNIQUE_OPERATORS | Number of unique operators | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0179 | JAVA0179 Local variable hides visible field | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0075 | JAVA0075 Method parameter hides field | |
| LOOPS | Number of loops | |
| JAVA0256 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/* $Id: DigesterRuleParser.java 471661 2006-11-06 08:09:25Z skitching $
*
* 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.commons.digester.xmlrules;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.StringTokenizer;
import org.apache.commons.beanutils.ConvertUtils;
import org.apache.commons.collections.ArrayStack;
import org.apache.commons.digester.AbstractObjectCreationFactory;
import org.apache.commons.digester.BeanPropertySetterRule;
import org.apache.commons.digester.CallMethodRule;
import org.apache.commons.digester.CallParamRule;
import org.apache.commons.digester.Digester;
import org.apache.commons.digester.FactoryCreateRule;
import org.apache.commons.digester.NodeCreateRule;
import org.apache.commons.digester.ObjectCreateRule;
import org.apache.commons.digester.Rule;
import org.apache.commons.digester.RuleSetBase;
import org.apache.commons.digester.Rules;
import org.apache.commons.digester.SetNestedPropertiesRule;
import org.apache.commons.digester.SetNextRule;
import org.apache.commons.digester.SetPropertiesRule;
import org.apache.commons.digester.SetPropertyRule;
import org.apache.commons.digester.SetRootRule;
import org.apache.commons.digester.SetTopRule;
import org.apache.commons.digester.ObjectParamRule;
import org.w3c.dom.Node;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
/**
* This is a RuleSet that parses XML into Digester rules, and then
* adds those rules to a 'target' Digester.
*
* @since 1.2
*/
public class DigesterRuleParser extends RuleSetBase {
public static final String DIGESTER_PUBLIC_ID = "-//Jakarta Apache //DTD digester-rules XML V1.0//EN";
/**
* path to the DTD
*/
private String digesterDtdUrl;
/**
* This is the digester to which we are adding the rules that we parse
* from the Rules XML document.
*/
protected Digester targetDigester;
/** See {@link #setBasePath}. */
protected String basePath = "";
/**
* A stack whose toString method returns a '/'-separated concatenation
* of all the elements in the stack.
*/
protected class PatternStack extends ArrayStack {
public String toString() {
StringBuffer str = new StringBuffer();
for (int i = 0; i < size(); i++) {
String elem = get(i).toString();
if (elem.length() > 0) {
if (str.length() > 0) {
str.append('/');
}
str.append(elem);
}
}
return str.toString();
}
}
/**
* A stack used to maintain the current pattern. The Rules XML document
* type allows nesting of patterns. If an element defines a matching
* pattern, the resulting pattern is a concatenation of that pattern with
* all the ancestor elements' patterns. Hence the need for a stack.
*/
protected PatternStack patternStack;
/**
* Used to detect circular includes
*/
private Set includedFiles = new HashSet();
/**
* Constructs a DigesterRuleParser. This object will be inoperable
* until the target digester is set, via <code>setTarget(Digester)</code>
*/
public DigesterRuleParser() {
patternStack = new PatternStack();
}
/**
* Constructs a rule set for converting XML digester rule descriptions
* into Rule objects, and adding them to the given Digester
* @param targetDigester the Digester to add the rules to
*/
public DigesterRuleParser(Digester targetDigester) {
this.targetDigester = targetDigester;
patternStack = new PatternStack();
}
/**
* Constructs a rule set for parsing an XML digester rule file that
* has been included within an outer XML digester rule file. In this
* case, we must pass the pattern stack and the target digester
* to the rule set, as well as the list of files that have already
* been included, for cycle detection.
* @param targetDigester the Digester to add the rules to
* @param stack Stack containing the prefix pattern string to be prepended
* to any pattern parsed by this rule set.
*/
private DigesterRuleParser(Digester targetDigester,
PatternStack stack, Set includedFiles) {
this.targetDigester = targetDigester;
patternStack = stack;
this.includedFiles = includedFiles;
}
/**
* Sets the digester into which to add the parsed rules
* @param d the Digester to add the rules to
*/
public void setTarget(Digester d) {
targetDigester = d;
}
/**
* Set a base pattern beneath which all the rules loaded by this
* object will be registered. If this string is not empty, and does
* not end in a "/", then one will be added.
*
* @since 1.6
*/
public void setBasePath(String path) {
if (path == null) {
basePath = "";
}
else if ((path.length() > 0) && !path.endsWith("/")) {
basePath = path + "/";
} else {
basePath = path;
}
}
/**
* Sets the location of the digester rules DTD. This is the DTD used
* to validate the rules XML file.
*/
public void setDigesterRulesDTD(String dtdURL) {
digesterDtdUrl = dtdURL;
}
/**
* Returns the location of the DTD used to validate the digester rules
* XML document.
*/
protected String getDigesterRulesDTD() {
//ClassLoader classLoader = getClass().getClassLoader();
//URL url = classLoader.getResource(DIGESTER_DTD_PATH);
//return url.toString();
return digesterDtdUrl;
}
/**
* Adds a rule the the target digester. After a rule has been created by
* parsing the XML, it is added to the digester by calling this method.
* Typically, this method is called via reflection, when executing
* a SetNextRule, from the Digester that is parsing the rules XML.
* @param rule a Rule to add to the target digester.
*/
public void add(Rule rule) {
targetDigester.addRule(
basePath + patternStack.toString(), rule);
}
/**
* Add to the given digester the set of Rule instances used to parse an XML
* document defining Digester rules. When the digester parses an XML file,
* it will add the resulting rules & patterns to the 'target digester'
* that was passed in this RuleSet's constructor.<P>
* If you extend this class to support additional rules, your implementation
* should of this method should call this implementation first: i.e.
* <code>super.addRuleInstances(digester);</code>
*/
public void addRuleInstances(Digester digester) {
final String ruleClassName = Rule.class.getName();
digester.register(DIGESTER_PUBLIC_ID, getDigesterRulesDTD());
digester.addRule("*/pattern", new PatternRule("value"));
digester.addRule("*/include", new IncludeRule());
digester.addFactoryCreate("*/bean-property-setter-rule", new BeanPropertySetterRuleFactory());
digester.addRule("*/bean-property-setter-rule", new PatternRule("pattern"));
digester.addSetNext("*/bean-property-setter-rule", "add", ruleClassName);
digester.addFactoryCreate("*/call-method-rule", new CallMethodRuleFactory());
digester.addRule("*/call-method-rule", new PatternRule("pattern"));
digester.addSetNext("*/call-method-rule", "add", ruleClassName);
digester.addFactoryCreate("*/object-param-rule", new ObjectParamRuleFactory());
digester.addRule("*/object-param-rule", new PatternRule("pattern"));
digester.addSetNext("*/object-param-rule", "add", ruleClassName);
digester.addFactoryCreate("*/call-param-rule", new CallParamRuleFactory());
digester.addRule("*/call-param-rule", new PatternRule("pattern"));
digester.addSetNext("*/call-param-rule", "add", ruleClassName);
digester.addFactoryCreate("*/factory-create-rule", new FactoryCreateRuleFactory());
digester.addRule("*/factory-create-rule", new PatternRule("pattern"));
digester.addSetNext("*/factory-create-rule", "add", ruleClassName);
digester.addFactoryCreate("*/object-create-rule", new ObjectCreateRuleFactory());
digester.addRule("*/object-create-rule", new PatternRule("pattern"));
digester.addSetNext("*/object-create-rule", "add", ruleClassName);
digester.addFactoryCreate("*/node-create-rule", new NodeCreateRuleFactory());
digester.addRule("*/node-create-rule", new PatternRule("pattern"));
digester.addSetNext("*/node-create-rule", "add", ruleClassName);
digester.addFactoryCreate("*/set-properties-rule", new SetPropertiesRuleFactory());
digester.addRule("*/set-properties-rule", new PatternRule("pattern"));
digester.addSetNext("*/set-properties-rule", "add", ruleClassName);
digester.addRule("*/set-properties-rule/alias", new SetPropertiesAliasRule());
digester.addFactoryCreate("*/set-property-rule", new SetPropertyRuleFactory());
digester.addRule("*/set-property-rule", new PatternRule("pattern"));
digester.addSetNext("*/set-property-rule", "add", ruleClassName);
digester.addFactoryCreate("*/set-nested-properties-rule", new SetNestedPropertiesRuleFactory());
digester.addRule("*/set-nested-properties-rule", new PatternRule("pattern"));
digester.addSetNext("*/set-nested-properties-rule", "add", ruleClassName);
digester.addRule("*/set-nested-properties-rule/alias", new SetNestedPropertiesAliasRule());
digester.addFactoryCreate("*/set-top-rule", new SetTopRuleFactory());
digester.addRule("*/set-top-rule", new PatternRule("pattern"));
digester.addSetNext("*/set-top-rule", "add", ruleClassName);
digester.addFactoryCreate("*/set-next-rule", new SetNextRuleFactory());
digester.addRule("*/set-next-rule", new PatternRule("pattern"));
digester.addSetNext("*/set-next-rule", "add", ruleClassName);
digester.addFactoryCreate("*/set-root-rule", new SetRootRuleFactory());
digester.addRule("*/set-root-rule", new PatternRule("pattern"));
digester.addSetNext("*/set-root-rule", "add", ruleClassName);
}
/**
* A rule for extracting the pattern matching strings from the rules XML.
* In the digester-rules document type, a pattern can either be declared
* in the 'value' attribute of a <pattern> element (in which case the pattern
* applies to all rules elements contained within the <pattern> element),
* or it can be declared in the optional 'pattern' attribute of a rule
* element.
*/
private class PatternRule extends Rule {
private String attrName;
private String pattern = null;
/**
* @param attrName The name of the attribute containing the pattern
*/
public PatternRule(String attrName) {
super();
this.attrName = attrName;
}
/**
* If a pattern is defined for the attribute, push it onto the
* pattern stack.
*/
public void begin(Attributes attributes) {
pattern = attributes.getValue(attrName);
if (pattern != null) {
patternStack.push(pattern);
}
}
/**
* If there was a pattern for this element, pop it off the pattern
* stack.
*/
public void end() {
if (pattern != null) {
patternStack.pop();
}
}
}
/**
* A rule for including one rules XML file within another. Included files
* behave as if they are 'macro-expanded' within the includer. This means
* that the values of the pattern stack are prefixed to every pattern
* in the included rules. <p>This rule will detect 'circular' includes,
* which would result in infinite recursion. It throws a
* CircularIncludeException when a cycle is detected, which will terminate
* the parse.
*/
private class IncludeRule extends Rule {
public IncludeRule() {
super();
}
/**
* To include a rules xml file, we instantiate another Digester, and
* another DigesterRulesRuleSet. We pass the
* pattern stack and the target Digester to the new rule set, and
* tell the Digester to parse the file.
*/
public void begin(Attributes attributes) throws Exception {
// The path attribute gives the URI to another digester rules xml file
String fileName = attributes.getValue("path");
if (fileName != null && fileName.length() > 0) {
includeXMLRules(fileName);
}
// The class attribute gives the name of a class that implements
// the DigesterRulesSource interface
String className = attributes.getValue("class");
if (className != null && className.length() > 0) {
includeProgrammaticRules(className);
}
}
/**
* Creates another DigesterRuleParser, and uses it to extract the rules
* out of the give XML file. The contents of the current pattern stack
* will be prepended to all of the pattern strings parsed from the file.
*/
private void includeXMLRules(String fileName)
throws IOException, SAXException, CircularIncludeException {
ClassLoader cl = Thread.currentThread().getContextClassLoader();
if (cl == null) {
cl = DigesterRuleParser.this.getClass().getClassLoader();
}
URL fileURL = cl.getResource(fileName);
if (fileURL == null) {
throw new FileNotFoundException("File \"" + fileName + "\" not found.");
}
fileName = fileURL.toExternalForm();
if (includedFiles.add(fileName) == false) {
// circular include detected
throw new CircularIncludeException(fileName);
}
// parse the included xml file
DigesterRuleParser includedSet =
new DigesterRuleParser(targetDigester, patternStack, includedFiles);
includedSet.setDigesterRulesDTD(getDigesterRulesDTD());
Digester digester = new Digester();
digester.addRuleSet(includedSet);
digester.push(DigesterRuleParser.this);
digester.parse(fileName);
includedFiles.remove(fileName);
}
/**
* Creates an instance of the indicated class. The class must implement
* the DigesterRulesSource interface. Passes the target digester to
* that instance. The DigesterRulesSource instance is supposed to add
* rules into the digester. The contents of the current pattern stack
* will be automatically prepended to all of the pattern strings added
* by the DigesterRulesSource instance.
*/
private void includeProgrammaticRules(String className)
throws ClassNotFoundException, ClassCastException,
InstantiationException, IllegalAccessException {
Class cls = Class.forName(className);
DigesterRulesSource rulesSource = (DigesterRulesSource) cls.newInstance();
// wrap the digester's Rules object, to prepend pattern
Rules digesterRules = targetDigester.getRules();
Rules prefixWrapper =
new RulesPrefixAdapter(patternStack.toString(), digesterRules);
targetDigester.setRules(prefixWrapper);
try {
rulesSource.getRules(targetDigester);
} finally {
// Put the unwrapped rules back
targetDigester.setRules(digesterRules);
}
}
}
/**
* Wraps a Rules object. Delegates all the Rules interface methods
* to the underlying Rules object. Overrides the add method to prepend
* a prefix to the pattern string.
*/
private class RulesPrefixAdapter implements Rules {
private Rules delegate;
private String prefix;
/**
* @param patternPrefix the pattern string to prepend to the pattern
* passed to the add method.
* @param rules The wrapped Rules object. All of this class's methods
* pass through to this object.
*/
public RulesPrefixAdapter(String patternPrefix, Rules rules) {
prefix = patternPrefix;
delegate = rules;
}
/**
* Register a new Rule instance matching a pattern which is constructed
* by concatenating the pattern prefix with the given pattern.
*/
public void add(String pattern, Rule rule) {
StringBuffer buffer = new StringBuffer();
buffer.append(prefix);
if (!pattern.startsWith("/")) {
buffer.append('/');
}
buffer.append(pattern);
delegate.add(buffer.toString(), rule);
}
/**
* This method passes through to the underlying Rules object.
*/
public void clear() {
delegate.clear();
}
/**
* This method passes through to the underlying Rules object.
*/
public Digester getDigester() {
return delegate.getDigester();
}
/**
* This method passes through to the underlying Rules object.
*/
public String getNamespaceURI() {
return delegate.getNamespaceURI();
}
/**
* @deprecated Call match(namespaceURI,pattern) instead.
*/
public List match(String pattern) {
return delegate.match(pattern);
}
/**
* This method passes through to the underlying Rules object.
*/
public List match(String namespaceURI, String pattern) {
return delegate.match(namespaceURI, pattern);
}
/**
* This method passes through to the underlying Rules object.
*/
public List rules() {
return delegate.rules();
}
/**
* This method passes through to the underlying Rules object.
*/
public void setDigester(Digester digester) {
delegate.setDigester(digester);
}
/**
* This method passes through to the underlying Rules object.
*/
public void setNamespaceURI(String namespaceURI) {
delegate.setNamespaceURI(namespaceURI);
}
}
///////////////////////////////////////////////////////////////////////
// Classes beyond this point are ObjectCreationFactory implementations,
// used to create Rule objects and initialize them from SAX attributes.
///////////////////////////////////////////////////////////////////////
/**
* Factory for creating a BeanPropertySetterRule.
*/
private class BeanPropertySetterRuleFactory extends AbstractObjectCreationFactory {
public Object createObject(Attributes attributes) throws Exception {
Rule beanPropertySetterRule = null;
String propertyname = attributes.getValue("propertyname");
if (propertyname == null) {
// call the setter method corresponding to the element name.
beanPropertySetterRule = new BeanPropertySetterRule();
} else {
beanPropertySetterRule = new BeanPropertySetterRule(propertyname);
}
return beanPropertySetterRule;
}
}
/**
* Factory for creating a CallMethodRule.
*/
protected class CallMethodRuleFactory extends AbstractObjectCreationFactory {
public Object createObject(Attributes attributes) {
Rule callMethodRule = null;
String methodName = attributes.getValue("methodname");
// Select which element is to be the target. Default to zero,
// ie the top object on the stack.
int targetOffset = 0;
String targetOffsetStr = attributes.getValue("targetoffset");
if (targetOffsetStr != null) {
targetOffset = Integer.parseInt(targetOffsetStr);
}
if (attributes.getValue("paramcount") == null) {
// call against empty method
callMethodRule = new CallMethodRule(targetOffset, methodName);
} else {
int paramCount = Integer.parseInt(attributes.getValue("paramcount"));
String paramTypesAttr = attributes.getValue("paramtypes");
if (paramTypesAttr == null || paramTypesAttr.length() == 0) {
callMethodRule = new CallMethodRule(targetOffset, methodName, paramCount);
} else {
String[] paramTypes = getParamTypes(paramTypesAttr);
callMethodRule = new CallMethodRule(
targetOffset, methodName, paramCount, paramTypes);
}
}
return callMethodRule;
}
/**
* Process the comma separated list of paramTypes
* into an array of String class names
*/
private String[] getParamTypes(String paramTypes) {
String[] paramTypesArray;
if( paramTypes != null ) {
ArrayList paramTypesList = new ArrayList();
StringTokenizer tokens = new StringTokenizer(
paramTypes, " \t\n\r,");
while (tokens.hasMoreTokens()) {
paramTypesList.add(tokens.nextToken());
}
paramTypesArray = (String[])paramTypesList.toArray(new String[0]);
} else {
paramTypesArray = new String[0];
}
return paramTypesArray;
}
}
/**
* Factory for creating a CallParamRule.
*/
protected class CallParamRuleFactory extends AbstractObjectCreationFactory {
public Object createObject(Attributes attributes) {
// create callparamrule
int paramIndex = Integer.parseInt(attributes.getValue("paramnumber"));
String attributeName = attributes.getValue("attrname");
String fromStack = attributes.getValue("from-stack");
String stackIndex = attributes.getValue("stack-index");
Rule callParamRule = null;
if (attributeName == null) {
if (stackIndex != null) {
callParamRule = new CallParamRule(
paramIndex, Integer.parseInt(stackIndex));
} else if (fromStack != null) {
callParamRule = new CallParamRule(
paramIndex, Boolean.valueOf(fromStack).booleanValue());
} else {
callParamRule = new CallParamRule(paramIndex);
}
} else {
if (fromStack == null) {
callParamRule = new CallParamRule(paramIndex, attributeName);
} else {
// specifying both from-stack and attribute name is not allowed
throw new RuntimeException(
"Attributes from-stack and attrname cannot both be present.");
}
}
return callParamRule;
}
}
/**
* Factory for creating a ObjectParamRule
*/
protected class ObjectParamRuleFactory extends AbstractObjectCreationFactory {
public Object createObject(Attributes attributes) throws Exception {
// create callparamrule
int paramIndex = Integer.parseInt(attributes.getValue("paramnumber"));
String attributeName = attributes.getValue("attrname");
String type = attributes.getValue("type");
String value = attributes.getValue("value");
Rule objectParamRule = null;
// type name is requried
if (type == null) {
throw new RuntimeException("Attribute 'type' is required.");
}
// create object instance
Object param = null;
Class clazz = Class.forName(type);
if (value == null) {
param = clazz.newInstance();
} else {
param = ConvertUtils.convert(value, clazz);
}
if (attributeName == null) {
objectParamRule = new ObjectParamRule(paramIndex, param);
} else {
objectParamRule = new ObjectParamRule(paramIndex, attributeName, param);
}
return objectParamRule;
}
}
/**
* Factory for creating a NodeCreateRule
*/
protected class NodeCreateRuleFactory extends AbstractObjectCreationFactory {
public Object createObject(Attributes attributes) throws Exception {
String nodeType = attributes.getValue("type");
if (nodeType == null || "".equals(nodeType)) {
// uses Node.ELEMENT_NODE
return new NodeCreateRule();
} else if ("element".equals(nodeType)) {
return new NodeCreateRule(Node.ELEMENT_NODE);
} else if ("fragment".equals(nodeType)) {
return new NodeCreateRule(Node.DOCUMENT_FRAGMENT_NODE);
} else {
throw new RuntimeException(
"Unrecognized node type: "
+ nodeType
+ ". This attribute is optional or can have a value of element|fragment.");
}
}
}
/**
* Factory for creating a FactoryCreateRule
*/
protected class FactoryCreateRuleFactory extends AbstractObjectCreationFactory {
public Object createObject(Attributes attributes) {
String className = attributes.getValue("classname");
String attrName = attributes.getValue("attrname");
boolean ignoreExceptions =
"true".equalsIgnoreCase(attributes.getValue("ignore-exceptions"));
return (attrName == null || attrName.length() == 0) ?
new FactoryCreateRule( className, ignoreExceptions) :
new FactoryCreateRule( className, attrName, ignoreExceptions);
}
}
/**
* Factory for creating a ObjectCreateRule
*/
protected class ObjectCreateRuleFactory extends AbstractObjectCreationFactory {
public Object createObject(Attributes attributes) {
String className = attributes.getValue("classname");
String attrName = attributes.getValue("attrname");
return (attrName == null || attrName.length() == 0) ?
new ObjectCreateRule( className) :
new ObjectCreateRule( className, attrName);
}
}
/**
* Factory for creating a SetPropertiesRule
*/
protected class SetPropertiesRuleFactory extends AbstractObjectCreationFactory {
public Object createObject(Attributes attributes) {
return new SetPropertiesRule();
}
}
/**
* Factory for creating a SetPropertyRule
*/
protected class SetPropertyRuleFactory extends AbstractObjectCreationFactory {
public Object createObject(Attributes attributes) {
String name = attributes.getValue("name");
String value = attributes.getValue("value");
return new SetPropertyRule( name, value);
}
}
/**
* Factory for creating a SetNestedPropertiesRule
*/
protected class SetNestedPropertiesRuleFactory extends AbstractObjectCreationFactory {
public Object createObject(Attributes attributes) {
boolean allowUnknownChildElements =
"true".equalsIgnoreCase(attributes.getValue("allow-unknown-child-elements"));
SetNestedPropertiesRule snpr = new SetNestedPropertiesRule();
snpr.setAllowUnknownChildElements( allowUnknownChildElements );
return snpr;
}
}
/**
* Factory for creating a SetTopRuleFactory
*/
protected class SetTopRuleFactory extends AbstractObjectCreationFactory {
public Object createObject(Attributes attributes) {
String methodName = attributes.getValue("methodname");
String paramType = attributes.getValue("paramtype");
return (paramType == null || paramType.length() == 0) ?
new SetTopRule( methodName) :
new SetTopRule( methodName, paramType);
}
}
/**
* Factory for creating a SetNextRuleFactory
*/
protected class SetNextRuleFactory extends AbstractObjectCreationFactory {
public Object createObject(Attributes attributes) {
String methodName = attributes.getValue("methodname");
String paramType = attributes.getValue("paramtype");
return (paramType == null || paramType.length() == 0) ?
new SetNextRule( methodName) :
new SetNextRule( methodName, paramType);
}
}
/**
* Factory for creating a SetRootRuleFactory
*/
protected class SetRootRuleFactory extends AbstractObjectCreationFactory {
public Object createObject(Attributes attributes) {
String methodName = attributes.getValue("methodname");
String paramType = attributes.getValue("paramtype");
return (paramType == null || paramType.length() == 0) ?
new SetRootRule( methodName) :
new SetRootRule( methodName, paramType);
}
}
/**
* A rule for adding a attribute-property alias to the custom alias mappings of
* the containing SetPropertiesRule rule.
*/
protected class SetPropertiesAliasRule extends Rule {
/**
* <p>Base constructor.</p>
*/
public SetPropertiesAliasRule() {
super();
}
/**
* Add the alias to the SetPropertiesRule object created by the
* enclosing <set-properties-rule> tag.
*/
public void begin(Attributes attributes) {
String attrName = attributes.getValue("attr-name");
String propName = attributes.getValue("prop-name");
SetPropertiesRule rule = (SetPropertiesRule) digester.peek();
rule.addAlias(attrName, propName);
}
}
/**
* A rule for adding a attribute-property alias to the custom alias mappings of
* the containing SetNestedPropertiesRule rule.
*/
protected class SetNestedPropertiesAliasRule extends Rule {
/**
* <p>Base constructor.</p>
*/
public SetNestedPropertiesAliasRule() {
super();
}
/**
* Add the alias to the SetNestedPropertiesRule object created by the
* enclosing <set-nested-properties-rule> tag.
*/
public void begin(Attributes attributes) {
String attrName = attributes.getValue("attr-name");
String propName = attributes.getValue("prop-name");
SetNestedPropertiesRule rule = (SetNestedPropertiesRule) digester.peek();
rule.addAlias(attrName, propName);
}
}
}
The table below shows all metrics for DigesterRuleParser.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 87.00 | Number of blocks | |
| BLOCK_COMMENT | 17.00 | Number of block comment lines | |
| COMMENTS | 273.00 | Comment lines | |
| COMMENT_DENSITY | 0.74 | Comment density | |
| COMPARISONS | 45.00 | Number of comparison operators | |
| CYCLOMATIC | 89.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 57.00 | Comments in declarations | |
| DOC_COMMENT | 232.00 | Number of javadoc comment lines | |
| ELOC | 371.00 | Effective lines of code | |
| EXEC_COMMENTS | 16.00 | Comments in executable code | |
| EXITS | 63.00 | Procedure exits | |
| FUNCTIONS | 45.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 80.41 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 112.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 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 | 14.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 | 4.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 | 1.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 1.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 | 6.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 7.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 | 8.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 1.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 1.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 | 2.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 5.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 | 0.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 | 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 | 1.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 1.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 | 2.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 | 851.00 | Number of lines in the source file | |
| LINE_COMMENT | 24.00 | Number of line comments | |
| LOC | 463.00 | Lines of code | |
| LOGICAL_LINES | 239.00 | Number of statements | |
| LOOPS | 2.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 1186.00 | Number of operands | |
| OPERATORS | 2022.00 | Number of operators | |
| PARAMS | 39.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3208.00 | Halstead program length | |
| PROGRAM_VOCAB | 402.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 73.00 | Number of return points from functions | |
| SIZE | 33300.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 354.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 48.00 | Number of unique operators | |
| WHITESPACE | 115.00 | Number of whitespace lines | |