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

public class FieldNameRule
extends AbstractAstVisitorRule
implements groovy.lang.GroovyObject

Field Summary

Fields inherited from class AbstractAstVisitorRule

CLOSURE_TEXT, DEFAULT_CONST_NAME, DEFAULT_FIELD_NAME, DEFAULT_TEST_CLASS_NAMES, DEFAULT_TEST_FILES, DEFAULT_VAR_NAME

Constructor Summary

Constructors

Constructor	Description
FieldNameRule()

Method Summary

Modifier and Type	Method	Description
Class	getAstVisitorClass()	Each concrete subclass must either set this property or define its own property with the same name
String	getFinalRegex()
String	getIgnoreFieldNames()
groovy.lang.MetaClass	getMetaClass()
String	getName()
int	getPriority()
String	getPrivateStaticFinalRegex()
Object	getProperty(String property)
String	getRegex()
String	getStaticFinalRegex()
String	getStaticRegex()
Object	invokeMethod(String method, Object arguments)
void	setAstVisitorClass(Class value)
void	setFinalRegex(String value)
void	setIgnoreFieldNames(String value)
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	setPrivateStaticFinalRegex(String value)
void	setProperty(String property, Object value)
void	setRegex(String value)
void	setStaticFinalRegex(String value)
void	setStaticRegex(String value)
void	validate()	Allows rules to perform validation.

Methods inherited from class AbstractAstVisitorRule

applyTo, getApplyToClassNames, getAstVisitor, getDoNotApplyToClassNames, setApplyToClassNames, setDoNotApplyToClassNames, shouldApplyThisRuleTo

Methods inherited from class AbstractRule

applyTo, createViolation, createViolation, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, getDescription, getDoNotApplyToFileNames, getDoNotApplyToFilesMatching, getViolationMessage, isEnabled, isReady, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setViolationMessage, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FieldNameRule

public FieldNameRule()

Method Details

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)

getStaticRegex

public String getStaticRegex()

setStaticRegex

public void setStaticRegex(String value)

getFinalRegex

public String getFinalRegex()

setFinalRegex

public void setFinalRegex(String value)

getStaticFinalRegex

public String getStaticFinalRegex()

setStaticFinalRegex

public void setStaticFinalRegex(String value)

getPrivateStaticFinalRegex

public String getPrivateStaticFinalRegex()

setPrivateStaticFinalRegex

public void setPrivateStaticFinalRegex(String value)

getIgnoreFieldNames

public String getIgnoreFieldNames()

setIgnoreFieldNames

public void setIgnoreFieldNames(String value)

getAstVisitorClass

public 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 class AbstractAstVisitorRule

setAstVisitorClass

public void setAstVisitorClass(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 use assert calls to verify required preconditions.

Overrides:

validate in class AbstractRule