All Classes and Interfaces
Class
Description
Implementation of a CC exception that supports encoded messages
use
Throwable.getMessage() to retrieve the message full text
use CCAbstractException.getEncodedMessage() to retrieve the message in encoded formA base implementation of
ICCExporterInfo that represents information about the export operation
Messages and properties can be set that indicate problems or informational messages encountered during the exportBase implementation of ImportInput
Implements most of the methods that support storing messages and properties
Base implementation of
ICCBase.Base implementation of a result modifier
Extend this class and override the modify method(s)
See
CCResultsModifierFactory for implemented filtersBase implementation of a CC item that is part of a tree hierarchy
Exception indicates that a branch point already exists
Exception thrown when adding a testcase that already exists
Implementation of an empty result
This implementation will always be compatible with the latest version of this
API
In v10.1 use CCResultsFactory.getInstance.createEmptyResult() to construct
this class
Common Export Utilities
Creates an exception indicating that the specified file has changed between
the two given results
Represents a mismatch between 2 files
Represents when an item is to be excluded from a code coverage result
This class generates filters
Creates an exception indicating that the specified file is identical between
the two given results
An exception during the import process
If it is available the path being processed should be set in this exception before throwing it
Problems during import of a flowpoint will throw this exception
A detailed message can be obtained from this exception
Common Import Utilities
Exception thrown when an invalid result directory is encountered
Message text contains the name of the invalid directory
Utility methods to obtain label text from API labels
Utility methods to obtain message text from API messages
Represents an exception when a code coverage result modifier was performing an operation
Represents that a problem occurred during import
The exception or exceptions that were encountered can be retrieved using
CCAbstractException.getExceptions()
Each CCImportException will contain information about why and what failed to import
Results that are returned with the exception may not be completeThis class generates a CC Result object
Creates Code Coverage Modifiers
Thrown when the source was not found for the file as part of a code coverage comparison
A list of message constants used by the Code Coverage API.
Note: Code Coverage engines may provide additional messages of their own, which are not included here.
Note: Code Coverage engines may provide additional messages of their own, which are not included here.
Base methods for result artifacts
Represent a filter that includes/excludes any code coverage item
Represents a branch point.
This artifact will compare the passed source with the same named source in this
artifact
Exceptions are thrown if the current artifact doesn't contain source by the same name
The various languages recognized by engines.
Represents a file or listing file in the CC results.
Represents a filter that includes and excludes files from a code coverage report
A general representation for a code coverage filter
Represents a function/subroutine/entry/paragraph in a
ICCFile
For some languages like COBOL this may also represent a paragraph if that information is available
Hit lines are for this flowpoint only and do not include nested flowpoints
New behavior in v9:
The order that flowpoints are returned has been changed from undefined to ordered by the flowpoint's
first line.Represents a filter that will include/exclude flow points from a code coverage result
Currently not supported.
Currently not supported.
Represents a branch point
e.g.
Represents an importer of Code Coverage results
Known implementations of this interface
CompiledCCImporter - accepts a path that can be
a single zip file that contains a complete result directory
a result directory that contains the result files, specifically the .clcoveragedata and .componentMap files
a directory that contains 1 or more zipped results
a directory that contains 1 or more result directories
a directory that contains a mix of zipped results or result directories
Java Importer - accepts a path that can be
a result directory that contains the result files, specifically the .coveragedata and .metadata files
a file that has the .coveragedata or .metadata extension
CC result Importer - accepts a path that can be
a single zip file with the file extension .ccresult
a result directory that contains 1 or more zip files with the file extension .ccresult
An importer will use this to add content about an imported file
Represents a function/entry/paragraph in a file
Used during import to set values
Represents an artifact that is a parent of a flowpoint and therefore
can create one as its child
In v9 flowpoints must have a valid first line number.
Represents information about artifacts that were imported or where an import was attempted
This interface serves the following purposes:
1) During the discovery phase it represents that the importer found valid data that can be used to do an import
2) Can be returned with
ICCImportInput.isValidForImport() set to false to indicate that import is not supported but with error messages
indicating why.A result that is used during import to set values
In v9 of the ccapi statement/branch/module/part support has been added or improved
Represents a statement that can be updated.
Implementors can create an
ICCImportStatement
Implementors must all add the statement to the artifact after it has been successfully createdAn imported test or testcase
Represents a filter that include/excludes lines in a code coverage report based on their content
Represents a filter that includes/excludes lines in a code coverage result
A very general representation of a modifier of code coverage data
Represents a module (typically the result of a link step) for compiled languages
Contains
ICCPartItems that have a percentages
Represents one or more CC results.
Result info, fields with information about the result(s)
Represents a code coverage result modifier
Implementors of this interface declare that they support source in some form It may be source or listing depending on
the origin of the code coverage data
Represents a statement.
Implemented by artifacts that support statement level data
Statements are represented as
ICCStatement
If statement level information is NOT available then a line is
considered to have 1 statementArtifacts that implement this interface return basic statement coverage data
Represents a test or testcase
This interface is used to query a testcase
Represents an item that has a hierarchy.
This illustrates imported data in one format (could be a .clcoveragedata file)
and exporting it to the "merged" cczip format
If using a command line then enter the following
java -cp ".;./plugins/com.ibm.debug.pdt.codecoverage.core.results_<version>/lib/ccapi.jar" samples.TestExportDriver
"path_to_output_file"
"one or more paths to the input cc data files"Illustrates how to retrieve the contents of a file from the cc data
This will only work if the source/listing was saved at the time of capture
If using a command line then enter the following
java -cp ".;".;./plugins/com.ibm.debug.pdt.codecoverage.core.results_<version>/lib/ccapi.jar" " samples.TestFileStream "path to cc
data file or directory" Illustrates how obtain code coverage data from one or more files that are passed in
as arguments to main()
If using a command line then enter the following
java -cp ".;".;./plugins/com.ibm.debug.pdt.codecoverage.core.results_<version>/lib/ccapi.jar" .jar" samples.TestResultDriver "path to cc
data file or directory"