com.ibm.rsar.analysis.codereview.cobol.custom.rules

Class AbstractCustomCobolAnalysisRule

  • java.lang.Object
    • com.ibm.rsaz.analysis.core.element.AbstractLightWeightAnalysisElement
      • com.ibm.rsaz.analysis.core.element.AbstractAnalysisElement
        • com.ibm.rsaz.analysis.core.rule.AbstractAnalysisRule
          • com.ibm.rsar.analysis.codereview.cobol.custom.rules.AbstractCustomCobolAnalysisRule
  • All Implemented Interfaces:
    org.eclipse.core.runtime.IExecutableExtension


    public abstract class AbstractCustomCobolAnalysisRule
    extends com.ibm.rsaz.analysis.core.rule.AbstractAnalysisRule
    This class should be subclassed to implement a custom COBOL static analysis rule.
    Since:
    8.5
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String copyright 
      • Fields inherited from class com.ibm.rsaz.analysis.core.element.AbstractAnalysisElement

        COMBO_VALUE, DETAIL_PROVIDER, PLUGIN_PROP_CATEGORY, PLUGIN_PROP_CLASS, PLUGIN_PROP_DESCRIPTION, PLUGIN_PROP_HELP, PLUGIN_PROP_PROVIDER, PLUGIN_PROP_VISIBLE
      • Fields inherited from class com.ibm.rsaz.analysis.core.element.AbstractLightWeightAnalysisElement

        CATEGORY_ELEMENT_TYPE, PLUGIN_PROP_CONFIGURATION, PLUGIN_PROP_ICON, PLUGIN_PROP_ID, PLUGIN_PROP_LABEL, PLUGIN_PROP_MANAGER, PLUGIN_PROP_QUICKFIX, PLUGIN_PROP_QUICKFIX_ICON, PLUGIN_PROP_RESULT_VIEW_ID, PLUGIN_PROP_SEVERITY, PLUGIN_PROP_VIEWER, PROVIDER_ELEMENT_TYPE, PROVIDER_MANAGER_ELEMENT_TYPE, RESULT_ELEMENT_TYPE, RULE_ELEMENT_TYPE
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method and Description
      void analyze(com.ibm.rsaz.analysis.core.history.AnalysisHistory history) 
      abstract java.util.List<com.ibm.etools.cobol.application.model.cobol.ASTNode> performRule(com.ibm.etools.cobol.application.model.cobol.ASTNode baseNode)
      This method returns the list of COBOL application model abstract syntax tree child nodes of the given base node that violate the rule implemented by this class.
      • Methods inherited from class com.ibm.rsaz.analysis.core.rule.AbstractAnalysisRule

        addFilteredDomain, addFilteredType, addHistoryResultSet, analyze, canQuickFixAll, getFiltersSet, getIconName, getLabelWithParameters, getOwnedElements, getQuickFix, getQuickFixCount, getQuickFixIterator, getViewer, hasQuickFixes, init, initImpl, isCustom, isVisible, setCustom, setInitializationData, setQuickFixAll, setQuickFixId
      • Methods inherited from class com.ibm.rsaz.analysis.core.element.AbstractAnalysisElement

        addDetailProvider, addOwnedElement, addOwnedElements, addParameter, addParameters, addRequiredDataCollectorID, getBasicRequiredDataCollectorsID, getDetailProviders, getHelpID, getId, getLabel, getParameter, getParameterCount, getParameterList, getPluginId, getProviderManager, getRequiredDataCollectorsIDs, getViewerID, getVisibleParameterCount, isEnabled, postAnalyze, preAnalyze, setDisabledIconName, setHelpID, setIconName, setId, setInitializationData, setLabel, setPluginId, toString
      • Methods inherited from class com.ibm.rsaz.analysis.core.element.AbstractLightWeightAnalysisElement

        dispose, getElementType, getOwner, getOwnerId, getProvider, setElementType, setOwner
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • AbstractCustomCobolAnalysisRule

        public AbstractCustomCobolAnalysisRule()
    • Method Detail

      • analyze

        public void analyze(com.ibm.rsaz.analysis.core.history.AnalysisHistory history)
        Specified by:
        analyze in class com.ibm.rsaz.analysis.core.rule.AbstractAnalysisRule
      • performRule

        public abstract java.util.List<com.ibm.etools.cobol.application.model.cobol.ASTNode> performRule(com.ibm.etools.cobol.application.model.cobol.ASTNode baseNode)
        This method returns the list of COBOL application model abstract syntax tree child nodes of the given base node that violate the rule implemented by this class.
        Parameters:
        baseNode - the base COBOL application model abstract syntax tree node
        Returns:
        the list of nodes violating the rule