Module html.CoverageData.FileSystemEntry
Info:
- Copyright: 2020 wesen
- Release: 0.1
- License: MIT
- Author: wesen
Class FileSystemEntry
| FileSystemEntry.baseName | The base name of the file system entry |
| FileSystemEntry.parentDirectoryCoverageData | The coverage data of the parent directory |
| FileSystemEntry.hitMissStatistics | The hit/miss statistics for the file system entry |
| FileSystemEntry:new (_baseName, _parentDirectoryCoverageData) | FileSystemEntry constructor. |
| FileSystemEntry:getBaseName () | Returns the base name of the file system entry. |
| FileSystemEntry:getParentDirectoryCoverageData () | Returns the coverage data of the parent directory. |
| FileSystemEntry:getHitMissStatistics () | Returns the hit/miss statistics for the file system entry. |
| FileSystemEntry:calculatePathDirectoryCoverages (_includeRoot, _includeSelf) | Calculates and returns all directory coverages between this file system entry and the root coverage directory. |
| FileSystemEntry:calculateFullPath (_includeRoot) | Calculates and returns the full path of this file system entry relative from the root coverage directory. |
| FileSystemEntry:addHitMissStatistics (_numberOfHits, _numberOfMisses) | Adds hit/miss statistics to this FileSystemEntry and all of its parent directory coverages. |
Class FileSystemEntry
Base class for coverages of file system entries (directories or files).
- FileSystemEntry.baseName
-
The base name of the file system entry
- baseName string
- FileSystemEntry.parentDirectoryCoverageData
-
The coverage data of the parent directory
- parentDirectoryCoverageData Directory
- FileSystemEntry.hitMissStatistics
-
The hit/miss statistics for the file system entry
- hitMissStatistics HitMissStatistics
- FileSystemEntry:new (_baseName, _parentDirectoryCoverageData)
-
FileSystemEntry constructor.
Parameters:
- _baseName string The base name of the file system entry
- _parentDirectoryCoverageData Directory The coverage data of the parent directory
- FileSystemEntry:getBaseName ()
-
Returns the base name of the file system entry.
Returns:
-
string
The base name
- FileSystemEntry:getParentDirectoryCoverageData ()
-
Returns the coverage data of the parent directory.
Returns:
-
Directory
The coverage data of the parent directory
- FileSystemEntry:getHitMissStatistics ()
-
Returns the hit/miss statistics for the file system entry.
Returns:
-
HitMissStatistics
The hit/miss statistics
- FileSystemEntry:calculatePathDirectoryCoverages (_includeRoot, _includeSelf)
-
Calculates and returns all directory coverages between this file system entry and
the root coverage directory.
The directory coverages are ordered ascending by their distance to the root coverage directory.
Parameters:
- _includeRoot bool True to include the root directory coverage in the list, false otherwise
- _includeSelf bool True to include this FileSystemEntry in the list (used for recursion)
Returns:
-
Directory[]
The directory coverages
- FileSystemEntry:calculateFullPath (_includeRoot)
-
Calculates and returns the full path of this file system entry relative from the root coverage directory.
Parameters:
- _includeRoot bool True to include the root directory in the path, false otherwise
Returns:
-
string
The calculated path
- FileSystemEntry:addHitMissStatistics (_numberOfHits, _numberOfMisses)
-
Adds hit/miss statistics to this FileSystemEntry and all of its parent directory coverages.
Parameters:
- _numberOfHits int The number of hit lines to add
- _numberOfMisses int The number of missed lines to add