Package 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
Fields Modifier and Type Field Description protected java.util.Collection<java.lang.Integer>
allowedFieldModifiersList
protected java.lang.String
allowedFieldModifiersString
protected java.util.Collection<java.lang.Integer>
allowedMethodModifiersList
protected java.lang.String
allowedMethodModifiersString
protected java.util.Collection<java.lang.Integer>
allowedPropertyModifiersList
protected java.lang.String
allowedPropertyModifiersString
protected java.util.Collection<java.lang.Integer>
illegalFieldModifiersList
protected java.lang.String
illegalFieldModifiersString
protected java.util.Collection<java.lang.Integer>
illegalMethodModifiersList
protected java.lang.String
illegalMethodModifiersString
protected java.util.Collection<java.lang.Integer>
illegalPropertyModifiersList
protected java.lang.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
Constructors Constructor Description IllegalClassMemberRule()
-
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
getIgnoreMethodNames()
java.lang.String
getIgnoreMethodsWithAnnotationNames()
groovy.lang.MetaClass
getMetaClass()
java.lang.String
getName()
int
getPriority()
java.lang.Object
getProperty(java.lang.String property)
java.lang.Object
invokeMethod(java.lang.String method, java.lang.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(java.lang.String allowedFieldModifiers)
void
setAllowedMethodModifiers(java.lang.String allowedMethodModifiers)
void
setAllowedPropertyModifiers(java.lang.String allowedPropertyModifiers)
void
setAstVisitorClass(java.lang.Class value)
void
setIgnoreMethodNames(java.lang.String value)
void
setIgnoreMethodsWithAnnotationNames(java.lang.String value)
void
setIllegalFieldModifiers(java.lang.String illegalFieldModifiers)
void
setIllegalMethodModifiers(java.lang.String illegalMethodModifiers)
void
setIllegalPropertyModifiers(java.lang.String illegalPropertyModifiers)
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)
-
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, setApplyToFileNames, setApplyToFilesMatching, setDescription, setDoNotApplyToFileNames, setDoNotApplyToFilesMatching, setEnabled, setViolationMessage, toString, validate
-
-
-
-
Field Detail
-
illegalFieldModifiersList
protected java.util.Collection<java.lang.Integer> illegalFieldModifiersList
-
illegalFieldModifiersString
protected java.lang.String illegalFieldModifiersString
-
allowedFieldModifiersList
protected java.util.Collection<java.lang.Integer> allowedFieldModifiersList
-
allowedFieldModifiersString
protected java.lang.String allowedFieldModifiersString
-
illegalPropertyModifiersList
protected java.util.Collection<java.lang.Integer> illegalPropertyModifiersList
-
illegalPropertyModifiersString
protected java.lang.String illegalPropertyModifiersString
-
allowedPropertyModifiersList
protected java.util.Collection<java.lang.Integer> allowedPropertyModifiersList
-
allowedPropertyModifiersString
protected java.lang.String allowedPropertyModifiersString
-
illegalMethodModifiersList
protected java.util.Collection<java.lang.Integer> illegalMethodModifiersList
-
illegalMethodModifiersString
protected java.lang.String illegalMethodModifiersString
-
allowedMethodModifiersList
protected java.util.Collection<java.lang.Integer> allowedMethodModifiersList
-
allowedMethodModifiersString
protected java.lang.String allowedMethodModifiersString
-
-
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.
-
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)
-
getIgnoreMethodNames
public java.lang.String getIgnoreMethodNames()
-
setIgnoreMethodNames
public void setIgnoreMethodNames(java.lang.String value)
-
getIgnoreMethodsWithAnnotationNames
public java.lang.String getIgnoreMethodsWithAnnotationNames()
-
setIgnoreMethodsWithAnnotationNames
public void setIgnoreMethodsWithAnnotationNames(java.lang.String value)
-
setIllegalFieldModifiers
public void setIllegalFieldModifiers(java.lang.String illegalFieldModifiers)
-
setAllowedFieldModifiers
public void setAllowedFieldModifiers(java.lang.String allowedFieldModifiers)
-
setIllegalPropertyModifiers
public void setIllegalPropertyModifiers(java.lang.String illegalPropertyModifiers)
-
setAllowedPropertyModifiers
public void setAllowedPropertyModifiers(java.lang.String allowedPropertyModifiers)
-
setIllegalMethodModifiers
public void setIllegalMethodModifiers(java.lang.String illegalMethodModifiers)
-
setAllowedMethodModifiers
public void setAllowedMethodModifiers(java.lang.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 classAbstractRule
- Returns:
- true if all preconditions for this rule are satisfied
-
-