Interface ICCFlowPoint

All Superinterfaces:
Comparable<ICCFlowPoint>, ICCBase, ICCBranchData, ICCCoverageData, ICCCoverageDataBasic, ICCPercentItem, ICCSource, ICCStatementData, ICCStatementDataBasic, ICCTreeItem
All Known Subinterfaces:
ICCImportFlowPoint

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 Details

  • 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
      Specified by:
      getLine in interface ICCSource
      Returns:
      the first line of the flow point in the file
    • 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. null indicates this is a root flowpoint
      Returns:
      the parent flowpoint
      Since:
      4.0
    • getName

      String getName(byte options)
      Returns the flowpoint name with options Use ICCBase.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 -
      QUALIFIED The 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
      UPPERCASE The 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 is NOT_DEFINED As 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 the ICCFile, importers can use any value. Exporters that know about the language can then use the value. This interface now supports returning the language see getLanguage() 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 See ICCConstants for language values
      Specified by:
      getLanguage in interface ICCSource
      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