org.eclipse.tptp.platform.analysis.codereview.java.templates
Class Template_Avoid_Class_Method_Arguments

java.lang.Object
  org.eclipse.tptp.platform.analysis.core.element.AbstractAnalysisElement
      org.eclipse.tptp.platform.analysis.core.rule.AbstractAnalysisRule
          org.eclipse.tptp.platform.analysis.codereview.java.templates.Template_Avoid_Class_Method_Arguments

All Implemented Interfaces:

org.eclipse.core.runtime.IExecutableExtension, IAnalysisElement, IAnalysisRule

public class Template_Avoid_Class_Method_Arguments
extends AbstractAnalysisRule

This class implements a rule template which generates code review matched if the code being analyzed used a given class/method combination. The general message format for a match is

Avoid using method from class

The template defines two custom variables in the extension, which must be provided:

CLASS - the name of the class the defines the method METHOD - the name of the method which should be avoided

Field Summary

Fields inherited from class org.eclipse.tptp.platform.analysis.core.element.AbstractAnalysisElement

CATEGORY_ELEMENT_TYPE, COMBO_VALUE, DETAIL_PROVIDER, PROVIDER_ELEMENT_TYPE, PROVIDER_MANAGER_ELEMENT_TYPE, RESULT_ELEMENT_TYPE, RULE_ELEMENT_TYPE

Constructor Summary

Template_Avoid_Class_Method_Arguments()

Method Summary

void	analyze(AnalysisHistory history) Analyze this rule

Methods inherited from class org.eclipse.tptp.platform.analysis.core.rule.AbstractAnalysisRule

addHistoryResultSet, getIconName, getLabelWithParameters, getLabelWithVariables, getOwnedElements, getQuickFix, getQuickFixCount, getQuickFixIterator, getViewer, hasQuickFixes, isCustom, removeHistoryResultSet, setCustom, setInitializationData, setQuickFixId

Methods inherited from class org.eclipse.tptp.platform.analysis.core.element.AbstractAnalysisElement

addDetailProvider, addHistoryResultSet, addOwnedElement, addOwnedElements, addParameter, addParameters, deleteHistoryResults, dispose, getDetailProviders, getElementType, getExecutionHistory, getExternalDataMap, getHelpID, getHistoryResults, getId, getLabel, getOwner, getOwnerId, getParameter, getParameterCount, getParameterList, getPluginId, getProvider, getProviderManager, getViewerID, getVisibleParameterCount, postAnalyze, preAnalyze, removeHistoryResultSet, setElementType, setExternalDataMap, setHelpID, setIconName, setId, setInitializationData, setLabel, setOwner, setOwnerId, setPluginId, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.tptp.platform.analysis.core.rule.IAnalysisRule

addParameter, addParameters, getParameter, getParameterCount, getParameterList, getProvider, getVisibleParameterCount

Methods inherited from interface org.eclipse.tptp.platform.analysis.core.element.IAnalysisElement

addDetailProvider, addHistoryResultSet, addOwnedElement, addOwnedElements, dispose, getDetailProviders, getElementType, getExternalDataMap, getHelpID, getHistoryResults, getId, getLabel, getOwner, getPluginId, preAnalyze, setElementType, setExternalDataMap, setHelpID, setIconName, setId, setLabel, setOwner, setPluginId

Constructor Detail

Template_Avoid_Class_Method_Arguments

public Template_Avoid_Class_Method_Arguments()

Method Detail

analyze

public void analyze(AnalysisHistory history)

Analyze this rule

Specified by:

analyze in interface IAnalysisRule

Specified by:

analyze in class AbstractAnalysisRule

Parameters:

history - A reference to the history record for this analysis