Class Allure.SetProperty

java.lang.Object
com.shaft.properties.internal.Allure.SetProperty
All Implemented Interfaces:
EngineProperties.SetProperty
Enclosing interface:
Allure
public static class Allure.SetProperty extends Object implements EngineProperties.SetProperty
Fluent builder that allows programmatic override of individual Allure configuration properties. All setter methods return this to support method chaining.

Example: 

SHAFT.Properties.allure.set()
    .automaticallyOpen(false)
    .accumulateHistory(true)
    .customTitle("Regression Suite");

  • Constructor Details

    • SetProperty

      public SetProperty()
      Creates a new SetProperty instance.

  • Method Details

    • automaticallyOpen

      public Allure.SetProperty automaticallyOpen(boolean value)
      Overrides the allure.automaticallyOpen property at runtime.
      Parameters:
      value - true to open the report automatically after execution
      Returns:
      this Allure.SetProperty instance for chaining

    • accumulateHistory

      public Allure.SetProperty accumulateHistory(boolean value)
      Overrides the allure.accumulateHistory property at runtime.
      Parameters:
      value - true to keep and accumulate Allure history across runs
      Returns:
      this Allure.SetProperty instance for chaining

    • accumulateReports

      public Allure.SetProperty accumulateReports(boolean value)
      Overrides the allure.accumulateReports property at runtime.
      Parameters:
      value - true to keep previous report HTML files in the report directory
      Returns:
      this Allure.SetProperty instance for chaining

    • cleanResultsDirectory

      public Allure.SetProperty cleanResultsDirectory(boolean value)
      Overrides the allure.cleanResultsDirectory property at runtime.
      Parameters:
      value - true to clean the Allure results directory before execution
      Returns:
      this Allure.SetProperty instance for chaining

    • generateArchive

      public Allure.SetProperty generateArchive(boolean value)
      Overrides the allure.generateArchive property at runtime.
      Parameters:
      value - true to generate a ZIP archive of the report after execution
      Returns:
      this Allure.SetProperty instance for chaining

    • customLogo

      public Allure.SetProperty customLogo(String value)
      Overrides the allure.customLogo property at runtime.
      Parameters:
      value - a URL string pointing to the replacement logo image
      Returns:
      this Allure.SetProperty instance for chaining

    • customTitle

      public Allure.SetProperty customTitle(String value)
      Overrides the allure.customTitle property at runtime.
      Parameters:
      value - the report title to display in the Allure report header
      Returns:
      this Allure.SetProperty instance for chaining

    • forceConfiguredCliVersion

      public Allure.SetProperty forceConfiguredCliVersion(boolean value)
      Overrides the allure.forceConfiguredCliVersion property at runtime.
      Parameters:
      value - true to enforce configured allure3Version and ignore mismatched PATH-installed allure binaries
      Returns:
      this Allure.SetProperty instance for chaining

    • realtimeMonitoring

      public Allure.SetProperty realtimeMonitoring(boolean value)
      Overrides the allure.realtimeMonitoring property at runtime.
      Parameters:
      value - true to allow real-time monitoring when eligible; false to disable it
      Returns:
      this Allure.SetProperty instance for chaining

    • singleFile

      public Allure.SetProperty singleFile(boolean value)
      Overrides the allure.singleFile property at runtime.
      Parameters:
      value - true for self-contained HTML reports; false for multi-file output
      Returns:
      this Allure.SetProperty instance for chaining

    • reportLanguage

      public Allure.SetProperty reportLanguage(String value)
      Overrides the allure.reportLanguage property at runtime.
      Parameters:
      value - the language code used by the generated Allure 3 report
      Returns:
      this Allure.SetProperty instance for chaining

    • open

      public Allure.SetProperty open(boolean value)
      Overrides the allure.open property at runtime.
      Parameters:
      value - true when the Allure CLI should open the report itself; false otherwise
      Returns:
      this Allure.SetProperty instance for chaining

    • groupBy

      public Allure.SetProperty groupBy(String value)
      Overrides the allure.groupBy property at runtime.
      Parameters:
      value - comma-separated grouping fields used by the generated Allure 3 report
      Returns:
      this Allure.SetProperty instance for chaining