Package com.codingchili.core.benchmarking

Interface BenchmarkGroup

All Known Implementing Classes:
BenchmarkGroupBuilder
public interface BenchmarkGroup
Contains a set of benchmarks and groups them by type, for example "network" or "storage".

  • Method Details

    • getName

      String getName()
      The handler of the benchmark group, for example "networking" or "storage". Benchmarks are grouped under this in the reports.
      Returns:
      a string that identifies a group of benchmarks.

    • getIterations

      int getIterations()
      Number of iterations that the benchmark operation is to be executed.
      Returns:
      a integer indicating the number of operation iterations.

    • getImplementations

      Collection<BenchmarkImplementation> getImplementations()
      Get the implementations enlisted for benchmarking in this group.
      Returns:
      a list of implementations to benchmark.

    • setImplementations

      BenchmarkGroup setImplementations​(Map<String,​BenchmarkImplementation> implementations)
      Sets the implementations in the group to the given list. May be used when creating reports.
      Parameters:
      implementations - the implementations to set.
      Returns:
      fluent

    • implementation

      BenchmarkImplementation implementation​(String implementationName)
      Adds a new implementation to the benchmark group.
      Parameters:
      implementationName - the name of the implementation to add.
      Returns:
      an implementation

    • getProgressInterval

      int getProgressInterval()
      Return the number of iterations to complete before calling a listeners progress listener.
      Returns:
      the number of iterations.

    • add

      void add​(BenchmarkImplementation implementation)
      Parameters:
      implementation - the benchmark implementation to add.