Interface ICCFlowPoint
- All Superinterfaces:
Comparable<ICCFlowPoint>,ICCBase,ICCBranchData,ICCCoverageData,ICCCoverageDataBasic,ICCPercentItem,ICCSource,ICCStatementData,ICCStatementDataBasic,ICCTreeItem
- All Known Subinterfaces:
ICCImportFlowPoint
public interface ICCFlowPoint
extends ICCTreeItem, ICCCoverageData, ICCStatementData, ICCBranchData, ICCSource, Comparable<ICCFlowPoint>
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. This means that flowpoints will be returned in the order that they appear in the flowpoint
This also affects the ICCTreeItem.getChildren()- Since:
- 3.1
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final byteFlowpoint is a branch seegetType()static final byteseegetType()static final byteseegetType()static final byteseegetType()static final byteseegetType()static final byteseegetType()static final StringProperty for details of the flowpoint (v2)static final byteRepresents an %INCLUDE statement This can represent coverage of a file(s) specified by the include statementstatic final byteFlowpoint is a java class seegetType()static final byteFlowpoint is a java constructor seegetType()static final byteFlowpoint is a java method seegetType()static final byteFlowpoint is a java static initializer seegetType()static final byteFlowpoint type is not defined
seegetType()static final bytegetName(byte)option to return name qualifiedstatic final charCharacter used when qualifying a flowpoint when using theQUALIFIEDoptionstatic final bytegetName(byte)option to return name in uppercaseFields inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCCoverageDataBasic
EMPTYTESTCASESFields inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCSource
SOURCE_OBJECT -
Method Summary
Modifier and TypeMethodDescriptionReturns the ICCFile that contains this flowpointReturns nested flow points New in v9: The flowpoints will be sorted by the first line number, prior to this the order returned was undefinedintReturns the language of the flowpoint SeeICCConstantsfor language valuesintThis will return the last line of the flowpoint If line filtering has been applied then this will represent the last line that was not filteredintgetLine()This will return the first line of the flowpoint If line filtering has been applied then this will represent the first line that was not filteredgetName(byte options) Returns the flowpoint name with options UseICCBase.getName()to return the flowpoint name.intReturns the number of executable blocks for the flowpoint.intReturns the number of executed blocks for the flowpoint.Returns the parent flowpoint.bytegetType()Returns the type of flowpoint.booleanReturns true if there are nested flow pointsMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCBase
addEncodedMessage, addMessage, addMessage, getDecodedMessages, getDecodedMessages, getID, getMessages, getName, getProperties, getProperty, getProperty, isMessage, isProperty, setName, setProperty, updatePropertyMethods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCBranchData
getBranchPoint, getBranchPoint, getBranchPoints, getEncodedFormatMethods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCCoverageData
getHitLines, getLines, getTestcases, isHit, removeTestcaseMethods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCCoverageDataBasic
getNumExecutableLines, getNumFlowPoints, getNumHitFlowPoints, getNumHitLines, getTestcases, isHitMethods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCPercentItem
getPercentCoverageMethods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCSource
getEncoding, getFile, getFile, getFileName, getProperty, getResult, getStream, getStream, isExternal, isSourceAvailable, setProperty, setSourceAvailable, updateFileMethods inherited from interface com.ibm.debug.pdt.codecoverage.core.results.ICCStatementData
getHitStatements, getLastStatement, getStatement, getStatement, getStatements, getStatements, getTestcases, isHitMethods 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
-
Field Details
-
UPPERCASE
static final byte UPPERCASEgetName(byte)option to return name in uppercase- Since:
- 9.0
- See Also:
-
QUALIFIED
static final byte QUALIFIEDgetName(byte)option to return name qualified- Since:
- 9.0
- See Also:
-
QUALIFIER
static final char QUALIFIERCharacter used when qualifying a flowpoint when using theQUALIFIEDoption- Since:
- 9.0
- See Also:
-
NOT_DEFINED
static final byte NOT_DEFINEDFlowpoint type is not defined
seegetType()- Since:
- 9.0
- See Also:
-
COBOL_PARAGRAPH
static final byte COBOL_PARAGRAPHseegetType()- Since:
- 9.0
- See Also:
-
COBOL_SECTION
static final byte COBOL_SECTIONseegetType()- Since:
- 9.0
- See Also:
-
COBOL_PROGRAM_ID
static final byte COBOL_PROGRAM_IDseegetType()- Since:
- 9.0
- See Also:
-
COBOL_ENDPROGRAM
static final byte COBOL_ENDPROGRAMseegetType()- Since:
- 9.0
- See Also:
-
BRANCH
static final byte BRANCHFlowpoint is a branch seegetType()- Since:
- 9.0
- See Also:
-
JAVA_CLASS
static final byte JAVA_CLASSFlowpoint is a java class seegetType()- Since:
- 9.0
- See Also:
-
JAVA_METHOD
static final byte JAVA_METHODFlowpoint is a java method seegetType()- Since:
- 9.0
- See Also:
-
JAVA_CONSTRUCTOR
static final byte JAVA_CONSTRUCTORFlowpoint is a java constructor seegetType()- Since:
- 9.0
- See Also:
-
JAVA_STATIC_INITIALIZER
static final byte JAVA_STATIC_INITIALIZERFlowpoint is a java static initializer seegetType()- Since:
- 10.0
- See Also:
-
INCLUDE_FILE
static final byte INCLUDE_FILERepresents an %INCLUDE statement This can represent coverage of a file(s) specified by the include statement- Since:
- 10.1
- See Also:
-
COBOL_USER_DEFINED_FUNCTION
static final byte COBOL_USER_DEFINED_FUNCTIONseegetType()- Since:
- 12.0
- See Also:
-
DETAILS_PROP
Property for details of the flowpoint (v2)- Since:
- 10.1
- See Also:
-
-
Method Details
-
getLine
int getLine()This will return the first line of the flowpoint If line filtering has been applied then this will represent the first line that was not filtered -
getLastLine
int getLastLine()This will return the last line of the flowpoint If line filtering has been applied then this will represent the last line that was not filtered- Returns:
- the last line of the flow point
-
isNestedFlowPoints
boolean isNestedFlowPoints()Returns true if there are nested flow points- Returns:
- true if contains nested flow points
-
getFlowPoints
ICCFlowPoint[] getFlowPoints()Returns nested flow points New in v9: The flowpoints will be sorted by the first line number, prior to this the order returned was undefined- Returns:
- zero or more flowpoints that are nested in this flowpoint
-
getParentFlowPoint
ICCFlowPoint getParentFlowPoint()Returns the parent flowpoint.nullindicates this is a root flowpoint- Returns:
- the parent flowpoint
- Since:
- 4.0
-
getName
Returns the flowpoint name with options UseICCBase.getName()to return the flowpoint name. Use this method to return the name with options. Options can be bitwise OR'd to produce a result with > 1 option- Parameters:
options-
QUALIFIEDThe flowpoint name will be fully qualified based on the hierarchy of the flowpoints. e.g. for COBOL the qualifier is '.' and the flowpoint name will be qualified by program ID and section (depending on the structure of the program) For some languages the qualifier option may have no effect
UPPERCASEThe name is returned in upper case using the current locale e.g. For COBOL this may be needed if the information provided by other tools upper cases language artifacts- Returns:
- flowpoint name
- Since:
- 9.0
-
getType
byte getType()Returns the type of flowpoint. Default isNOT_DEFINEDAs of this version the COBOL types are defined but importers can assign any value. Since the type of flowpoint is associated with the language of theICCFile, importers can use any value. Exporters that know about the language can then use the value. This interface now supports returning the language seegetLanguage()The combination of language and type guarantees a unique flowpoint- Returns:
- type of flowpoint
- Since:
- 9.0
-
getCCFile
ICCFile getCCFile()Returns the ICCFile that contains this flowpoint- Returns:
- file that contains this flowpoint
- Since:
- 9.0
-
getLanguage
int getLanguage()Returns the language of the flowpoint SeeICCConstantsfor language values- Specified by:
getLanguagein interfaceICCSource- Returns:
- language of flowpoint
- Since:
- 9.0
-
getNumHitBlocks
int getNumHitBlocks()Returns the number of executed blocks for the flowpoint.- Returns:
- number of executed blocks.
- Since:
- 10.0
-
getNumExecutableBlocks
int getNumExecutableBlocks()Returns the number of executable blocks for the flowpoint.- Returns:
- number of executable blocks.
- Since:
- 10.0
-