Package org.codenarc.rule.naming
Class PropertyNameRule
- java.lang.Object
-
- org.codenarc.rule.AbstractRule
-
- org.codenarc.rule.AbstractAstVisitorRule
-
- org.codenarc.rule.naming.PropertyNameRule
-
- All Implemented Interfaces:
groovy.lang.GroovyObject
,Rule
public class PropertyNameRule extends AbstractAstVisitorRule implements groovy.lang.GroovyObject
-
-
Field Summary
-
Fields inherited from class org.codenarc.rule.AbstractAstVisitorRule
CLOSURE_TEXT, DEFAULT_CONST_NAME, DEFAULT_FIELD_NAME, DEFAULT_TEST_CLASS_NAMES, DEFAULT_TEST_FILES, DEFAULT_VAR_NAME
-
-
Constructor Summary
Constructors Constructor Description PropertyNameRule()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Class
getAstVisitorClass()
Each concrete subclass must either set this property or define its own property with the same namejava.lang.String
getFinalRegex()
java.lang.String
getIgnorePropertyNames()
groovy.lang.MetaClass
getMetaClass()
java.lang.String
getName()
int
getPriority()
java.lang.Object
getProperty(java.lang.String property)
java.lang.String
getRegex()
java.lang.String
getStaticFinalRegex()
java.lang.String
getStaticRegex()
java.lang.Object
invokeMethod(java.lang.String method, java.lang.Object arguments)
void
setAstVisitorClass(java.lang.Class value)
void
setFinalRegex(java.lang.String value)
void
setIgnorePropertyNames(java.lang.String value)
void
setMetaClass(groovy.lang.MetaClass mc)
void
setName(java.lang.String value)
Set the unique name for this rulevoid
setPriority(int value)
Set the priority for this rulevoid
setProperty(java.lang.String property, java.lang.Object value)
void
setRegex(java.lang.String value)
void
setStaticFinalRegex(java.lang.String value)
void
setStaticRegex(java.lang.String value)
void
validate()
Allows rules to perform validation.-
Methods inherited from class org.codenarc.rule.AbstractAstVisitorRule
applyTo, getApplyToClassNames, getAstVisitor, getDoNotApplyToClassNames, setApplyToClassNames, setDoNotApplyToClassNames, shouldApplyThisRuleTo
-
Methods inherited from class org.codenarc.rule.AbstractRule
applyTo, createViolation, createViolation, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getViolationMessage, isEnabled, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setViolationMessage, toString
-
-
-
-
Method Detail
-
getMetaClass
public groovy.lang.MetaClass getMetaClass()
- Specified by:
getMetaClass
in interfacegroovy.lang.GroovyObject
-
setMetaClass
public void setMetaClass(groovy.lang.MetaClass mc)
- Specified by:
setMetaClass
in interfacegroovy.lang.GroovyObject
-
invokeMethod
public java.lang.Object invokeMethod(java.lang.String method, java.lang.Object arguments)
- Specified by:
invokeMethod
in interfacegroovy.lang.GroovyObject
-
getProperty
public java.lang.Object getProperty(java.lang.String property)
- Specified by:
getProperty
in interfacegroovy.lang.GroovyObject
-
setProperty
public void setProperty(java.lang.String property, java.lang.Object value)
- Specified by:
setProperty
in interfacegroovy.lang.GroovyObject
-
getName
public java.lang.String getName()
- Specified by:
getName
in interfaceRule
- Specified by:
getName
in classAbstractRule
- Returns:
- the unique name for this rule
-
setName
public void setName(java.lang.String value)
Description copied from class:AbstractRule
Set the unique name for this rule- Specified by:
setName
in classAbstractRule
- Parameters:
value
- - the name for this rule; this should be unique
-
getPriority
public int getPriority()
- Specified by:
getPriority
in interfaceRule
- Specified by:
getPriority
in classAbstractRule
- 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 classAbstractRule
- Parameters:
value
- - the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.
-
getRegex
public java.lang.String getRegex()
-
setRegex
public void setRegex(java.lang.String value)
-
getStaticRegex
public java.lang.String getStaticRegex()
-
setStaticRegex
public void setStaticRegex(java.lang.String value)
-
getFinalRegex
public java.lang.String getFinalRegex()
-
setFinalRegex
public void setFinalRegex(java.lang.String value)
-
getStaticFinalRegex
public java.lang.String getStaticFinalRegex()
-
setStaticFinalRegex
public void setStaticFinalRegex(java.lang.String value)
-
getIgnorePropertyNames
public java.lang.String getIgnorePropertyNames()
-
setIgnorePropertyNames
public void setIgnorePropertyNames(java.lang.String value)
-
getAstVisitorClass
public java.lang.Class getAstVisitorClass()
Description copied from class:AbstractAstVisitorRule
Each concrete subclass must either set this property or define its own property with the same name- Overrides:
getAstVisitorClass
in classAbstractAstVisitorRule
-
setAstVisitorClass
public void setAstVisitorClass(java.lang.Class value)
-
validate
public void validate()
Description copied from class:AbstractRule
Allows rules to perform validation. Do nothing by default. This method is provided as a placeholder so subclasses can optionally override. Subclasses will typically useassert
calls to verify required preconditions.- Overrides:
validate
in classAbstractRule
-
-