Groovy Documentation

org.codenarc.rule.naming
Class ParameterNameRule

java.lang.Object
  org.codenarc.rule.AbstractRule
      org.codenarc.rule.AbstractAstVisitorRule
          org.codenarc.rule.naming.ParameterNameRule

class ParameterNameRule
extends AbstractAstVisitorRule

Rule that verifies that the name of each parameter matches a regular expression. This rule applies to method parameters, constructor parameters and closure parameters. By default it checks that parameter names start with a lowercase letter and contains only letters or numbers.

The regex property specifies the default regular expression used to validate the parameter name. It is required and cannot be null or empty. It defaults to '[a-z][a-zA-Z0-9]*'.

The ignoreParameterNames property optionally specifies one or more (comma-separated) parameter names that should be ignored (i.e., that should not cause a rule violation). The name(s) may optionally include wildcard characters ('*' or '?').

author:
Chris Mair
version:
$Revision: 179 $ - $Date: 2009-07-11 18:28:40 -0400 (Sat, 11 Jul 2009) $


Property Summary
Class astVisitorClass

String ignoreParameterNames

String name

int priority

String regex

 
Constructor Summary
ParameterNameRule()

 
Method Summary
void validate()

 
Methods inherited from class AbstractAstVisitorRule
shouldApplyThisRuleTo
 
Methods inherited from class AbstractRule
applyTo, createViolation, createViolation, createViolationForImport, createViolationForImport, getImportsSortedByLineNumber, getName, getPriority, packageNameForImport, setName, setPriority, sourceLineAndNumberForImport, sourceLineAndNumberForImport
 

Property Detail

astVisitorClass

Class astVisitorClass


ignoreParameterNames

String ignoreParameterNames


name

String name


priority

int priority


regex

String regex


 
Constructor Detail

ParameterNameRule

ParameterNameRule()


 
Method Detail

validate

void validate()


 

Groovy Documentation