org.gradle.profiler.buildscan

Class BuildScanProfiler

java.lang.Object

org.gradle.profiler.Profiler

org.gradle.profiler.buildscan.BuildScanProfiler

public class BuildScanProfiler
extends Profiler

Field Summary

Fields inherited from class org.gradle.profiler.Profiler

NONE

Method Summary

Modifier and Type	Method and Description
static java.lang.String	defaultBuildScanVersion(org.gradle.util.GradleVersion gradleVersion) The effective version of the Build Scan or Develocity plugin to use.
GradleArgsCalculator	newGradleArgsCalculator(ScenarioSettings settings) Returns a calculator that provides Gradle args that should be applied to all builds, including warm-up builds.
GradleArgsCalculator	newInstrumentedBuildsGradleArgsCalculator(ScenarioSettings settings) Returns a calculator that provides Gradle args that should be applied to instrumented builds, but not warm-up builds.
boolean	requiresGradle() Whether this profiler supports only Gradle builds.
void	summarizeResultFile(java.io.File resultFile, java.util.function.Consumer<java.lang.String> consumer) Describe the given file, if recognized and should be reported to the user.
java.lang.String	toString()

Methods inherited from class org.gradle.profiler.Profiler

isCreatesStacksFiles, newController, newInstrumentedBuildsJvmArgsCalculator, newJvmArgsCalculator, validate

Methods inherited from class java.lang.Object

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

Method Detail

defaultBuildScanVersion

public static java.lang.String defaultBuildScanVersion(org.gradle.util.GradleVersion gradleVersion)

The effective version of the Build Scan or Develocity plugin to use.

Depending on the Gradle version, we return: - Build Scan plugin version for Gradle < 6.x - Develocity plugin version for Gradle >= 6.x

requiresGradle

public boolean requiresGradle()

Description copied from class: Profiler

Whether this profiler supports only Gradle builds.

Specified by:

requiresGradle in class Profiler

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

summarizeResultFile

public void summarizeResultFile(java.io.File resultFile,
                                java.util.function.Consumer<java.lang.String> consumer)

Description copied from class: Profiler

Describe the given file, if recognized and should be reported to the user.

Overrides:

summarizeResultFile in class Profiler

newGradleArgsCalculator

public GradleArgsCalculator newGradleArgsCalculator(ScenarioSettings settings)

Description copied from class: Profiler

Returns a calculator that provides Gradle args that should be applied to all builds, including warm-up builds.

Overrides:

newGradleArgsCalculator in class Profiler

newInstrumentedBuildsGradleArgsCalculator

public GradleArgsCalculator newInstrumentedBuildsGradleArgsCalculator(ScenarioSettings settings)

Description copied from class: Profiler

Returns a calculator that provides Gradle args that should be applied to instrumented builds, but not warm-up builds.

Overrides:

newInstrumentedBuildsGradleArgsCalculator in class Profiler