Interface ICCStatement

All Superinterfaces:
Comparable<ICCStatement>
All Known Subinterfaces:
ICCImportStatement

public interface ICCStatement extends Comparable<ICCStatement>
Represents a statement. A line can contain 1 or more statements By default a line contains at least 1 statement Each statement can also specify a starting column. Statements end at the next statement or the end of the line
Since:
9.0
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Zero based location on a line Will return zero for all statements on the same line if the column information is not known
    Content of the statement
    int
    End column of the statement This may not be set and will return zero if unknown
    int
    Returns the hit count If hit count is not recorded then returns 1 if the statement was hit
    int
    Relative index of statement on a line zero based...
    int
    Return the line number in the source/listing 1 based ..
    boolean
    Statements can be simple and only contain the line and index This method will return false When additional information like column start end has been set then this method will return true This can be used to optimize storing statement information without having to check if each field has been populated
    boolean
    Returns true if statement was hit

    Methods inherited from interface java.lang.Comparable

    compareTo
  • Method Details

    • getLine

      int getLine()
      Return the line number in the source/listing 1 based .. i.e. line 1 is the first line in the source/listing When using line level coverage this will match the line. Statements are positioned 0,1,.. on the same line
      Returns:
      relative line number from the start of the source/listing, 1 based
    • getIndex

      int getIndex()
      Relative index of statement on a line zero based... i.e. position zero is the first statement on a line, 1 is the 2nd statement
      Returns:
      relative index zero based
    • getColumn

      int getColumn()
      Zero based location on a line Will return zero for all statements on the same line if the column information is not known
      Returns:
      column number in a line zero based
    • getEndColumn

      int getEndColumn()
      End column of the statement This may not be set and will return zero if unknown
      Returns:
      zero if unknown or the end column (zero based) of the statement
    • isHit

      boolean isHit()
      Returns true if statement was hit
      Returns:
      true if hit
    • getHitCount

      int getHitCount()
      Returns the hit count If hit count is not recorded then returns 1 if the statement was hit
      Returns:
      number of times this statement was hit. Returns 0 zero if not hit
    • getContent

      String getContent()
      Content of the statement
      Returns:
      null or content of statement
    • hasExtendedInfo

      boolean hasExtendedInfo()
      Statements can be simple and only contain the line and index This method will return false When additional information like column start end has been set then this method will return true This can be used to optimize storing statement information without having to check if each field has been populated
      Returns:
      false if just line and index is set otherwise true when other fields have been set