Class IndentationRule

java.lang.Object
org.codenarc.rule.AbstractRule
org.codenarc.rule.AbstractAstVisitorRule
org.codenarc.rule.formatting.IndentationRule
All Implemented Interfaces:
groovy.lang.GroovyObject, Rule
public class IndentationRule extends AbstractAstVisitorRule implements groovy.lang.GroovyObject

  • Field Details

    • classNodeIndentLevels

      protected final Map<SourceCode, Map<org.codehaus.groovy.ast.ClassNode, Integer>> classNodeIndentLevels

  • Constructor Details

    • IndentationRule

      public IndentationRule()

  • 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.

    • 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)

    • getSpacesPerIndentLevel

      public int getSpacesPerIndentLevel()

    • setSpacesPerIndentLevel

      public void setSpacesPerIndentLevel(int value)

    • applyTo

      public void applyTo(SourceCode sourceCode, List<Violation> violations)
      Description copied from class: AbstractRule
      Apply this rule to the specified source and return a list of violations (or an empty List)
      Overrides:
      applyTo in class AbstractAstVisitorRule
      Parameters:
      sourceCode - - the source to apply this rule to
      violations - - the List of violations to which new violations from this rule are to be added