org.eclipse.tptp.platform.analysis.codereview.cpp.rulefilter
Class FunctionDefinitionNameRuleFilter

java.lang.Object
  org.eclipse.tptp.platform.analysis.codereview.cpp.AbstractRuleFilter
      org.eclipse.tptp.platform.analysis.codereview.cpp.rulefilter.FunctionDefinitionNameRuleFilter

All Implemented Interfaces:

IRuleFilter

public class FunctionDefinitionNameRuleFilter

extends AbstractRuleFilter

Constructor Summary

FunctionDefinitionNameRuleFilter(java.lang.String[] functionNames, boolean ignoreClassName, boolean inclusive)
This class provides filtering of function definitions by function name.

FunctionDefinitionNameRuleFilter(java.lang.String functionName, boolean ignoreClassName, boolean inclusive)
This class provides filtering of function definitions by function name.

Method Summary

boolean

satisfies(org.eclipse.cdt.core.dom.ast.IASTNode node) Determine if the node is satisfied by the specified filter rule

Methods inherited from class org.eclipse.tptp.platform.analysis.codereview.cpp.AbstractRuleFilter

isInclusive

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FunctionDefinitionNameRuleFilter

public FunctionDefinitionNameRuleFilter(java.lang.String functionName,
                                        boolean ignoreClassName,
                                        boolean inclusive)

This class provides filtering of function definitions by function name. If ignoreClassName is set to true, then class names are ignored when filtering, eg. to filter ClassName::functionName(), use just "functionName" as the parameter to check for. If ignoreClassName is set to false, you must include the class name prefix in the functionName parameter, otherwise only functions without a class prefix will be found.

Parameters:

functionName - The function name by which to filter

ignoreClassName - True if the class name prefix of a function is to be ignored

inclusive - True if filtering will include only nodes that match the filter criteria, false to exclude matching nodes

FunctionDefinitionNameRuleFilter

public FunctionDefinitionNameRuleFilter(java.lang.String[] functionNames,
                                        boolean ignoreClassName,
                                        boolean inclusive)

This class provides filtering of function definitions by function name. If ignoreClassName is set to true, then class names are ignored when filtering, eg. to filter ClassName::functionName(), use just "functionName" as the parameter to check for. If ignoreClassName is set to false, you must include the class name prefix in the functionName parameter, otherwise only functions without a class prefix will be found.

Parameters:

functionNames - An array of function names on which to filter

ignoreClassName - True if the class name prefix of a function is to be ignored

inclusive - True if filtering will include only nodes that match the filter criteria, false to exclude matching nodes

Method Detail

satisfies

public boolean satisfies(org.eclipse.cdt.core.dom.ast.IASTNode node)

Determine if the node is satisfied by the specified filter rule

Specified by:

satisfies in interface IRuleFilter

Specified by:

satisfies in class AbstractRuleFilter

Parameters:

node - The ASTNode to test

Returns:

true if the node satisifes the filtering rule