Interface ICCResultModifier

All Known Implementing Classes:
CCAbstractResultModifier

public interface ICCResultModifier
Represents a code coverage result modifier
Since:
4.0
  • Method Details

    • addModifier

      void addModifier(ICCModifier modifier) throws CCModifierException
      Adds a code coverage modifier to the result modifier
      Parameters:
      modifier - the code coverage modifier
      Throws:
      CCModifierException - thrown when the modifier is not supported
    • modify

      Modifies the specified code coverage result
      Parameters:
      result - the result to modify
      Returns:
      the result after it has been modified
      Throws:
      CCModifierException - when there is a problem modifying the result
    • modify

      Modifies the specified test case
      Parameters:
      testcase - the test case to modify
      Returns:
      the modified test case
      Throws:
      CCModifierException - when there is a problem modifying the test case
    • modify

      Modifies the specified file
      Parameters:
      file - the file to modify
      Returns:
      the modified file
      Throws:
      CCModifierException - when there is a problem modifying the file
    • modify

      Modifies the specified module
      Parameters:
      module - the module to modify
      Returns:
      the modified module
      Throws:
      CCModifierException - when there is a problem modifying the module
    • modify

      modifies the specified part
      Parameters:
      part - - the part to modify
      Returns:
      the modified part
      Throws:
      CCModifierException - when there is a problem modifying the part
      Since:
      9.0
    • dispose

      void dispose()
      Disposes the cached data for the result modifier
    • getId

      String getId()
      Retrieves the ID for the modifier. Used in visible messages.
      It is recommended to keep the ID under 10 characters.
      Returns:
      the ID of the filter
    • getLogInputStream

      InputStream getLogInputStream()
      Retrieves the log associated with the modifier as an InputStream. It is the caller's responsibility to close the returned InputStream to release associated system resources. The returned modifier can be used with
      Returns:
      InputStream containing the bytes of log messages associated with the modifier. Returns null if there was no log messages or there was an error during creation or access of the stream.
      Since:
      14.0