CodeTemplateContextType.java
| Index Score | ||
|---|---|---|
 |
 |
net.sourceforge.phpdt.internal.corext.template.php |
 |
 |
PHPeclipse |
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 | |
|---|---|---|
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' |  |
| ELOC | Effective lines of code | |
| SIZE | Size of the file in bytes | |
| LOC | Lines of code | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| OPERANDS | Number of operands | |
| LOGICAL_LINES | Number of statements | |
| PROGRAM_LENGTH | Halstead program length | |
| OPERATORS | Number of operators | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| LINES | Number of lines in the source file | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| EXEC_COMMENTS | Comments in executable code | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0171 | JAVA0171 Unused local variable | |
| LINE_COMMENT | Number of line comments | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| DOC_COMMENT | Number of javadoc comment lines | |
| COMMENTS | Comment lines | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| LOOPS | Number of loops | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| RETURNS | Number of return points from functions | |
| PARAMS | Number of formal parameter declarations | |
| UNIQUE_OPERATORS | Number of unique operators | |
/*******************************************************************************
* Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package net.sourceforge.phpdt.internal.corext.template.php;
import java.util.ArrayList;
import net.sourceforge.phpdt.core.ToolFactory;
import net.sourceforge.phpdt.core.compiler.IScanner;
import net.sourceforge.phpdt.core.compiler.ITerminalSymbols;
import net.sourceforge.phpdt.core.compiler.InvalidInputException;
import net.sourceforge.phpdt.internal.corext.codemanipulation.StubUtility;
import org.eclipse.jface.text.templates.ContextTypeRegistry;
import org.eclipse.jface.text.templates.GlobalTemplateVariables;
import org.eclipse.jface.text.templates.TemplateContext;
import org.eclipse.jface.text.templates.TemplateContextType;
import org.eclipse.jface.text.templates.TemplateException;
import org.eclipse.jface.text.templates.TemplateVariable;
import org.eclipse.jface.text.templates.TemplateVariableResolver;
/**
*/
public class CodeTemplateContextType extends TemplateContextType {
/* context types */
public static final String CATCHBLOCK_CONTEXTTYPE = "php_catchblock_context"; //$NON-NLS-1$
public static final String METHODBODY_CONTEXTTYPE = "php_methodbody_context"; //$NON-NLS-1$
public static final String CONSTRUCTORBODY_CONTEXTTYPE = "php_constructorbody_context"; //$NON-NLS-1$
public static final String GETTERBODY_CONTEXTTYPE = "php_getterbody_context"; //$NON-NLS-1$
public static final String SETTERBODY_CONTEXTTYPE = "php_setterbody_context"; //$NON-NLS-1$
public static final String NEWTYPE_CONTEXTTYPE = "php_newtype_context"; //$NON-NLS-1$
public static final String NEWHTML_CONTEXTTYPE = "php_newhtml_context"; //$NON-NLS-1$
public static final String TYPECOMMENT_CONTEXTTYPE = "php_typecomment_context"; //$NON-NLS-1$
public static final String FIELDCOMMENT_CONTEXTTYPE = "php_fieldcomment_context"; //$NON-NLS-1$
public static final String METHODCOMMENT_CONTEXTTYPE = "php_methodcomment_context"; //$NON-NLS-1$
public static final String CONSTRUCTORCOMMENT_CONTEXTTYPE = "php_constructorcomment_context"; //$NON-NLS-1$
public static final String OVERRIDECOMMENT_CONTEXTTYPE = "php_overridecomment_context"; //$NON-NLS-1$
public static final String GETTERCOMMENT_CONTEXTTYPE = "php_gettercomment_context"; //$NON-NLS-1$
public static final String SETTERCOMMENT_CONTEXTTYPE = "php_settercomment_context"; //$NON-NLS-1$
/* templates */
public static final String COMMENT_SUFFIX = "comment"; //$NON-NLS-1$
public static final String CATCHBLOCK = "catchblock"; //$NON-NLS-1$
public static final String METHODSTUB = "methodbody"; //$NON-NLS-1$
public static final String NEWTYPE = "newtype"; //$NON-NLS-1$
public static final String NEWHTML = "newhtml"; //$NON-NLS-1$
public static final String CONSTRUCTORSTUB = "constructorbody"; //$NON-NLS-1$
public static final String GETTERSTUB = "getterbody"; //$NON-NLS-1$
public static final String SETTERSTUB = "setterbody"; //$NON-NLS-1$
public static final String TYPECOMMENT = "type" + COMMENT_SUFFIX; //$NON-NLS-1$
public static final String FIELDCOMMENT = "field" + COMMENT_SUFFIX; //$NON-NLS-1$
public static final String METHODCOMMENT = "method" + COMMENT_SUFFIX; //$NON-NLS-1$
public static final String CONSTRUCTORCOMMENT = "constructor" + COMMENT_SUFFIX; //$NON-NLS-1$
public static final String OVERRIDECOMMENT = "override" + COMMENT_SUFFIX; //$NON-NLS-1$
public static final String GETTERCOMMENT = "getter" + COMMENT_SUFFIX; //$NON-NLS-1$
public static final String SETTERCOMMENT = "setter" + COMMENT_SUFFIX; //$NON-NLS-1$
/* resolver types */
public static final String EXCEPTION_TYPE = "exception_type"; //$NON-NLS-1$
public static final String EXCEPTION_VAR = "exception_var"; //$NON-NLS-1$
public static final String ENCLOSING_METHOD = "enclosing_method"; //$NON-NLS-1$
public static final String ENCLOSING_TYPE = "enclosing_type"; //$NON-NLS-1$
public static final String BODY_STATEMENT = "body_statement"; //$NON-NLS-1$
public static final String FIELD = "field"; //$NON-NLS-1$
public static final String FIELD_TYPE = "field_type"; //$NON-NLS-1$
public static final String BARE_FIELD_NAME = "bare_field_name"; //$NON-NLS-1$
public static final String PARAM = "param"; //$NON-NLS-1$
public static final String RETURN_TYPE = "return_type"; //$NON-NLS-1$
public static final String SEE_TAG = "see_to_overridden"; //$NON-NLS-1$
public static final String TAGS = "tags"; //$NON-NLS-1$
public static final String TYPENAME = "type_name"; //$NON-NLS-1$
public static final String FILENAME = "file_name"; //$NON-NLS-1$
public static final String PACKAGENAME = "package_name"; //$NON-NLS-1$
public static final String PROJECTNAME = "project_name"; //$NON-NLS-1$
public static final String PACKAGE_DECLARATION = "package_declaration"; //$NON-NLS-1$
public static final String TYPE_DECLARATION = "type_declaration"; //$NON-NLS-1$
public static final String TYPE_COMMENT = "typecomment"; //$NON-NLS-1$
/**
* Resolver that resolves to the variable defined in the context.
*/
public static class CodeTemplateVariableResolver extends
TemplateVariableResolver {
public CodeTemplateVariableResolver(String type, String description) {
super(type, description);
}
protected String resolve(TemplateContext context) {
return context.getVariable(getType());
}
}
/**
* Resolver for javadoc tags.
*/
public static class TagsVariableResolver extends TemplateVariableResolver {
public TagsVariableResolver() {
super(
TAGS,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.tags")); //$NON-NLS-1$
}
protected String resolve(TemplateContext context) {
return "@"; //$NON-NLS-1$
}
}
/**
* Resolver for todo tags.
*/
protected static class Todo extends TemplateVariableResolver {
public Todo() {
super(
"todo", JavaTemplateMessages.getString("CodeTemplateContextType.variable.description.todo")); //$NON-NLS-1$ //$NON-NLS-2$
}
protected String resolve(TemplateContext context) {
String todoTaskTag = StubUtility
.getTodoTaskTag(((CodeTemplateContext) context)
.getJavaProject());
if (todoTaskTag == null)
return "XXX"; //$NON-NLS-1$
return todoTaskTag;
}
}
private boolean fIsComment;
public CodeTemplateContextType(String contextName) {
super(contextName);
fIsComment = false;
// global
addResolver(new GlobalTemplateVariables.Dollar());
addResolver(new GlobalTemplateVariables.Date());
addResolver(new GlobalTemplateVariables.Year());
addResolver(new GlobalTemplateVariables.Time());
addResolver(new GlobalTemplateVariables.User());
addResolver(new Todo());
if (CATCHBLOCK_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
EXCEPTION_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.exceptiontype"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
EXCEPTION_VAR,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.exceptionvar"))); //$NON-NLS-1$
} else if (METHODBODY_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingtype"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_METHOD,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingmethod"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
BODY_STATEMENT,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.bodystatement"))); //$NON-NLS-1$
} else if (CONSTRUCTORBODY_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingtype"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
BODY_STATEMENT,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.bodystatement"))); //$NON-NLS-1$
} else if (GETTERBODY_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingtype"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_METHOD,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingmethod"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
FIELD,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.getterfieldname"))); //$NON-NLS-1$
} else if (SETTERBODY_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingtype"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_METHOD,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingmethod"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
FIELD,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.getterfieldname"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
PARAM,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.param"))); //$NON-NLS-1$
} else if (NEWTYPE_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
TYPENAME,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.typename"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
PACKAGE_DECLARATION,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.packdeclaration"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
TYPE_DECLARATION,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.typedeclaration"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
TYPE_COMMENT,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.typecomment"))); //$NON-NLS-1$
addCompilationUnitVariables();
} else if (NEWHTML_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
TYPENAME,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.typename"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
PACKAGE_DECLARATION,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.packdeclaration"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
TYPE_DECLARATION,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.typedeclaration"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
TYPE_COMMENT,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.typecomment"))); //$NON-NLS-1$
addCompilationUnitVariables();
} else if (TYPECOMMENT_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
TYPENAME,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.typename"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingtype"))); //$NON-NLS-1$
addResolver(new TagsVariableResolver());
addCompilationUnitVariables();
fIsComment = true;
} else if (FIELDCOMMENT_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
FIELD_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.fieldtype"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
FIELD,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.fieldname"))); //$NON-NLS-1$
addCompilationUnitVariables();
fIsComment = true;
} else if (METHODCOMMENT_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingtype"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_METHOD,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingmethod"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
RETURN_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.returntype"))); //$NON-NLS-1$
addResolver(new TagsVariableResolver());
addCompilationUnitVariables();
fIsComment = true;
} else if (OVERRIDECOMMENT_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingtype"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_METHOD,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingmethod"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
SEE_TAG,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.seetag"))); //$NON-NLS-1$
addResolver(new TagsVariableResolver());
addCompilationUnitVariables();
fIsComment = true;
} else if (CONSTRUCTORCOMMENT_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingtype"))); //$NON-NLS-1$
addResolver(new TagsVariableResolver());
addCompilationUnitVariables();
fIsComment = true;
} else if (GETTERCOMMENT_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingtype"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
FIELD_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.getterfieldtype"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
FIELD,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.getterfieldname"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_METHOD,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingmethod"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
BARE_FIELD_NAME,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.barefieldname"))); //$NON-NLS-1$
addCompilationUnitVariables();
fIsComment = true;
} else if (SETTERCOMMENT_CONTEXTTYPE.equals(contextName)) {
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingtype"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
FIELD_TYPE,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.getterfieldtype"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
FIELD,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.getterfieldname"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
ENCLOSING_METHOD,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.enclosingmethod"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
PARAM,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.param"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
BARE_FIELD_NAME,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.barefieldname"))); //$NON-NLS-1$
addCompilationUnitVariables();
fIsComment = true;
}
}
private void addCompilationUnitVariables() {
addResolver(new CodeTemplateVariableResolver(
FILENAME,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.filename"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
PACKAGENAME,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.packagename"))); //$NON-NLS-1$
addResolver(new CodeTemplateVariableResolver(
PROJECTNAME,
JavaTemplateMessages
.getString("CodeTemplateContextType.variable.description.projectname"))); //$NON-NLS-1$
}
/*
* @see net.sourceforge.phpdt.internal.corext.template.ContextType#validateVariables(net.sourceforge.phpdt.internal.corext.template.TemplateVariable[])
*/
protected void validateVariables(TemplateVariable[] variables)
throws TemplateException {
ArrayList required = new ArrayList(5);
String contextName = getId();
// if (NEWTYPE_CONTEXTTYPE.equals(contextName)) {
// required.add(PACKAGE_DECLARATION);
// required.add(TYPE_DECLARATION);
// }
for (int i = 0; i < variables.length; i++) {
String type = variables[i].getType();
if (getResolver(type) == null) {
throw new TemplateException(
JavaTemplateMessages
.getFormattedString(
"CodeTemplateContextType.validate.unknownvariable", type)); //$NON-NLS-1$
}
required.remove(type);
}
if (!required.isEmpty()) {
String missing = (String) required.get(0);
throw new TemplateException(
JavaTemplateMessages
.getFormattedString(
"CodeTemplateContextType.validate.missingvariable", missing)); //$NON-NLS-1$
}
super.validateVariables(variables);
}
/*
* (non-Javadoc)
*
* @see net.sourceforge.phpdt.internal.corext.template.ContextType#createContext()
*/
public TemplateContext createContext() {
return null;
}
public static void registerContextTypes(ContextTypeRegistry registry) {
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.CATCHBLOCK_CONTEXTTYPE));
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.METHODBODY_CONTEXTTYPE));
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.CONSTRUCTORBODY_CONTEXTTYPE));
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.GETTERBODY_CONTEXTTYPE));
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.SETTERBODY_CONTEXTTYPE));
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.NEWTYPE_CONTEXTTYPE));
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.NEWHTML_CONTEXTTYPE));
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.TYPECOMMENT_CONTEXTTYPE));
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.FIELDCOMMENT_CONTEXTTYPE));
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.METHODCOMMENT_CONTEXTTYPE));
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.CONSTRUCTORCOMMENT_CONTEXTTYPE));
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.OVERRIDECOMMENT_CONTEXTTYPE));
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.GETTERCOMMENT_CONTEXTTYPE));
registry.addContextType(new CodeTemplateContextType(
CodeTemplateContextType.SETTERCOMMENT_CONTEXTTYPE));
}
/*
* @see net.sourceforge.phpdt.internal.corext.template.ContextType#validate(java.lang.String)
*/
public void validate(String pattern) throws TemplateException {
super.validate(pattern);
if (fIsComment) {
if (!isValidComment(pattern)) {
throw new TemplateException(
JavaTemplateMessages
.getString("CodeTemplateContextType.validate.invalidcomment")); //$NON-NLS-1$
}
}
}
private boolean isValidComment(String template) {
IScanner scanner = ToolFactory.createScanner(true, false, false, true);// false);
scanner.setSource(template.toCharArray());
try {
int next = scanner.getNextToken();
while (next == ITerminalSymbols.TokenNameCOMMENT_LINE
|| next == ITerminalSymbols.TokenNameCOMMENT_PHPDOC
|| next == ITerminalSymbols.TokenNameCOMMENT_BLOCK) {
next = scanner.getNextToken();
}
return next == ITerminalSymbols.TokenNameEOF;
} catch (InvalidInputException e) {
}
return false;
}
}
The table below shows all metrics for CodeTemplateContextType.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 35.00 | Number of blocks | |
| BLOCK_COMMENT | 14.00 | Number of block comment lines | |
| COMMENTS | 40.00 | Comment lines | |
| COMMENT_DENSITY | 0.10 | Comment density | |
| COMPARISONS | 23.00 | Number of comparison operators | |
| CYCLOMATIC | 37.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 11.00 | Comments in declarations | |
| DOC_COMMENT | 21.00 | Number of javadoc comment lines | |
| ELOC | 390.00 | Effective lines of code | |
| EXEC_COMMENTS | 2.00 | Comments in executable code | |
| EXITS | 21.00 | Procedure exits | |
| FUNCTIONS | 13.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 76.04 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 28.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 1.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 | 1.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 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 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 48.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 6.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 | 1.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 1.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 | 2.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1466.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 | 1.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 | 528.00 | Number of lines in the source file | |
| LINE_COMMENT | 5.00 | Number of line comments | |
| LOC | 415.00 | Lines of code | |
| LOGICAL_LINES | 179.00 | Number of statements | |
| LOOPS | 2.00 | Number of loops | |
| NEST_DEPTH | 3.00 | Maximum nesting depth | |
| OPERANDS | 822.00 | Number of operands | |
| OPERATORS | 1490.00 | Number of operators | |
| PARAMS | 10.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2312.00 | Halstead program length | |
| PROGRAM_VOCAB | 269.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 18.00 | Number of return points from functions | |
| SIZE | 21468.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 227.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 42.00 | Number of unique operators | |
| WHITESPACE | 73.00 | Number of whitespace lines | |