Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | METHOD DETAIL: FIELD | METHOD

org.codenarc.results
Interface Results

interface Results

Represents the results of applying rules to one or more source files/directories

author:
Chris Mair
version:
$Revision: 7 $ - $Date: 2009-01-21 21:52:00 -0500 (Wed, 21 Jan 2009) $

Method Summary
Results findResultsForPath(String path)

Return the Results object with the specified path within this results object or its descendents.

List getChildren()

int getNumberOfFilesWithViolations(boolean recursive)

Return the number of files with violations

int getNumberOfViolationsWithPriority(int priority, boolean recursive)

Return the number of violations with the specified priority

String getPath()

int getTotalNumberOfFiles(boolean recursive)

Return the total number of (Groovy) files analyzed

List getViolationsWithPriority(int priority)

Return the List of violations with the specified priority

boolean isFile()

 

Method Detail

findResultsForPath

Results findResultsForPath(String path)
Return the Results object with the specified path within this results object or its descendents.
param:
path - the path to search for
return:
this Results object if a match is found, otherwise null

getChildren

List getChildren()
return:
the List of child Results objects; may be empty

getNumberOfFilesWithViolations

int getNumberOfFilesWithViolations(boolean recursive)
Return the number of files with violations
param:
recursive - true if the returned count should include subdirectories as well
return:
the number of files containing violations

getNumberOfViolationsWithPriority

int getNumberOfViolationsWithPriority(int priority, boolean recursive)
Return the number of violations with the specified priority
param:
priority - the priority
param:
recursive - true if the returned count should include subdirectories as well
return:
the number of violations with the specified priority

getPath

String getPath()
return:
the path to the file or directory associated with these results

getTotalNumberOfFiles

int getTotalNumberOfFiles(boolean recursive)
Return the total number of (Groovy) files analyzed
param:
recursive - true if the returned count should include subdirectories as well
return:
the total number of files (with or without violations)

getViolationsWithPriority

List getViolationsWithPriority(int priority)
Return the List of violations with the specified priority
param:
priority - the priority
return:
the List of violations with the specified priority; may be empty

isFile

boolean isFile()
return:
true only if this object represents the results for a single file

 

Groovy Documentation