AbstractProgramElementTagsHandler.java
| Index Score | ||
|---|---|---|
 |
 |
xdoclet.tagshandler |
 |
 |
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 |  |
| LOOPS | Number of loops | |
| CYCLOMATIC | Cyclomatic complexity | |
| DOC_COMMENT | Number of javadoc comment lines | |
| EXITS | Procedure exits | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| LINES | Number of lines in the source file | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| PARAMS | Number of formal parameter declarations | |
| OPERATORS | Number of operators | |
| COMPARISONS | Number of comparison operators | |
| LOGICAL_LINES | Number of statements | |
| JAVA0160 | JAVA0160 Method does not throw specified exception | |
| LOC | Lines of code | |
| COMMENTS | Comment lines | |
| RETURNS | Number of return points from functions | |
| PROGRAM_LENGTH | Halstead program length | |
| BLOCKS | Number of blocks | |
| ELOC | Effective lines of code | |
| JAVA0081 | JAVA0081 Boolean literal in comparison | |
| UNIQUE_OPERANDS | Number of unique operands | |
| OPERANDS | Number of operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0125 | JAVA0125 Continue statement with label | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| NEST_DEPTH | Maximum nesting depth | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0159 | JAVA0159 Inefficient conversion of string to integer | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| EXEC_COMMENTS | Comments in executable code | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0171 | JAVA0171 Unused local variable | |
| FUNCTIONS | Number of function declarations | |
| 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 | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
* Copyright (c) 2001, 2002 The XDoclet team
* All rights reserved.
*/
package xdoclet.tagshandler;
import java.util.*;
import org.apache.commons.logging.Log;
import xjavadoc.*;
import xdoclet.DocletContext;
import xdoclet.SubTask;
import xdoclet.XDocletException;
import xdoclet.XDocletTagSupport;
import xdoclet.template.PrettyPrintWriter;
import xdoclet.util.LogUtil;
import xdoclet.util.Translator;
import xdoclet.util.TypeConversionUtil;
/**
* @author Ara Abrahamian (ara_e@email.com)
* @created Oct 15, 2001
* @version $Revision: 1.18 $
*/
public abstract class AbstractProgramElementTagsHandler extends XDocletTagSupport
{
/**
* The current token. Currently forAllParameterTypes and forAllClassTagTokens set it and currentToken returns the
* value. Tokens are computed for cases where the value should be tokenized by a set of delimiters.
*/
protected static String currentToken;
/**
* The StringTokenizer object doing the tokenization. It should be shared by different tag implementations, that's
* why its defined class-level.
*/
protected static StringTokenizer tagTokenizer;
/**
* Template can use matchPattern as a place where it can put volatile variable. You can set the value somewhere in
* the template and later use the value.
*/
protected static String matchPattern;
/**
* Template can use variable as a place where it can put some value. The variable is available inside the body of
* the {@link #setVariable(String, Properties)} tag.
*/
protected static String variable;
/**
* Returns the not-full-qualified name of the specified class without the package name.
*
* @param clazz class
* @return classname
*/
public static String getClassNameFor(XClass clazz)
{
return clazz.getName();
}
/**
* Returns the full-qualified name of the current class with the package name.
*
* @param clazz class
* @return fully qualified classname
*/
public static String getFullClassNameFor(XClass clazz)
{
return clazz.getQualifiedName();
}
/**
* Returns the full-qualified name of the superclass of the specified class.
*
* @param clazz class
* @return superclass' fully qualified classname
*/
public static String getFullSuperclassNameFor(XClass clazz)
{
if (clazz.getSuperclass() != null) {
return clazz.getSuperclass().getQualifiedName();
}
else {
return "java.lang.Object";
}
}
/**
* Utility method to get classes for iteration used by various methods. The result depends on the context: are we
* within a forAllPackages iteration or not.
*
* @return An array with all classes in that context in it.
*/
public static Collection getAllClasses()
{
if (DocletContext.getInstance().getActiveSubTask().getCurrentPackage() == null) {
// not in a forAllPackages context
return getXJavaDoc().getSourceClasses();
}
else {
return DocletContext.getInstance().getActiveSubTask().getCurrentPackage().getClasses();
}
}
/**
* @param clazz
* @param executableMemberName
* @param parameters
* @param setCurrentExecutableMember
* @param forType
* @return
* @exception XDocletException
* @todo Remove. For archeologists only
*/
protected static boolean hasExecutableMember_OLD(XClass clazz, String executableMemberName, String[] parameters, boolean setCurrentExecutableMember, int forType)
throws XDocletException
{
Log log = LogUtil.getLog(AbstractProgramElementTagsHandler.class, "hasExecutableMember");
while (clazz != null) {
Collection executableMembers = null;
switch (forType) {
case FOR_CONSTRUCTOR:
executableMembers = clazz.getConstructors();
break;
case FOR_METHOD:
executableMembers = clazz.getMethods();
break;
default:
throw new XDocletException("Bad type: " + forType);
}
int j = 0;
loop :
for (Iterator m = executableMembers.iterator(); m.hasNext(); ) {
XExecutableMember executableMember = (XExecutableMember) m.next();
if (executableMember.getName().equals(executableMemberName)) {
// All parameters must be equal too
if (parameters != null) {
Collection params = executableMember.getParameters();
log.debug("params.length=" + params.size());
for (Iterator p = params.iterator(); p.hasNext(); ) {
XParameter param = (XParameter) p.next();
String paramType = new StringBuffer(param.getType().getQualifiedName()).append(param.getDimensionAsString()).toString();
if (log.isDebugEnabled()) {
log.debug("params[j]=" + paramType);
log.debug("parameters[j]=" + parameters[j]);
}
if (paramType.equals(parameters[j++])) {
continue loop;
}
}
}
// The class has the given executable member
if (setCurrentExecutableMember) {
switch (forType) {
case FOR_CONSTRUCTOR:
setCurrentConstructor((XConstructor) executableMember);
break;
case FOR_METHOD:
setCurrentMethod((XMethod) executableMember);
break;
default:
throw new XDocletException("Bad type: " + forType);
}
}
return true;
}
}
// Check super class info
clazz = clazz.getSuperclass();
}
return false;
}
/**
* Used to protect returned arrays from being modified (sorted, reordered for example).
*
* @param objects array of objects
* @return copy of array
*/
protected static Object[] makeCopyOfArray(Object[] objects)
{
Object[] objects_copy = (Object[]) java.lang.reflect.Array.newInstance(objects.getClass().getComponentType(), objects.length);
System.arraycopy(objects, 0, objects_copy, 0, objects.length);
return objects_copy;
}
protected static boolean hasExecutableMember(XClass clazz, String executableMemberName, String[] parameters, boolean setCurrentExecutableMember, int forType)
throws XDocletException
{
Log log = LogUtil.getLog(AbstractProgramElementTagsHandler.class, "hasExecutableMember");
StringBuffer executableMemberNameWithSignature = new StringBuffer(executableMemberName).append("(");
boolean comma = false;
if (parameters != null) {
for (int i = 0; i < parameters.length; i++) {
if (comma) {
executableMemberNameWithSignature.append(',');
}
executableMemberNameWithSignature.append(getXJavaDoc().getXClass(parameters[i]).getQualifiedName());
}
}
executableMemberNameWithSignature.append(')');
XExecutableMember executableMember = null;
switch (forType) {
case FOR_CONSTRUCTOR:
executableMember = clazz.getConstructor(executableMemberNameWithSignature.toString());
break;
case FOR_METHOD:
executableMember = clazz.getMethod(executableMemberNameWithSignature.toString(), true);
break;
default:
throw new XDocletException("Bad type: " + forType);
}
if (setCurrentExecutableMember && executableMember != null) {
switch (forType) {
case FOR_CONSTRUCTOR:
setCurrentConstructor((XConstructor) executableMember);
break;
case FOR_METHOD:
setCurrentMethod((XMethod) executableMember);
break;
default:
throw new XDocletException("Bad type: " + forType);
}
}
return executableMember != null;
}
/**
* Sets the value of match variable.
*
* @param template The body of the block tag
* @param attributes The attributes of the template tag
* @exception XDocletException Description of Exception
* @doc.tag type="block"
* @doc.param name="value" optional="false" description="The new value for matchPattern."
*/
public void setMatchValue(String template, Properties attributes) throws XDocletException
{
matchPattern = attributes.getProperty("value");
generate(template);
matchPattern = null;
}
/**
* Sets the value of variable to some value. The value is available inside the body of this tag
*
* @param template The body of the block tag
* @param attributes The attributes of the template tag
* @exception XDocletException Description of Exception
* @doc.tag type="block"
* @doc.param name="value" optional="false" description="The new value for variable."
*/
public void setVariable(String template, Properties attributes) throws XDocletException
{
variable = attributes.getProperty("value");
generate(template);
variable = null;
}
/**
* Returns the value of match variable. Match variable serves as a variable for templates, you set it somewhere in
* template and look it up somewhere else in template.
*
* @return Description of the Returned Value
* @exception XDocletException Description of Exception
* @doc.tag type="content"
*/
public String matchValue() throws XDocletException
{
return matchPattern;
}
/**
* Returns the value of variable. Variable serves as a variable for templates, you set it somewhere in template
* (using {@link #setVariable(String, Properties)}) and look it up somewhere else in template.
*
* @return value of variable
* @exception XDocletException Description of Exception
* @doc.tag type="content"
*/
public String variable() throws XDocletException
{
return variable;
}
/**
* Returns current token inside forAllClassTagTokens.
*
* @param attributes The attributes of the template tag
* @return value of currently processed token
* @exception XDocletException Description of Exception
* @doc.tag type="content"
*/
public String currentToken(Properties attributes) throws XDocletException
{
Log log = LogUtil.getLog(SubTask.class, "currentToken");
log.debug("current token: " + currentToken);
if (currentToken == null) {
log.error("null token found");
return "";
}
else {
return currentToken;
}
}
/**
* Skips current token. Returns empty string.
*
* @param attributes The attributes of the template tag
* @return Empty string
* @exception XDocletException Description of Exception
* @doc.tag type="content"
*/
public String skipToken(Properties attributes) throws XDocletException
{
if (tagTokenizer.hasMoreTokens()) {
tagTokenizer.nextToken();
}
return "";
}
/**
* Gets the XExecutableMemberForMemberName attribute of the AbstractProgramElementTagsHandler object
*
* @param memberName Describe what the parameter does
* @param forType Describe what the parameter does
* @return The XExecutableMemberForMemberName value
* @exception XDocletException Describe the exception
*/
protected XExecutableMember getXExecutableMemberForMemberName(String memberName, int forType) throws XDocletException
{
if (memberName != null) {
return extractXExecutableMember(getCurrentClass(), memberName, forType);
}
return null;
}
/**
* Searches for the XExecutableMember of the member with name methodName and returns it.
*
* @param superclasses Search superclasses.
* @param memberName
* @param forType
* @return The XMethod for the method named value
* @exception XDocletException
*/
protected XExecutableMember getXExecutableMemberForMemberName(String memberName, boolean superclasses, int forType) throws XDocletException
{
if (!superclasses) {
return getXExecutableMemberForMemberName(memberName, forType);
}
for (XClass clazz = getCurrentClass(); clazz != null; clazz = clazz.getSuperclass()) {
XExecutableMember member = extractXExecutableMember(clazz, memberName, forType);
if (member != null) {
return member;
}
}
return null;
}
/**
* A utility method to get the blank space characters used for indenting comments. The number of spaces is read from
* the <code>indent</code> tag attribute. Defaults to zero spaces if no <code>indent</code> attribute is present.
*
* @param attributes The attributes of the template tag
* @return Array of <code>indent</code> space characters
* @see #memberComment(java.util.Properties, int)
* @see ClassTagsHandler#classComment(java.util.Properties)
* @see ClassTagsHandler#classCommentText(java.util.Properties)
* @see ClassTagsHandler#classCommentTags(java.util.Properties)
*/
protected char[] getIndentChars(Properties attributes)
{
String indentStr = attributes.getProperty("indent");
if (indentStr == null) {
return new char[0];
}
int indent = new Integer(indentStr).intValue();
char[] spaces = new char[indent];
Arrays.fill(spaces, ' ');
return spaces;
}
/**
* Return the throws clause of the specified constructor or method declaration. If no constructor/method is
* specified, the current one is used.
*
* @param attributes The attributes of the template tag
* @param forType Constant indicating constructor or method
* @return throws clause
* @exception XDocletException Describe the exception
* @see MethodTagsHandler#exceptionList(java.util.Properties)
* @see ConstructorTagsHandler#exceptionList(java.util.Properties)
*/
protected String exceptionList(Properties attributes, int forType) throws XDocletException
{
String skipExceptions = attributes.getProperty("skip");
String appendExceptions = attributes.getProperty("append");
String memberName = null;
Collection exceptions = null;
XExecutableMember executableMember = null;
switch (forType) {
case FOR_CONSTRUCTOR:
executableMember = getCurrentConstructor();
memberName = attributes.getProperty("constructor");
break;
case FOR_METHOD:
executableMember = getCurrentMethod();
memberName = attributes.getProperty("method");
break;
default:
throw new XDocletException("Can't exceptionList for type " + forType);
}
if (executableMember == null && memberName == null) {
exceptions = new ArrayList();
}
if (memberName == null) {
exceptions = executableMember.getThrownExceptions();
}
else {
executableMember = getXExecutableMemberForMemberName(memberName, true, forType);
// no member with the specified name found in class
if (executableMember != null) {
exceptions = executableMember.getThrownExceptions();
}
else {
exceptions = new ArrayList();
}
}
StringBuffer sbuf = new StringBuffer();
String type = null;
for (Iterator i = exceptions.iterator(); i.hasNext(); ) {
type = ((XClass) i.next()).getQualifiedName();
if (isInSkipExceptionsList(skipExceptions, type) == false &&
isInAppendExceptionsList(appendExceptions, type) == false) {
appendException(sbuf, type);
}
}
// append all exceptions specified to be always appended by default
if (appendExceptions != null) {
appendException(sbuf, appendExceptions);
}
return sbuf.toString();
}
/**
* Describe what the method does
*
* @param template The body of the block tag
* @param attributes The attributes of the template tag
* @param for_type Describe what the parameter does
* @exception XDocletException Describe the exception
*/
protected void forAllMemberTagTokens(String template, Properties attributes, int for_type) throws XDocletException
{
Log log = LogUtil.getLog(MethodTagsHandler.class, "forAllMemberTagTokens");
String tagValue;
tagValue = getTagValue(attributes, for_type);
String delimiter = attributes.getProperty("delimiter");
String skipStr = attributes.getProperty("skip");
int skip;
try {
skip = Integer.valueOf(skipStr).intValue();
}
catch (Throwable t) {
skip = 0;
}
if (delimiter == null) {
log.debug("got null delimiter - forAllMemberTagTokens");
delimiter = PARAMETER_DELIMITER;
}
log.debug("Tag Value = " + tagValue);
tagTokenizer = new StringTokenizer(tagValue, delimiter, false);
currentToken = "";
matchPattern = null;
for (int i = 0; tagTokenizer.hasMoreTokens() && i < skip; i++) {
tagTokenizer.nextToken();
}
while (tagTokenizer.hasMoreTokens()) {
currentToken = tagTokenizer.nextToken();
log.debug("generate current token: " + currentToken);
generate(template);
}
currentToken = null;
tagTokenizer = null;
matchPattern = null;
}
/**
* Describe what the method does
*
* @param template The body of the block tag
* @param attributes The attributes of the template tag
* @param forType Describe what the parameter does
* @param resourceKey Describe what the parameter does
* @param arguments Describe what the parameter does
* @exception XDocletException Describe the exception
*/
protected void forAllMemberTags(String template, Properties attributes, int forType, String resourceKey, String[] arguments) throws XDocletException
{
Log log = LogUtil.getLog(AbstractProgramElementTagsHandler.class, "forAllMemberTags");
boolean superclasses = TypeConversionUtil.stringToBoolean(attributes.getProperty("superclasses"), true);
XMember member = null;
switch (forType) {
case FOR_FIELD:
member = getCurrentField();
break;
case FOR_CONSTRUCTOR:
member = getCurrentConstructor();
break;
case FOR_METHOD:
member = getCurrentMethod();
break;
default:
throw new XDocletException("Bad type " + forType);
}
if (member == null) {
throw new XDocletException(Translator.getString(XDocletTagshandlerMessages.class, resourceKey, arguments));
}
/*
* If the tagName contains a "|" it's to support deprecated tags.
* If we find an occurrance for the first tag, we won't loop over the second one.
*/
StringTokenizer st = new StringTokenizer(attributes.getProperty("tagName"), "|");
boolean found = false;
while (st.hasMoreTokens() && !found) {
String tagName = st.nextToken();
Collection tags = member.getDoc().getTags(tagName, superclasses);
for (Iterator i = tags.iterator(); i.hasNext(); ) {
found = true;
XTag tag = (XTag) i.next();
if (forType == FOR_METHOD || forType == FOR_CONSTRUCTOR) {
setCurrentMethodTag(tag);
}
else {
setCurrentFieldTag(tag);
}
String m = getTagValue(attributes, forType);
if (log.isDebugEnabled()) {
log.debug((getCurrentMethod() == null) ? "<no current method>" : getCurrentMethod().getName() + " ** Tag/Param = "
+ attributes.getProperty("tagName") + '/' + attributes.getProperty("paramName")
+ " ** Value = " + m
+ " MatchPattern = " + matchPattern);
}
if (matchPattern == null) {
generate(template);
}
else if (matchPattern != null && (matchPattern.equals(m) || m.equals("*"))) {
generate(template);
}
}
if (forType == FOR_METHOD || forType == FOR_CONSTRUCTOR) {
setCurrentMethodTag(null);
}
else {
setCurrentFieldTag(null);
}
}
}
/**
* The comment for the current class member of the specified type (field, constructor or method).
*
* @param attributes The attributes of the template tag
* @param forType Member type
* @return javadoc comment
* @exception XDocletException Describe the exception
* @todo There is similar functionality in xjavadoc.XDoc. Use that instead (needs a little
* rework to be more flexible).
* @see MethodTagsHandler#methodComment(java.util.Properties)
* @see FieldTagsHandler#fieldComment(java.util.Properties)
* @see ConstructorTagsHandler#constructorComment(java.util.Properties)
*/
protected String memberComment(Properties attributes, int forType) throws XDocletException
{
String noCommentSigns = attributes.getProperty("no-comment-signs");
XMember member = null;
switch (forType) {
case FOR_FIELD:
member = getCurrentField();
break;
case FOR_CONSTRUCTOR:
member = getCurrentConstructor();
break;
case FOR_METHOD:
member = getCurrentMethod();
break;
default:
throw new XDocletException("Bad type " + forType);
}
if (noCommentSigns != null && noCommentSigns.equalsIgnoreCase("true")) {
return member.getDoc().getCommentText();
}
char[] spaces = getIndentChars(attributes);
Collection memberTags = member.getDoc().getTags();
if (memberTags.size() > 0) {
StringBuffer sbuf = new StringBuffer();
// add user comments
StringTokenizer st = new StringTokenizer(member.getDoc().getCommentText().trim(), "\n", false);
if (st.countTokens() > 0) {
sbuf.append(spaces).append("/**").append(PrettyPrintWriter.LINE_SEPARATOR);
while (st.hasMoreTokens()) {
sbuf.append(spaces).append(" * ").append(st.nextToken().trim()).append(PrettyPrintWriter.LINE_SEPARATOR);
}
for (Iterator i = memberTags.iterator(); i.hasNext(); ) {
XTag memberTag = (XTag) i.next();
// all of our xdoclet-specific tags have a ":" or "."
String memberTagName = memberTag.getName();
if (memberTagName.indexOf(':') == -1 && memberTagName.indexOf('.') == -1
&& getDocletContext().getExcludedTags().indexOf(memberTagName) == -1) {
sbuf.append(spaces).append(" * ")
.append('@').append(memberTag.getName()).append(' ')
.append(memberTag.getValue());
// for all lines but not the last line
if (i.hasNext()) {
sbuf.append(PrettyPrintWriter.LINE_SEPARATOR);
}
}
}
sbuf.append(spaces).append(" */");
}
return sbuf.toString();
}
else {
return "";
}
}
/**
* Describe what the method does
*
* @param member Describe what the parameter does
* @return Describe the return value
* @exception XDocletException Describe the exception
*/
protected String firstSentenceDescriptionOfCurrentMember(XMember member) throws XDocletException
{
return member.getDoc().getFirstSentence() != null ? member.getDoc().getFirstSentence() : "";
}
/**
* @param template Describe what the parameter does
* @param attributes Describe what the parameter does
* @param forType Describe what the parameter does
* @exception XDocletException Describe the exception
* @todo the already Set contains XMember objects. equals/hashCode should be defined in
* XMember and be implemented in all of the implementing classes.
*/
protected void forAllMembers(String template, Properties attributes, int forType) throws XDocletException
{
boolean superclasses = TypeConversionUtil.stringToBoolean(attributes.getProperty("superclasses"), true);
boolean sort = TypeConversionUtil.stringToBoolean(attributes.getProperty("sort"), true);
XClass currentClass = getCurrentClass();
if (currentClass == null) {
throw new XDocletException("currentClass == null!!!");
}
Collection members = null;
switch (forType) {
case FOR_FIELD:
members = currentClass.getFields(superclasses);
break;
case FOR_CONSTRUCTOR:
members = currentClass.getConstructors();
break;
case FOR_METHOD:
members = currentClass.getMethods(superclasses);
break;
default:
throw new XDocletException("Bad type: " + forType);
}
if (sort) {
// sort fields, but we should make a copy first, because members is not a new copy, it's shared by all
List sortedMembers = new ArrayList(members);
members = sortedMembers;
}
for (Iterator j = members.iterator(); j.hasNext(); ) {
XMember member = (XMember) j.next();
switch (forType) {
case FOR_FIELD:
setCurrentField((XField) member);
break;
case FOR_CONSTRUCTOR:
setCurrentConstructor((XConstructor) member);
break;
case FOR_METHOD:
setCurrentMethod((XMethod) member);
break;
default:
throw new XDocletException("Bad type: " + forType);
}
setCurrentClass(member.getContainingClass());
generate(template);
}
setCurrentClass(currentClass);
}
/**
* A utility method used by firstSentenceDescription to replace end of line by space.
*
* @param pText Description of Parameter
* @return Description of the Returned Value
*/
protected String checkForWrap(String pText)
{
int lIndex = pText.indexOf(PrettyPrintWriter.LINE_SEPARATOR);
while (lIndex >= 0) {
if (lIndex < pText.length() - 1) {
pText = new StringBuffer(pText.substring(0, lIndex).trim()).append(' ').append(pText.substring(lIndex + 1).trim()).toString();
}
else {
pText = pText.substring(0, lIndex);
}
lIndex = pText.indexOf(PrettyPrintWriter.LINE_SEPARATOR);
}
// Avoid any trailing spaces
return pText.trim();
}
/**
* Gets the InAppendExceptionsList attribute of the AbstractProgramElementTagsHandler object
*
* @param appendExceptions Describe what the parameter does
* @param type Describe what the parameter does
* @return The InAppendExceptionsList value
*/
private boolean isInAppendExceptionsList(String appendExceptions, String type)
{
if (appendExceptions == null) {
return false;
}
else {
return appendExceptions.indexOf(type) != -1;
}
}
/**
* Gets the InSkipExceptionsList attribute of the AbstractProgramElementTagsHandler object
*
* @param skipExceptions Describe what the parameter does
* @param type Describe what the parameter does
* @return The InSkipExceptionsList value
*/
private boolean isInSkipExceptionsList(String skipExceptions, String type)
{
if (skipExceptions == null) {
return false;
}
else {
return skipExceptions.indexOf(type) != -1;
}
}
/**
* Append an exception to the supplied string buffer, building up a throws clause.
*
* @param sbuf String buffer containing the throws clause
* @param type String containing an exception type to add
*/
private void appendException(StringBuffer sbuf, String type)
{
if (sbuf.length() == 0) {
sbuf.append("throws ").append(type);
}
else {
sbuf.append(", ").append(type);
}
}
/**
* Describe what the method does
*
* @param clazz Describe what the parameter does
* @param memberName Describe what the parameter does
* @param forType Describe what the parameter does
* @return Describe the return value
* @exception XDocletException Describe the exception
*/
private XExecutableMember extractXExecutableMember(XClass clazz, String memberName, int forType) throws XDocletException
{
Collection executableMembers = null;
switch (forType) {
case FOR_CONSTRUCTOR:
executableMembers = clazz.getConstructors();
break;
case FOR_METHOD:
executableMembers = clazz.getMethods();
break;
default:
throw new XDocletException("Bad type: " + forType);
}
for (Iterator i = executableMembers.iterator(); i.hasNext(); ) {
XExecutableMember executableMember = (XExecutableMember) i.next();
if (executableMember.getName().equals(memberName)) {
return executableMember;
}
}
return null;
}
}
The table below shows all metrics for AbstractProgramElementTagsHandler.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 96.00 | Number of blocks | |
| BLOCK_COMMENT | 8.00 | Number of block comment lines | |
| COMMENTS | 250.00 | Comment lines | |
| COMMENT_DENSITY | 0.65 | Comment density | |
| COMPARISONS | 72.00 | Number of comparison operators | |
| CYCLOMATIC | 131.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 32.00 | Comments in declarations | |
| DOC_COMMENT | 231.00 | Number of javadoc comment lines | |
| ELOC | 383.00 | Effective lines of code | |
| EXEC_COMMENTS | 12.00 | Comments in executable code | |
| EXITS | 83.00 | Procedure exits | |
| FUNCTIONS | 27.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 90.39 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 117.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 | 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 | 2.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 | 2.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 | 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 | 0.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 | 1.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 | 4.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 | 8.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 | 1.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 5.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 | 1.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 1.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 1.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 2.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 1.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 2.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 | 6.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 | 1.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 | 891.00 | Number of lines in the source file | |
| LINE_COMMENT | 11.00 | Number of line comments | |
| LOC | 518.00 | Lines of code | |
| LOGICAL_LINES | 252.00 | Number of statements | |
| LOOPS | 15.00 | Number of loops | |
| NEST_DEPTH | 7.00 | Maximum nesting depth | |
| OPERANDS | 1065.00 | Number of operands | |
| OPERATORS | 2164.00 | Number of operators | |
| PARAMS | 52.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3229.00 | Halstead program length | |
| PROGRAM_VOCAB | 379.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 65.00 | Number of return points from functions | |
| SIZE | 32155.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 324.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 55.00 | Number of unique operators | |
| WHITESPACE | 123.00 | Number of whitespace lines | |