Package org.codenarc.rule.naming
Class FieldNameRule
java.lang.Object
org.codenarc.rule.AbstractRule
org.codenarc.rule.AbstractAstVisitorRule
org.codenarc.rule.naming.FieldNameRule
- All Implemented Interfaces:
groovy.lang.GroovyObject
,Rule
-
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 -
Method Summary
Modifier and TypeMethodDescriptionEach concrete subclass must either set this property or define its own property with the same namegroovy.lang.MetaClass
getName()
int
getProperty
(String property) getRegex()
invokeMethod
(String method, Object arguments) void
setAstVisitorClass
(Class value) void
setFinalRegex
(String value) void
setIgnoreFieldNames
(String value) void
setMetaClass
(groovy.lang.MetaClass mc) void
Set the unique name for this rulevoid
setPriority
(int value) Set the priority for this rulevoid
setPrivateStaticFinalRegex
(String value) void
setProperty
(String property, Object value) void
void
setStaticFinalRegex
(String value) void
setStaticRegex
(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
-
Constructor Details
-
FieldNameRule
public FieldNameRule()
-
-
Method Details
-
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
- Specified by:
invokeMethod
in interfacegroovy.lang.GroovyObject
-
getProperty
- Specified by:
getProperty
in interfacegroovy.lang.GroovyObject
-
setProperty
- Specified by:
setProperty
in interfacegroovy.lang.GroovyObject
-
getName
- Specified by:
getName
in interfaceRule
- Specified by:
getName
in classAbstractRule
- Returns:
- the unique name for this rule
-
setName
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
-
setRegex
-
getStaticRegex
-
setStaticRegex
-
getFinalRegex
-
setFinalRegex
-
getStaticFinalRegex
-
setStaticFinalRegex
-
getPrivateStaticFinalRegex
-
setPrivateStaticFinalRegex
-
getIgnoreFieldNames
-
setIgnoreFieldNames
-
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
-
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
-