Interface ICCImportResult
- All Superinterfaces:
ICCBase,ICCCompareSource,ICCConstants,ICCCoverageDataBasic,ICCPercentItem,ICCResult,ICCStatementDataBasic,ICCTreeItem
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
- Since:
- 3.1
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCCompareSource
ICCCompareSource.MARKERTYPENested classes/interfaces inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCConstants
ICCConstants.COVERAGE_LEVEL, ICCConstants.COVERAGE_VIEW -
Field Summary
Fields inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCConstants
DATE_FORMAT, LANG_A, LANG_ALP_ASM, LANG_B, LANG_C, LANG_CL_400, LANG_COBOL, LANG_COBOL_COPYBOOK, LANG_CPP, LANG_FORTRAN, LANG_GCJ, LANG_JAVA, LANG_JAVASCRIPT, LANG_OPM_RPG, LANG_PLI, LANG_PLX, LANG_PLX86, LANG_RPG, LANG_SYSTEM, LANG_UNKNOWN, LANG_UPC, LANG_X10, LANGUAGE_DISPLAY_NAMES, RESULT_ERROR, RESULT_OK, RESULT_WARNINGFields inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCCoverageDataBasic
EMPTYTESTCASESFields inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCResult
EXCLUDE_ZEROLINES -
Method Summary
Modifier and TypeMethodDescriptionvoidaddElapsedTime(long time) Add elapsed time from each result that is imported.voidaddItem(ICCTreeItem item, String uuid) Adds an item to this result indexed by the UUIDcreateFile(String name) Creates and returns a file that is used during import For some languages the file is the root.createModule(String name) Creates and returns a module that represents a container for compiled objects (parts)createPart(String name, ICCImportModule module) Creates and returns a part that represents a compiled object with the module as a parent Parts can also be created usingICCImportModule.createPart(String)Parts can be added to an existing module if they are the same partcreateTestcase(String name, String platformID) Creates and returns a testcase that is used during importcreateTestcase(String name, String platformID, boolean add) Creates and returns a testcase with the option to not include it in the resultsgetTestcase(String name, String platformID) Given a testcase name and platform ID return the existing testcasevoidMarks this result as incompletevoidSets the overall coverage level for this result.voidSet this result as being merged.Methods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCBase
addEncodedMessage, addMessage, addMessage, getDecodedMessages, getDecodedMessages, getID, getMessages, getName, getProperties, getProperty, getProperty, isMessage, isProperty, setProperty, updatePropertyMethods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCCompareSource
getAnnotatedSource, setAnnotatedMarkerMethods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCCoverageDataBasic
getNumExecutableLines, getNumFlowPoints, getNumHitFlowPoints, getNumHitLines, isHitMethods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCPercentItem
getPercentCoverageMethods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCResult
addFilter, clearFilters, getFile, getFile, getFiles, getInfo, getItem, getLevel, getModule, getModules, getNumFiles, getPart, getParts, getPercentCoverage, getStatus, getTestcase, getTestcase, getTestcases, getTestcases, getTestcases, getUnZipDir, isComplete, isMerged, removeTestcase, setName, setUnZipOptionsMethods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCStatementDataBasic
getNumExecutableStatements, getNumHitStatements, hasStatementsMethods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCTreeItem
addChild, addChildren, getChild, getChildren, getNumChildren, getParent, getQualifiedName, getUniqueID, getUUID, isRoot, refresh, setParent, setUUID, supportsUUID
-
Method Details
-
createTestcase
Creates and returns a testcase that is used during import- Parameters:
name- - unique name for the testcaseplatformID- is a unique string that represents the platform the testcase ran on. This allows for the same testcase to run on different platforms and be treated as unique- Returns:
ICCImportTestcase- Throws:
CCImportException- basic import exceptionCCDuplicateTestcaseException- testcase already existsCCModifierException- if it is excluded because of aICCResultModifier
-
createTestcase
ICCImportTestcase createTestcase(String name, String platformID, boolean add) throws CCImportException Creates and returns a testcase with the option to not include it in the results- Parameters:
name- - unique name for the testcaseplatformID- is a unique string that represents the platform the testcase ran on. This allows for the same testcase to run on different platforms and be treated as uniqueadd- - if true the testcase will be created and added to result. If false the testcase will be added (so that it can be processed) but won't be added as a unique testcase- Returns:
ICCImportTestcase- Throws:
CCImportException- basic import exceptionCCDuplicateTestcaseException- testcase already existsCCModifierException- if it is excluded because of aICCResultModifier
-
createFile
Creates and returns a file that is used during import For some languages the file is the root. When a file is owned by a part useICCImportPart.createFile(String)
New behaviour since 4.0 : If an existing file matches the name passedCCFileExistsExceptionwill be thrown, the exception contains the matchingICCImportFile. It is up to the caller to determine if the file returned in the exception really matches.- Parameters:
name- file name- Returns:
ICCImportFile- Throws:
CCImportException- basic import exceptionCCFileExistsException- file already existsCCModifierException- if it is excluded because of aICCResultModifier
-
createModule
Creates and returns a module that represents a container for compiled objects (parts)- Parameters:
name- module name- Returns:
ICCImportModule- Throws:
CCImportException- basic import exceptionCCDuplicateModuleException- module already existsCCModifierException- if it is excluded because of aICCResultModifier- Since:
- 4.0
-
createPart
Creates and returns a part that represents a compiled object with the module as a parent Parts can also be created usingICCImportModule.createPart(String)Parts can be added to an existing module if they are the same part- Parameters:
name- part namemodule- module (required)- Returns:
ICCImportPart- Throws:
CCImportException- basic import exceptionCCDuplicatePartException- part already existsCCModifierException- modifier exception- Since:
- 4.0
-
setLevel
Sets the overall coverage level for this result. During import results may have different levels but the importer should ensure that the results match this level- Parameters:
level-ICCConstants.COVERAGE_LEVEL
-
addElapsedTime
void addElapsedTime(long time) Add elapsed time from each result that is imported. At the end the total elapsed time will be available- Parameters:
time- elapsed time to be added to this result
-
getTestcase
Given a testcase name and platform ID return the existing testcase- Parameters:
name- testcase nameplatformID- platform id to uniquely identify the same testcase that might be run on several platforms- Returns:
ICCImportTestcase
-
setMerged
void setMerged()Set this result as being merged. If this result was created from >1 input results then call this method to indicate that it is a merged result -
setIncomplete
void setIncomplete()Marks this result as incomplete- Since:
- 4.0
-
addItem
Adds an item to this result indexed by the UUID- Parameters:
item- to adduuid- unique ID- Since:
- 10.0
-