FileResults (CodeNarc 2.2.0 API)

org.codenarc.results.FileResults

All Implemented Interfaces and Traits:

Results
```
@java.lang.SuppressWarnings('UnusedMethodParameter')
class FileResults
extends java.lang.Object
```
Represents the results of applying a set of rules against a single sourcefile
Authors:
Chris Mair

Constructor Summary

Constructors
Constructor and description
`FileResults (java.lang.String path, java.util.List violations)`
`FileResults (java.lang.String path, java.util.List violations, SourceCode sourceCode)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Results`	`findResultsForPath(java.lang.String path)` Return the Results object with the specified path.
	`java.util.List`	`getChildren()` Return an empty List
	`int`	`getNumberOfFilesWithViolations(int maxPriority, boolean recursive = true)` Return 1 if these results include at least one violation
	`int`	`getNumberOfViolationsWithPriority(int priority, boolean recursive = true)` @param recursive - ignored
	`java.lang.String`	`getPath()` @return the path to the file or directory associated with these results
	`java.util.List`	`getRawViolations()` Not intended for general use
	`int`	`getTotalNumberOfFiles(boolean recursive = true)` Return the total number of (Groovy) files analyzed
	`java.util.List`	`getViolations()` @return the List of all violations
	`boolean`	`isFile()` @return true (this object represents the results for a single file)
	`void`	`removeViolation(Violation v)`
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - FileResults(java.lang.String path, java.util.List violations)
  - FileResults(java.lang.String path, java.util.List violations, SourceCode sourceCode)
- Method Detail
  - @java.lang.Override Results findResultsForPath(java.lang.String path)
    
    Return the Results object with the specified path.
    Parameters:
    path - - the path to search for
    Returns:
    this Results object if the path matches, otherwise null
  - @java.lang.Override java.util.List getChildren()
    
    Return an empty List
    Returns:
    the List of child Results objects; may be empty
  - int getNumberOfFilesWithViolations(int maxPriority, boolean recursive = true)
    
    Return 1 if these results include at least one violation
    Parameters:
    maxPriority - - the maximum priority level; ignore violations with priority greater than this
    recursive - - ignored
    Returns:
    the number of files containing violations
  - int getNumberOfViolationsWithPriority(int priority, boolean recursive = true)
    
    Parameters:
    recursive - - ignored
    Returns:
    the number of violations with the specified priority
  - @java.lang.Override java.lang.String getPath()
    
    Returns:
    the path to the file or directory associated with these results
  - java.util.List getRawViolations()
    
    Not intended for general use
  - int getTotalNumberOfFiles(boolean recursive = true)
    
    Return the total number of (Groovy) files analyzed
    Parameters:
    recursive - - ignored
    Returns:
    the total number of files (with or without violations)
  - @java.lang.Override java.util.List getViolations()
    
    Returns:
    the List of all violations
  - @java.lang.Override boolean isFile()
    
    Returns:
    true (this object represents the results for a single file)
  - @java.lang.Override void removeViolation(Violation v)
  - @java.lang.Override java.lang.String toString()

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class FileResults

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

FileResults(java.lang.String path, java.util.List violations)

FileResults(java.lang.String path, java.util.List violations, SourceCode sourceCode)

Method Detail

@java.lang.Override Results findResultsForPath(java.lang.String path)

@java.lang.Override java.util.List getChildren()

int getNumberOfFilesWithViolations(int maxPriority, boolean recursive = true)

int getNumberOfViolationsWithPriority(int priority, boolean recursive = true)

@java.lang.Override java.lang.String getPath()

java.util.List getRawViolations()

int getTotalNumberOfFiles(boolean recursive = true)

@java.lang.Override java.util.List getViolations()

@java.lang.Override boolean isFile()

@java.lang.Override void removeViolation(Violation v)

@java.lang.Override java.lang.String toString()