XDocletTagSupport.java
| Index Score | ||
|---|---|---|
 |
 |
xdoclet |
 |
|
XDoclet |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| SIZE | Size of the file in bytes |  |
| DOC_COMMENT | Number of javadoc comment lines | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| EXEC_COMMENTS | Comments in executable code | |
| COMMENTS | Comment lines | |
| CYCLOMATIC | Cyclomatic complexity | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| LINES | Number of lines in the source file | |
| RETURNS | Number of return points from functions | |
| EXITS | Procedure exits | |
| PARAMS | Number of formal parameter declarations | |
| BLOCKS | Number of blocks | |
| OPERATORS | Number of operators | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| LINE_COMMENT | Number of line comments | |
| PROGRAM_LENGTH | Halstead program length | |
| LOC | Lines of code | |
| COMPARISONS | Number of comparison operators | |
| OPERANDS | Number of operands | |
| JAVA0079 | JAVA0079 Use of instance to reference static member | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| UNIQUE_OPERANDS | Number of unique operands | |
| ELOC | Effective lines of code | |
| FUNCTIONS | Number of function declarations | |
| LOGICAL_LINES | Number of statements | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0138 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| NEST_DEPTH | Maximum nesting depth | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* Copyright (c) 2001, 2002 The XDoclet team
* All rights reserved.
*/
package xdoclet;
import java.util.Properties;
import java.util.StringTokenizer;
import org.apache.commons.logging.Log;
import xjavadoc.*;
import xdoclet.template.TemplateEngine;
import xdoclet.template.TemplateException;
import xdoclet.template.TemplateTagHandler;
import xdoclet.util.DocletUtil;
import xdoclet.util.LogUtil;
import xdoclet.util.Translator;
import xdoclet.util.TypeConversionUtil;
/**
* Derives from TemplateTagHandler and adds handy support methods for working with Javadoc Doclet classes.
*
* @author Dmitri Colebatch (dim@bigpond.net.au)
* @created October 12, 2001
* @version $Revision: 1.62 $
*/
public abstract class XDocletTagSupport extends TemplateTagHandler
{
public final static int FOR_CLASS = 0;
public final static int FOR_METHOD = 1;
public final static int FOR_FIELD = 2;
public final static int FOR_CONSTRUCTOR = 3;
/**
* Default delimiter used inside a xdoclet tag attribute.
*/
protected final static String PARAMETER_DELIMITER = ",";
/**
* @return The current tag.
*/
public static XTag getCurrentMethodTag()
{
return getDocletContext().getActiveSubTask().getCurrentMethodTag();
}
/**
* @return The current tag.
*/
public static XTag getCurrentClassTag()
{
return getDocletContext().getActiveSubTask().getCurrentClassTag();
}
/**
* @return The current tag.
*/
public static XTag getCurrentFieldTag()
{
return getDocletContext().getActiveSubTask().getCurrentFieldTag();
}
/**
* Provides the current method in the XDoclet build, or null if there is no current method.
*
* @return current method
* @see #setCurrentMethod
*/
public static XMethod getCurrentMethod()
{
return getDocletContext().getActiveSubTask().getCurrentMethod();
}
/**
* Provides the current field in the XDoclet build, or null if there is no current field.
*
* @return current field
* @see #setCurrentField
*/
public static XField getCurrentField()
{
return getDocletContext().getActiveSubTask().getCurrentField();
}
/**
* Provides the current constructor in the XDoclet build, or null if there is no current constructor.
*
* @return current constructor
* @see #setCurrentConstructor
*/
public static XConstructor getCurrentConstructor()
{
return getDocletContext().getActiveSubTask().getCurrentConstructor();
}
/**
* Provides the current class in the XDoclet build, or null if there is no current class.
*
* @return current class
* @see #pushCurrentClass
* @see #popCurrentClass
*/
public static XClass getCurrentClass()
{
return getDocletContext().getActiveSubTask().getCurrentClass();
}
/**
* Provides the current package in the XDoclet build, or null if there is no current package.
*
* @return current package
*/
public static XPackage getCurrentPackage()
{
return getDocletContext().getActiveSubTask().getCurrentPackage();
}
/**
* Set the current method.
*
* @param method The method to make the current method
* @see #getCurrentMethod
*/
public static void setCurrentMethod(XMethod method)
{
getDocletContext().getActiveSubTask().setCurrentMethod(method);
}
/**
* Set the current constructor.
*
* @param constructor The constructor to make the current constructor
* @see #getCurrentConstructor
*/
public static void setCurrentConstructor(XConstructor constructor)
{
getDocletContext().getActiveSubTask().setCurrentConstructor(constructor);
}
/**
* Sets current class to <code>clazz</code> by clearing <code>currentClassStack</code> stack and pushing <code>clazz</code>
* into top of it.
*
* @param clazz The class to make the current class
* @see #getCurrentClass()
*/
public static void setCurrentClass(XClass clazz)
{
getDocletContext().getActiveSubTask().setCurrentClass(clazz);
}
/**
* Set the current package.
*
* @param pakkage The package to make the current package
* @see #getCurrentPackage
*/
public static void setCurrentPackage(XPackage pakkage)
{
getDocletContext().getActiveSubTask().setCurrentPackage(pakkage);
}
/**
* Sets the current method tag.
*
* @param currentTag The tag to make the current method tag
*/
public static void setCurrentMethodTag(XTag currentTag)
{
getDocletContext().getActiveSubTask().setCurrentMethodTag(currentTag);
}
/**
* Sets the current class tag.
*
* @param currentTag The tag to make the current class tag
*/
public static void setCurrentClassTag(XTag currentTag)
{
getDocletContext().getActiveSubTask().setCurrentClassTag(currentTag);
}
/**
* Sets the current field tag.
*
* @param currentTag The tag to make the current field tag
*/
public static void setCurrentFieldTag(XTag currentTag)
{
getDocletContext().getActiveSubTask().setCurrentFieldTag(currentTag);
}
/**
* Set the current field.
*
* @param field The field to make the current field
* @see #getCurrentField
*/
public static void setCurrentField(XField field)
{
getDocletContext().getActiveSubTask().setCurrentField(field);
}
/**
* Push the specified class to the top of the current class stack making it effectively the current class.
*
* @param clazz The class to push onto the top of the class stack.
* @return The class on the top of the stack.
* @see #getCurrentClass
* @see #popCurrentClass
*/
public static XClass pushCurrentClass(XClass clazz)
{
return getDocletContext().getActiveSubTask().pushCurrentClass(clazz);
}
/**
* Pop the current class off the top of the class stack.
*
* @return The class popped off the top of the stack.
* @see #getCurrentClass
* @see #pushCurrentClass
*/
public static XClass popCurrentClass()
{
return getDocletContext().getActiveSubTask().popCurrentClass();
}
/**
* @return the context object casted to DocletContext
*/
protected static DocletContext getDocletContext()
{
return DocletContext.getInstance();
}
/**
* The <code>getExpandedDelimitedTagValue</code> method returns a delimited version with class names expanded if
* requested of the tag value.
*
* @param attributes a <code>Properties</code> value
* @param forType an <code>int</code> value
* @return a <code>String</code> value
* @exception XDocletException if an error occurs
*/
protected static String getExpandedDelimitedTagValue(Properties attributes, int forType) throws XDocletException
{
String tagValue = getTagValue(attributes, forType);
tagValue = delimit(tagValue, attributes);
tagValue = expandClassName(tagValue, attributes);
return tagValue;
}
/**
* Return the Value of a tag specified in a Properties object. This method work on the currentTag object variable,
* matchs it against the XTag specified in the attributes Properties and returns the value of the specified tag.
*
* @param attributes The attributes of the template tag
* @param forType if FOR_CLASS, then a fifth property superclasses is searched, if this is set to
* true, then the tag is also searched in all superclasses of current class. If forType is set to FOR_METHOD or
* FOR_CONSTRUCTOR or FOR_FIELD, current method or field is searched for the tag.
* @return The TagValue value
* @exception XDocletException Description of Exception
*/
protected static String getTagValue(Properties attributes, int forType) throws XDocletException
{
String tagName = attributes.getProperty("tagName");
String paramName = attributes.getProperty("paramName");
String validValues = attributes.getProperty("values");
String defaultValue = attributes.getProperty("default");
String paramNum = attributes.getProperty("paramNum");
boolean superclasses = TypeConversionUtil.stringToBoolean(attributes.getProperty("superclasses"), true);
boolean mandatory = TypeConversionUtil.stringToBoolean(attributes.getProperty("mandatory"), false);
/*
* Handles multiple tags/parameters. Multiple tags/parameter are specified
* as alternatives, and are meant to be used as a "backward compatibility"
* helper. So, if the template has <hasTag tagName="tag1,tag2"
* paramName="param1,param2">, xDoclet will first look for param1 in tag1.
* If it's not found, it will look for param2 in tag2 and so on, until
* it finds a valid tag/parameter.
*
* If tagName has more alternatives than paramName, it is assumed that the
* corresponding paramName is null. If paramNum is supplied (it also can have
* multiple alternatives), the tag value is checked.
* (This is mainly to support jboss:table-name and friends. Ugly hack!)
*/
StringTokenizer tagTokenizer = new StringTokenizer(tagName, ",");
StringTokenizer paramTokenizer = new StringTokenizer(paramName != null ? paramName : "", ",");
StringTokenizer paramNumTokenizer = new StringTokenizer(paramNum != null ? paramNum : "", ",");
// We can't have more parameters then tags
if (paramTokenizer.countTokens() > tagTokenizer.countTokens()) {
throw new XDocletException("paramName can't contain more alternatives than tagName");
}
// Loop until we get a non-null tag/parameter or there aren't any more alternatives
String tagValue = null;
while (tagTokenizer.hasMoreTokens() && tagValue == null) {
String currentTag = tagTokenizer.nextToken().trim();
String currentParam = null;
if (paramTokenizer.hasMoreTokens()) {
currentParam = paramTokenizer.nextToken().trim();
if ("".equals(currentParam)) {
currentParam = null;
}
}
// String currentTag = tagName;
// String currentParam = paramName;
// String
tagValue = getTagValue(
forType,
currentTag,
currentParam,
validValues,
defaultValue,
superclasses,
mandatory
);
// Case of jboss:table-name "abc"
if (tagValue == null && currentParam == null) {
String currentParamNumber = null;
if (paramNumTokenizer.hasMoreTokens()) {
currentParamNumber = paramNumTokenizer.nextToken().trim();
}
// String currentParamNumber = paramNum;
if (currentParamNumber != null) {
XProgramElement programElement = getProgramElement(forType);
XDoc doc = programElement.getDoc();
XTag tag = doc.getTag(currentTag, superclasses);
if (tag != null) {
tagValue = tag.getValue();
}
if (tagValue != null && tagValue.trim().length() == 0) {
tagValue = null;
}
}
}
// end of hack
if (tagValue != null && tagValue.startsWith("\"")) {
tagValue = tagValue.substring(1, tagValue.length() - 1);
}
}
// tagValue = delimit( tagValue, attributes );
return tagValue;
}
/**
* Gets the TagValue attribute of the XDocletTagSupport class
*
* @param forType Describe what the parameter does
* @param tagName Describe what the parameter does
* @param paramName Describe what the parameter does
* @param validValues Describe what the parameter does
* @param defaultValue Describe what the parameter does
* @param superclasses Describe what the parameter does
* @param mandatory Describe what the parameter does
* @return The TagValue value
* @exception XDocletException Describe the exception
*/
protected static String getTagValue(
int forType,
String tagName,
String paramName,
String validValues,
String defaultValue,
boolean superclasses,
boolean mandatory
) throws XDocletException
{
XProgramElement programElement = getProgramElement(forType);
if (programElement == null) {
return null;
}
XDoc doc = programElement.getDoc();
return getTagValue(
forType,
doc,
tagName,
paramName,
validValues,
defaultValue,
superclasses,
mandatory
);
}
/**
* @param doc Describe what the parameter does
* @param tagName Describe what the parameter does
* @param paramName Describe what the parameter does
* @param validValues Describe what the parameter does
* @param defaultValue Describe what the parameter does
* @param superclasses Describe what the parameter does
* @param mandatory Describe what the parameter does
* @param forType
* @return The TagValue value
* @exception XDocletException Describe the exception
* @todo (Aslak) maybe this method ought to be moved to xjavadoc.XDoc? Not a big deal though.
*/
protected static String getTagValue(
int forType,
XDoc doc,
String tagName,
String paramName,
String validValues,
String defaultValue,
boolean superclasses,
boolean mandatory) throws XDocletException
{
XTag tag = null;
// first try to get current tag
if (forType == FOR_METHOD || forType == FOR_CONSTRUCTOR)
tag = getCurrentMethodTag();
else if (forType == FOR_CLASS)
tag = getCurrentClassTag();
else if (forType == FOR_FIELD)
tag = getCurrentFieldTag();
boolean noCurrentTag = tag == null;
if (tag != null && !tag.getName().equals(XDoc.dotted(tagName)))
tag = null;
if (tag == null) {
// if there is no current tag, look in the doc
tag = doc.getTag(tagName, superclasses);
}
String value = null;
// check if we have a tag at all
if (tag != null) {
if (paramName == null) {
// the value of the tag is requested
value = tag.getValue();
}
else {
value = tag.getAttributeValue(paramName);
}
}
// if there was no current tag, no value yet, and we are looking for a parameter, we must search
// all super class class tags in case THEY define the parameter we are looking for
//
if (noCurrentTag && value == null && paramName != null && superclasses) {
value = doc.getTagAttributeValue(tagName, paramName, superclasses);
}
if (value == null) {
// nothing found in javadocs
if (mandatory) {
// throws XDocletException
mandatoryParamNotFound(doc, paramName, tagName);
}
if (defaultValue != null) {
return defaultValue;
}
else {
return null;
}
}
else {
// a value was found. perform sanity checks on valid values
if (validValues != null) {
// check if the value is among the valid values
StringTokenizer st = new StringTokenizer(validValues, ",");
while (st.hasMoreTokens()) {
if (st.nextToken().equals(value)) {
return value;
}
}
invalidParamValueFound(doc, paramName, tagName, value, validValues);
}
}
return value;
}
/**
* A utility method used by ifMethodTagValueEquals/ifMethodTagValueNotEquals and
* ifClassTagValueEquals/ifClassTagValueNotEquals, return true if the value of the tag/XParameter equals with value.
*
* @param attributes The attributes of the template tag
* @param forType Describe what the parameter does
* @return Description of the Returned Value
* @exception XDocletException Description of Exception
*/
protected static boolean isTagValueEqual(Properties attributes, int forType) throws XDocletException
{
// the value to check for
String value = attributes.getProperty("value");
if (value == null) {
throw new XDocletException("The value property is not specified");
}
String attributeValue = null;
// if currentTag is set first check against it, this is needed for forAll... tags
// where currentTag is set by these tags and we don't need/want to delegate the
// lookup to the surrounding current class or method.
String tagName = attributes.getProperty("tagName");
String paramName = attributes.getProperty("paramName");
XTag currentTag = null;
if (forType == FOR_METHOD || forType == FOR_CONSTRUCTOR)
currentTag = getCurrentMethodTag();
else if (forType == FOR_CLASS)
currentTag = getCurrentClassTag();
else if (forType == FOR_FIELD)
currentTag = getCurrentFieldTag();
if (currentTag != null && currentTag.getName().equals(XDoc.dotted(tagName))) {
attributeValue = currentTag.getAttributeValue(paramName);
}
else {
attributeValue = getTagValue(attributes, forType);
}
attributeValue = delimit(attributeValue, attributes);
return value.equals(attributeValue);
}
protected static String expandClassName(String value, Properties attributes)
{
boolean expand = TypeConversionUtil.stringToBoolean(attributes.getProperty("expandClassName"), false);
if (expand) {
value = getCurrentClass().qualify(value).getQualifiedName();
}
// end of if ()
return value;
}
/**
* Throws an XDocletException exception to stop the build process. The exception has an informative message to help
* user find out the cause of the error (not specifying a mandatory parameter for a tag).
*
* @param paramName tag parameter name
* @param tagName tag name
* @param doc member javadoc reference
* @exception XDocletException Description of Exception
*/
protected static void mandatoryParamNotFound(XDoc doc, String paramName, String tagName) throws XDocletException
{
XProgramElement programElement = doc.getOwner();
if (programElement instanceof XMethod) {
XMethod method = (XMethod) programElement;
throw new XDocletException(Translator.getString(XDocletMessages.class, XDocletMessages.MANDATORY_TAG_PARAM_MISSING_METHOD,
new String[]{paramName, tagName, method.getName(), method.getContainingClass().getQualifiedName()}));
}
else if (programElement instanceof XClass) {
XClass clazz = (XClass) programElement;
throw new XDocletException(Translator.getString(XDocletMessages.class, XDocletMessages.MANDATORY_TAG_PARAM_MISSING_CLASS,
new String[]{paramName, tagName, clazz.getQualifiedName()}));
}
else if (programElement instanceof XConstructor) {
XConstructor constructor = (XConstructor) programElement;
throw new XDocletException(Translator.getString(XDocletMessages.class, XDocletMessages.MANDATORY_TAG_PARAM_MISSING_CONSTRUCTOR,
new String[]{paramName, tagName, constructor.getContainingClass().getQualifiedName()}));
}
else if (programElement instanceof XField) {
XField field = (XField) programElement;
throw new XDocletException(Translator.getString(XDocletMessages.class, XDocletMessages.MANDATORY_TAG_PARAM_MISSING_FIELD,
new String[]{paramName, tagName, field.getName(), field.getContainingClass().getQualifiedName()}));
}
else {
throw new XDocletException(Translator.getString(XDocletMessages.class, XDocletMessages.BAD_PRGELEMDOC_TYPE,
new String[]{programElement.toString()}));
}
}
/**
* A utility method used by ifHasClassTag/ifDoesntHaveClassTag and ifHasMethodTag/ifDoesntHaveMethodTag, return true
* if at least one tag exists with the specified name.
*
* @param attributes The attributes of the template tag
* @param forType
* @return <code>true</code> if matching tag found
* @exception XDocletException Description of Exception
*/
protected static boolean hasTag(Properties attributes, int forType) throws XDocletException
{
return getTagValue(attributes, forType) != null;
}
/**
* @param attributeValue Describe what the parameter does
* @param attributes Describe what the parameter does
* @return Describe the return value
* @todo fix the () equals test, it is not nice. Test : finder Home definition on AccountBean
*/
protected static String delimit(String attributeValue, Properties attributes)
{
// Optional Parameter
String delim = attributes.getProperty("delimiter");
String tokenNumberStr = attributes.getProperty("tokenNumber");
int tokenNumber = 0;
if (tokenNumberStr != null) {
tokenNumber = Integer.parseInt(tokenNumberStr);
}
if (delim != null) {
if (delim.equals("()") && attributeValue.indexOf(delim) != -1) {
attributeValue = null;
}
else {
StringTokenizer st = new StringTokenizer(attributeValue, delim);
String tok = null;
for (int i = 0; i <= tokenNumber; i++) {
if (st.hasMoreTokens()) {
tok = st.nextToken();
}
else {
tok = null;
}
}
attributeValue = tok;
}
}
return attributeValue;
}
/**
* Gets the current program element of the specified type.
*
* @param forType FOR_XXX type constant
* @return program element javadoc
* @exception XDocletException Describe the exception
*/
private static XProgramElement getProgramElement(int forType) throws XDocletException
{
XProgramElement programElement = null;
switch (forType) {
case FOR_CLASS:
programElement = getCurrentClass();
break;
case FOR_METHOD:
programElement = getCurrentMethod();
break;
case FOR_CONSTRUCTOR:
programElement = getCurrentConstructor();
break;
case FOR_FIELD:
programElement = getCurrentField();
break;
default:
throw new XDocletException(Translator.getString(XDocletMessages.class, XDocletMessages.BAD_TAGVALUE_TYPE));
}
return programElement;
}
/**
* Throws an XDocletException exception to stop the build process. The exception has an informative message to help
* user find out the cause of the error (specifying an incorrect value for a parameter of a tag).
*
* @param paramName tag parameter name
* @param tagName tag name
* @param value invalid parameter value
* @param validValues valid parameter values
* @param doc program element javadoc
* @exception XDocletException Description of Exception
*/
private static void invalidParamValueFound(XDoc doc, String paramName, String tagName, String value, String validValues) throws XDocletException
{
XProgramElement programElement = doc.getOwner();
if (programElement instanceof XMethod) {
XMethod method = (XMethod) programElement;
throw new XDocletException(Translator.getString(XDocletMessages.class, XDocletMessages.INVALID_TAG_PARAM_VALUE_METHOD,
new String[]{value, paramName, tagName, method.getName(), method.getContainingClass().getQualifiedName(), validValues}));
}
else if (programElement instanceof XClass) {
XClass clazz = (XClass) programElement;
throw new XDocletException(Translator.getString(XDocletMessages.class, XDocletMessages.INVALID_TAG_PARAM_VALUE_CLASS,
new String[]{value, paramName, tagName, clazz.getQualifiedName(), validValues}));
}
else if (programElement instanceof XConstructor) {
XConstructor constructor = (XConstructor) programElement;
throw new XDocletException(Translator.getString(XDocletMessages.class, XDocletMessages.INVALID_TAG_PARAM_VALUE_CONSTRUCTOR,
new String[]{value, paramName, tagName, constructor.getContainingClass().getQualifiedName(), validValues}));
}
else if (programElement instanceof XField) {
XField field = (XField) programElement;
throw new XDocletException(Translator.getString(XDocletMessages.class, XDocletMessages.INVALID_TAG_PARAM_VALUE_FIELD,
new String[]{value, paramName, tagName, field.getName(), field.getContainingClass().getQualifiedName(), validValues}));
}
else {
throw new XDocletException(Translator.getString(XDocletMessages.class, XDocletMessages.INVALID_TAG_PARAM_VALUE_METHOD,
new String[]{programElement.toString()}));
}
}
/**
* Gets the Engine attribute of the TemplateTagHandler object.
*
* @return The Engine value
*/
public TemplateEngine getEngine()
{
return ((TemplateSubTask) getDocletContext().getActiveSubTask()).getEngine();
}
/**
* @param template
* @exception XDocletException
* @todo throw TemplateException instead
*/
public void generate(String template) throws XDocletException
{
try {
getEngine().generate(template);
}
catch (TemplateException e) {
if (e instanceof XDocletException) {
throw (XDocletException) e;
}
else {
throw new XDocletException(e, Translator.getString(XDocletMessages.class, XDocletMessages.RUNNING_FAILED) + ": " + e.toString());
}
}
}
/**
* Return the modifiers (static, private, etc.) for the current program element of the specified type.
*
* @param forType FOR_XXX type constant
* @return modifiers
* @exception XDocletException Describe the exception
*/
protected String modifiers(int forType) throws XDocletException
{
return getProgramElement(forType).getModifiers();
}
/**
* Throws an XDocletException exception to stop the build process. The exception has an informative message to help
* user find out the cause of the error (omitting a mandatory parameter on a tag).
*
* @param templateTagName tag name
* @param paramName tag parameter name
* @exception XDocletException
*/
protected void mandatoryTemplateTagParamNotFound(String templateTagName, String paramName) throws XDocletException
{
throw new XDocletException(Translator.getString(XDocletMessages.class, XDocletMessages.MANDATORY_TAG_PARAM_MISSING_TEMPLATE,
new String[]{paramName, templateTagName}));
}
/**
* Tests whether the passed class has the tag which is specfied in the <code>havingClassTag</code> attribute of the
* current subtask.
*
* @param clazz the Class to check
* @return <code>true</code> if the current subtask has no <code>havingClassTag</code> or the passed class has
* a tag with the same name as the <code>havingClassTag</code> attribute of the current subtask, otherwise
* <code>false</code>
*/
protected boolean hasHavingClassTag(XClass clazz)
{
Log log = LogUtil.getLog(getClass(), "hasHavingClassTag");
DocletContext ctx = getDocletContext();
SubTask task = ctx.getActiveSubTask();
if (!(task instanceof TemplateSubTask)) {
return true;
}
TemplateSubTask templTask = (TemplateSubTask) task;
String[] havingClassTags = templTask.getHavingClassTags();
if (havingClassTags == null || havingClassTags.length < 1) {
return true;
}
boolean foundClassTag = false;
XDoc xdoc = clazz.getDoc();
for (int i = 0; i < havingClassTags.length; i++) {
if (xdoc.hasTag(havingClassTags[i])) {
foundClassTag = true;
break;
}
}
if (!foundClassTag) {
if (log.isDebugEnabled()) {
log.debug("Reject class '" + clazz.getQualifiedName() + "' because it doesn't have one of the required class tags '" + DocletUtil.arrayToDelimitedString(havingClassTags, ", ") + "'.");
}
return false;
}
else {
if (log.isDebugEnabled()) {
log.debug("Accept class '" + clazz.getQualifiedName() + "' because it has one of the required class tags '" + DocletUtil.arrayToDelimitedString(havingClassTags, ", ") + "'.");
}
return true;
}
}
}
The table below shows all metrics for XDocletTagSupport.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 92.00 | Number of blocks | |
| BLOCK_COMMENT | 17.00 | Number of block comment lines | |
| COMMENTS | 287.00 | Comment lines | |
| COMMENT_DENSITY | 0.90 | Comment density | |
| COMPARISONS | 61.00 | Number of comparison operators | |
| CYCLOMATIC | 108.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 37.00 | Comments in declarations | |
| DOC_COMMENT | 244.00 | Number of javadoc comment lines | |
| ELOC | 318.00 | Effective lines of code | |
| EXEC_COMMENTS | 23.00 | Comments in executable code | |
| EXITS | 75.00 | Procedure exits | |
| FUNCTIONS | 35.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 92.84 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 116.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 1.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 1.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 | 7.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 | 5.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 | 6.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 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 4.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 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 2.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 | 11.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 9.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 | 1.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 833.00 | Number of lines in the source file | |
| LINE_COMMENT | 26.00 | Number of line comments | |
| LOC | 448.00 | Lines of code | |
| LOGICAL_LINES | 172.00 | Number of statements | |
| LOOPS | 4.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 952.00 | Number of operands | |
| OPERATORS | 1920.00 | Number of operators | |
| PARAMS | 50.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2872.00 | Halstead program length | |
| PROGRAM_VOCAB | 337.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 66.00 | Number of return points from functions | |
| SIZE | 30947.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 282.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 55.00 | Number of unique operators | |
| WHITESPACE | 98.00 | Number of whitespace lines | |