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

org.codenarc.results
[Groovy] Class DirectoryResults

java.lang.Object
  org.codenarc.results.DirectoryResults
All Implemented Interfaces:
Results
class DirectoryResults

Represents the results for a directory

Authors:
Chris Mair
Version:
\$Revision: 439 \$ - \$Date: 2010-11-08 15:16:30 -0500 (Mon, 08 Nov 2010) \$

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()

@return the List of child Results objects; may be empty
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()

@return the path to the file or directory associated with these results
int getTotalNumberOfFiles(boolean recursive = true)

Return the total number of (Groovy) files analyzed
List getViolationsWithPriority(int priority)

@return the List of violations with the specified priority; may be empty
boolean isFile()

@return false (this object does not represents the results for a single file)
String toString()

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

Property Detail

numberOfFilesInThisDirectory

int numberOfFilesInThisDirectory

 
Constructor Detail

DirectoryResults

DirectoryResults()
Create a new uninitialized instance

DirectoryResults

DirectoryResults(String path)
Create a new instance with the specified path
Parameters:
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.
Parameters:
path - - the path to search for
Returns:
this Results object if a match is found, otherwise null

getChildren

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

getNumberOfFilesWithViolations

int getNumberOfFilesWithViolations(boolean recursive = true)
Return the number of files with violations
Parameters:
recursive - - true if the returned count should include subdirectories as well; defaults to true
Returns:
the number of files containing violations

getNumberOfViolationsWithPriority

int getNumberOfViolationsWithPriority(int priority, boolean recursive = true)
Return the number of violations with the specified priority
Parameters:
recursive - - true if the returned count should include subdirectories as well; defaults to true
Returns:
the number of violations with the specified priority

getPath

String getPath()
Returns:
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
Parameters:
recursive - - true if the returned count should include subdirectories as well
Returns:
the total number of files (with or without violations)

getViolationsWithPriority

List getViolationsWithPriority(int priority)
Returns:
the List of violations with the specified priority; may be empty

isFile

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

toString

String toString()

 

Groovy Documentation