Package io.qameta.allure.core

Interface Configuration

public interface Configuration
Report configuration.
Since:
2.0

  • Method Details

    • getUuid

      default String getUuid()
      Gets uuid.
      Returns:
      the uuid

    • getVersion

      default String getVersion()
      Gets version.
      Returns:
      the version

    • getReportLanguage

      default String getReportLanguage()
      Returns the report language. If not specified, uses "en".
      Returns:
      the report language.

    • getReportName

      default String getReportName()
      Returns the report name.
      Returns:
      the report name.

    • getPlugins

      List<Plugin> getPlugins()
      Returns all configured plugins.
      Returns:
      configured plugins.

    • getAggregators

      @Deprecated default List<Aggregator> getAggregators()
      Deprecated.
      for removal. Use getExtensions() instead.
      Returns all configured aggregators.
      Returns:
      configured aggregators.

    • getReaders

      @Deprecated default List<Reader> getReaders()
      Deprecated.
      for removal. Use getExtensions() instead.
      Returns all configured readers.
      Returns:
      configured readers.

    • getExtensions

      List<Extension> getExtensions()
      Returns all discovered extensions.
      Returns:
      configured extensions.

    • getExtensions

      default <T extends Extension> List<T> getExtensions(Class<T> extensionType)
      Returns all discovered extensions of specified type.
      Type Parameters:
      T - the type of extension.
      Parameters:
      extensionType - the type of extension.
      Returns:
      configured extensions.

    • getContext

      default <T, S extends Context<T>> Optional<S> getContext(Class<S> contextType)
      Resolve context by given type.
      Type Parameters:
      T - the java type of context's type.
      S - the java type of context.
      Parameters:
      contextType - type of context to resolve.
      Returns:
      resolved context.

    • requireContext

      default <T, S extends Context<T>> S requireContext(Class<S> contextType)
      The same as getContext(Class) but throws an exception if context doesn't present.
      Type Parameters:
      T - the type parameter
      S - the type parameter
      Parameters:
      contextType - the context type
      Returns:
      resolved context.
      Throws:
      ContextNotFoundException - if no such context present.