Rule (CodeNarc 3.3.0 API)

Summary:
Method

| Detail:
Method

```
public interface Rule
```
Represents a source code analysis rule .
Authors:
Chris Mair

Methods Summary

Methods
Type Params	Return Type	Name and description
	`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)
	`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`	`getName()` Returns: the unique id for this rule
	`public int`	`getPriority()` Returns: the priority of this rule; must be 1, 2 or 3

- Method Detail
  - 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)
    throws:
    Throwable could throw anything
    
    Parameters:
    sourceCode - - the source to apply this rule to
    Returns:
    the List of violations; may be empty
  - 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 getName()
    
    Returns:
    the unique id for this rule
  - public int getPriority()
    
    Returns:
    the priority of this rule; must be 1, 2 or 3

Summary:
Method

| Detail:
Method

Groovy Documentation