Groovy Documentation

org.codenarc.rule.naming
Class InterfaceNameRule

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

class InterfaceNameRule
extends AbstractAstVisitorRule

Rule that verifies that the name of an interface matches a regular expression specified in the regex property. If that property is null or empty, then this rule is not applied (i.e., it does nothing). It defaults to null, so this rule must be explicitly configured to be active.

see:
ClassNameRule
author:
Chris Mair
version:
$Revision: 69 $ - $Date: 2009-02-25 22:03:41 -0500 (Wed, 25 Feb 2009) $


Property Summary
Class astVisitorClass

String name

int priority

String regex

 
Constructor Summary
InterfaceNameRule()

 
Method Summary
boolean isReady()

 
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


name

String name


priority

int priority


regex

String regex


 
Constructor Detail

InterfaceNameRule

InterfaceNameRule()


 
Method Detail

isReady

boolean isReady()


 

Groovy Documentation