Open topic with navigation

com.hp.lft.report

## Class ReportingProvider

- java.lang.Object
- - com.hp.lft.report.ReportingProvider

-     public class ReportingProvider
      extends java.lang.Object

  Provides various types of reporter objects.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `ModifiableReportConfiguration` | `createDefaultReportConfiguration()` Returns a report configuration with default values.
    `static ReportingProvider` | `getInstance()`
    `com.hp.lft.report.internal.InternalReporter` | `getInternalReporter()`
    `ModifiableReportConfiguration` | `getReportConfiguration()` Returns the `ModifiableReportConfiguration` to use for this project.
    `ReportProvider` | `getReporter()` Returns the reporter with the type: Reporter.
    `UnitTestReporter` | `getUnitTestReporter4InternalUse()` Returns the reporter with the type: UnitTestReporter.
    `void` | `init(ModifiableReportConfiguration reportConfiguration)`
    `ModifiableReportConfiguration` | `loadCustomReportConfigurationFromExternalPropertiesFile(java.lang.String propertiesFilePath)` Returns a report configuration updated with the values defined in the specified leanft.properties file.
    `ModifiableReportConfiguration` | `loadCustomReportConfigurationFromResources(java.lang.String propertiesFileName)` Returns a report configuration updated with the values defined in the leanft.properties file located in the resources folder.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### getInstance

          public static ReportingProvider getInstance()

    - #### init

          public void init(ModifiableReportConfiguration reportConfiguration)
                    throws ReportException

      Throws:
        `ReportException`

    - #### getReporter

          public ReportProvider getReporter()

      Returns the reporter with the type: Reporter.
      Returns:
        Reporter object.

    - #### getUnitTestReporter4InternalUse

          public UnitTestReporter getUnitTestReporter4InternalUse()

      Returns the reporter with the type: UnitTestReporter. (for internal use only.)
      Returns:
        Reporter object.

    - #### getInternalReporter

          public com.hp.lft.report.internal.InternalReporter getInternalReporter()

    - #### createDefaultReportConfiguration

          public ModifiableReportConfiguration createDefaultReportConfiguration()

      Returns a report configuration with default values.
      Returns:
        a report configuration with default values.

    - #### loadCustomReportConfigurationFromResources

          public ModifiableReportConfiguration loadCustomReportConfigurationFromResources(java.lang.String propertiesFileName)
                                                                                   throws java.io.IOException

      Returns a report configuration updated with the values defined in the leanft.properties file located in the resources folder. If a value is missing in the specified property file, it is initialized in the returned configuration with the default value.
      Parameters:
        `propertiesFileName` - the name of the properties file to load (the file must be in the resources folder).
      Returns:
        the updated report configuration with the values from the specified properties file.
      Throws:
        `java.io.IOException` - if the file is not found.

    - #### loadCustomReportConfigurationFromExternalPropertiesFile

          public ModifiableReportConfiguration loadCustomReportConfigurationFromExternalPropertiesFile(java.lang.String propertiesFilePath)
                                                                                                throws java.io.IOException

      Returns a report configuration updated with the values defined in the specified leanft.properties file. If a value is missing in the specified property file, it is initialized in the returned configuration with the default value.
      Parameters:
        `propertiesFilePath` - the full path of the properties file to load.
      Returns:
        the updated report configuration with the values from the specified properties file.
      Throws:
        `java.io.IOException` - if the file is not found.

    - #### getReportConfiguration

          public ModifiableReportConfiguration getReportConfiguration()

      Returns the `ModifiableReportConfiguration` to use for this project. By default, uses the Report configuration details defined in the project's leanft.properties file.
      However, if an 'lftConfigFile' system variable was specified with a valid leanft.properties file, the Report data from that file is used to initialize the `SDKConfiguration`.
      Returns:
        the ModifiableReportConfiguration to use for this project