org.codenarc.rule.generic
Class RequiredRegexRule

java.lang.Object
  extended by org.codenarc.rule.AbstractRule
      extended by org.codenarc.rule.generic.RequiredRegexRule
All Implemented Interfaces:
groovy.lang.GroovyObject, Rule

public class RequiredRegexRule
extends AbstractRule
implements groovy.lang.GroovyObject


Constructor Summary
RequiredRegexRule()
           
 
Method Summary
 void applyTo(SourceCode sourceCode, List violations)
          Apply this rule to the specified source and return a list of violations (or an empty List)
 groovy.lang.MetaClass getMetaClass()
           
 String getName()
           
 int getPriority()
           
 Object getProperty(String property)
           
 String getRegex()
           
 Object invokeMethod(String method, Object arguments)
           
 boolean isReady()
          Allows rules to check whether preconditions are satisfied and short-circuit execution (i.e., do nothing) if those preconditions are not satisfied.
 void setMetaClass(groovy.lang.MetaClass mc)
           
 void setName(String value)
          Set the unique name for this rule
 void setPriority(int value)
          Set the priority for this rule
 void setProperty(String property, Object value)
           
 void setRegex(String value)
           
 
Methods inherited from class org.codenarc.rule.AbstractRule
applyTo, createViolation, createViolation, createViolation, createViolation, createViolation, createViolationForImport, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getViolationMessage, isEnabled, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setViolationMessage, toString, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RequiredRegexRule

public RequiredRegexRule()
Method Detail

getMetaClass

public groovy.lang.MetaClass getMetaClass()
Specified by:
getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass mc)
Specified by:
setMetaClass in interface groovy.lang.GroovyObject

invokeMethod

public Object invokeMethod(String method,
                           Object arguments)
Specified by:
invokeMethod in interface groovy.lang.GroovyObject

getProperty

public Object getProperty(String property)
Specified by:
getProperty in interface groovy.lang.GroovyObject

setProperty

public void setProperty(String property,
                        Object value)
Specified by:
setProperty in interface groovy.lang.GroovyObject

getName

public String getName()
Specified by:
getName in interface Rule
Specified by:
getName in class AbstractRule
Returns:
the unique name for this rule

setName

public void setName(String value)
Description copied from class: AbstractRule
Set the unique name for this rule

Specified by:
setName in class AbstractRule
Parameters:
value - - the name for this rule; this should be unique

getPriority

public int getPriority()
Specified by:
getPriority in interface Rule
Specified by:
getPriority in class AbstractRule
Returns:
the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.

setPriority

public void setPriority(int value)
Description copied from class: AbstractRule
Set the priority for this rule

Specified by:
setPriority in class AbstractRule
Parameters:
value - - the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.

getRegex

public String getRegex()

setRegex

public void setRegex(String value)

isReady

public boolean isReady()
Description copied from class: AbstractRule
Allows rules to check whether preconditions are satisfied and short-circuit execution (i.e., do nothing) if those preconditions are not satisfied. Return true by default. This method is provided as a placeholder so subclasses can optionally override.

Overrides:
isReady in class AbstractRule
Returns:
true if all preconditions for this rule are satisfied

applyTo

public void applyTo(SourceCode sourceCode,
                    List violations)
Description copied from class: AbstractRule
Apply this rule to the specified source and return a list of violations (or an empty List)

Specified by:
applyTo in class AbstractRule
Parameters:
sourceCode - - the source to apply this rule to
violations - - the List of violations to which new violations from this rule are to be added


Copyright © 2012. All Rights Reserved.