Package org.codenarc.rule.generic

Class IllegalClassMemberRule

  • All Implemented Interfaces:
    groovy.lang.GroovyObject, Rule
    public class IllegalClassMemberRule
extends AbstractAstVisitorRule
implements groovy.lang.GroovyObject

    • 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

    • 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 java.lang.Object invokeMethod​(java.lang.String method,
                                     java.lang.Object arguments)
        Specified by:
        invokeMethod in interface groovy.lang.GroovyObject

      • getProperty

        public java.lang.Object getProperty​(java.lang.String property)
        Specified by:
        getProperty in interface groovy.lang.GroovyObject

      • setProperty

        public void setProperty​(java.lang.String property,
                        java.lang.Object value)
        Specified by:
        setProperty in interface groovy.lang.GroovyObject

      • getName

        public java.lang.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​(java.lang.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.

      • 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 class AbstractRule
        Returns:
        true if all preconditions for this rule are satisfied