Method Detail

• public abstract void applyTo(SourceCode sourceCode, java.util.List<Violation> violations)

  Apply this rule to the specified source and return a list of violations (or an empty List)

  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

• public java.util.List<Violation> applyTo(SourceCode sourceCode)

  Apply this rule to the specified source and return a list of violations (or an empty List). This implementation delegates to the abstract applyCode(SourceCode,List), provided by concrete subclasses. This template method simplifies subclass implementations and also enables common handling of enablement logic.

  Parameters:

  sourceCode - - the source to apply this rule to

  Returns:

  the List of violations; may be empty

• protected Violation createViolation(java.lang.Integer lineNumber, java.lang.String sourceLine, java.lang.String message)

  Create and return a new Violation for this rule and the specified values

  Parameters:

  lineNumber - - the line number for the violation; may be null

  sourceLine - - the source line for the violation; may be null

  message - - the message for the violation; may be null

  Returns:

  a new Violation object

• protected Violation createViolation(SourceCode sourceCode, ASTNode node, java.lang.String message)

  Create a new Violation for the AST node.

  Parameters:

  sourceCode - - the SourceCode

  node - - the Groovy AST Node

  message - - the message for the violation; defaults to null

• protected Violation createViolationForImport(SourceCode sourceCode, org.codehaus.groovy.ast.ImportNode importNode, java.lang.String message)

  Create and return a new Violation for this rule and the specified import

  Parameters:

  sourceCode - - the SourceCode

  importNode - - the ImportNode for the import triggering the violation

  Returns:

  a new Violation object

• protected Violation createViolationForImport(SourceCode sourceCode, java.lang.String className, java.lang.String alias, java.lang.String violationMessage)

  Create and return a new Violation for this rule and the specified import className and alias

  Parameters:

  sourceCode - - the SourceCode

  className - - the class name (as specified within the import statement)

  alias - - the alias for the import statement

  violationMessage - - the violation message; may be null

  Returns:

  a new Violation object

• public java.lang.String getApplyToFileNames()

• public java.lang.String getApplyToFilesMatching()

• public int getCompilerPhase()

  Returns:

  the required compiler phase (as in org.codehaus.groovy.control.Phases) of the AST of the SourceCode handed to the rule via applyTo(SourceCode sourceCode)

• public java.lang.String getDescription()

• public java.lang.String getDoNotApplyToFileNames()

• public java.lang.String getDoNotApplyToFilesMatching()

• public abstract java.lang.String getName()

  Returns:

  the unique name for this rule

• public abstract int getPriority()

  Returns:

  the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.

• public java.lang.String getViolationMessage()

• public boolean isEnabled()

• public boolean isReady()

  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.

  Returns:

  true if all preconditions for this rule are satisfied

• public void setApplyToFileNames(java.lang.String applyToFileNames)

• public void setApplyToFilesMatching(java.lang.String applyToFilesMatching)

• public void setDescription(java.lang.String description)

• public void setDoNotApplyToFileNames(java.lang.String doNotApplyToFileNames)

• public void setDoNotApplyToFilesMatching(java.lang.String doNotApplyToFilesMatching)

• public void setEnabled(boolean enabled)

• public abstract void setName(java.lang.String name)

  Set the unique name for this rule

  Parameters:

  name - - the name for this rule; this should be unique

• public abstract void setPriority(int priority)

  Set the priority for this rule

  Parameters:

  priority - - the priority of this rule, between 1 (highest priority) and 3 (lowest priority), inclusive.

• public void setViolationMessage(java.lang.String violationMessage)

• public java.lang.String toString()

• public void validate()

  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.