org.codenarc.rule.generic
Class IllegalClassMemberRule

java.lang.Object
  org.codenarc.rule.AbstractRule
      org.codenarc.rule.AbstractAstVisitorRule
          org.codenarc.rule.generic.IllegalClassMemberRule

All Implemented Interfaces:

groovy.lang.GroovyObject, Rule

public class IllegalClassMemberRule
extends AbstractAstVisitorRule
implements groovy.lang.GroovyObject

Field Summary

protected Collection<Integer>	allowedFieldModifiersList
protected String	allowedFieldModifiersString
protected Collection<Integer>	allowedMethodModifiersList
protected String	allowedMethodModifiersString
protected Collection<Integer>	allowedPropertyModifiersList
protected String	allowedPropertyModifiersString
protected Collection<Integer>	illegalFieldModifiersList
protected String	illegalFieldModifiersString
protected Collection<Integer>	illegalMethodModifiersList
protected String	illegalMethodModifiersString
protected Collection<Integer>	illegalPropertyModifiersList
protected String	illegalPropertyModifiersString

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

IllegalClassMemberRule()

Method Summary

Class	getAstVisitorClass() Each concrete subclass must either set this property or define its own property with the same name
String	getIgnoreMethodNames()
String	getIgnoreMethodsWithAnnotationNames()
groovy.lang.MetaClass	getMetaClass()
String	getName()
int	getPriority()
Object	getProperty(String property)
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	setAllowedFieldModifiers(String allowedFieldModifiers)
void	setAllowedMethodModifiers(String allowedMethodModifiers)
void	setAllowedPropertyModifiers(String allowedPropertyModifiers)
void	setAstVisitorClass(Class value)
void	setIgnoreMethodNames(String value)
void	setIgnoreMethodsWithAnnotationNames(String value)
void	setIllegalFieldModifiers(String illegalFieldModifiers)
void	setIllegalMethodModifiers(String illegalMethodModifiers)
void	setIllegalPropertyModifiers(String illegalPropertyModifiers)
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)

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, createViolation, createViolation, createViolation, createViolationForImport, createViolationForImport, createViolationForImport, getApplyToFileNames, getApplyToFilesMatching, getCompilerPhase, 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

Field Detail

illegalFieldModifiersList

protected Collection<Integer> illegalFieldModifiersList

illegalFieldModifiersString

protected String illegalFieldModifiersString

allowedFieldModifiersList

protected Collection<Integer> allowedFieldModifiersList

allowedFieldModifiersString

protected String allowedFieldModifiersString

illegalPropertyModifiersList

protected Collection<Integer> illegalPropertyModifiersList

illegalPropertyModifiersString

protected String illegalPropertyModifiersString

allowedPropertyModifiersList

protected Collection<Integer> allowedPropertyModifiersList

allowedPropertyModifiersString

protected String allowedPropertyModifiersString

illegalMethodModifiersList

protected Collection<Integer> illegalMethodModifiersList

illegalMethodModifiersString

protected String illegalMethodModifiersString

allowedMethodModifiersList

protected Collection<Integer> allowedMethodModifiersList

allowedMethodModifiersString

protected String allowedMethodModifiersString

Constructor Detail

IllegalClassMemberRule

public IllegalClassMemberRule()

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.

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)

getIgnoreMethodNames

public String getIgnoreMethodNames()

setIgnoreMethodNames

public void setIgnoreMethodNames(String value)

getIgnoreMethodsWithAnnotationNames

public String getIgnoreMethodsWithAnnotationNames()

setIgnoreMethodsWithAnnotationNames

public void setIgnoreMethodsWithAnnotationNames(String value)

setIllegalFieldModifiers

public void setIllegalFieldModifiers(String illegalFieldModifiers)

setAllowedFieldModifiers

public void setAllowedFieldModifiers(String allowedFieldModifiers)

setIllegalPropertyModifiers

public void setIllegalPropertyModifiers(String illegalPropertyModifiers)

setAllowedPropertyModifiers

public void setAllowedPropertyModifiers(String allowedPropertyModifiers)

setIllegalMethodModifiers

public void setIllegalMethodModifiers(String illegalMethodModifiers)

setAllowedMethodModifiers

public void setAllowedMethodModifiers(String allowedMethodModifiers)

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