Groovy Documentation

org.codenarc.results
Class DirectoryResults

java.lang.Object
  org.codenarc.results.DirectoryResults

class DirectoryResults

Represents the results for a directory

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


Property Summary
int numberOfFilesInThisDirectory

 
Constructor Summary
DirectoryResults()

Create a new uninitialized instance

DirectoryResults(String path)

Create a new instance with the specified path

 
Method Summary
void addChild(Results child)

Results findResultsForPath(String path)

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

List getChildren()

int getNumberOfFilesWithViolations(boolean recursive = true)

Return the number of files with violations

int getNumberOfViolationsWithPriority(int priority, boolean recursive = true)

Return the number of violations with the specified priority

String getPath()

int getTotalNumberOfFiles(boolean recursive = true)

Return the total number of (Groovy) files analyzed

List getViolationsWithPriority(int priority)

boolean isFile()

String toString()

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Property Detail

numberOfFilesInThisDirectory

int numberOfFilesInThisDirectory


 
Constructor Detail

DirectoryResults

public DirectoryResults()
Create a new uninitialized instance


DirectoryResults

public DirectoryResults(String path)
Create a new instance with the specified path
param:
path - the path


 
Method Detail

addChild

void addChild(Results child)


findResultsForPath

Results findResultsForPath(String path)
Return the Results object with the specified path within this directory 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 = true)
Return the number of files with violations
param:
recursive - true if the returned count should include subdirectories as well; defaults to true
return:
the number of files containing violations


getNumberOfViolationsWithPriority

int getNumberOfViolationsWithPriority(int priority, boolean recursive = true)
Return the number of violations with the specified priority
param:
recursive - true if the returned count should include subdirectories as well; defaults to true
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 = true)
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; may be empty


isFile

boolean isFile()
return:
false (this object does not represents the results for a single file)


toString

String toString()


 

Groovy Documentation