org.gradle.profiler

Class ScenarioDefinition

java.lang.Object

org.gradle.profiler.ScenarioDefinition

Direct Known Subclasses:

BuildToolCommandLineScenarioDefinition, GradleScenarioDefinition

public abstract class ScenarioDefinition
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ScenarioDefinition(java.lang.String name, java.lang.String title, java.util.List<BuildMutator> buildMutators, int warmUpCount, int buildCount, java.io.File outputDir)

Method Summary

Modifier and Type	Method and Description
abstract boolean	createsMultipleProcesses()
abstract boolean	doesCleanup()
abstract BuildConfiguration	getBuildConfiguration()
int	getBuildCount()
java.util.List<BuildMutator>	getBuildMutators()
abstract java.lang.String	getBuildToolDisplayName() A human consumable description of the build tool that runs this scenario.
abstract java.lang.String	getDisplayName() A human consumable and unique display name for this scenario using getTitle().
abstract BuildInvoker	getInvoker()
java.lang.String	getName()
java.io.File	getOutputDir()
abstract java.lang.String	getProfileName() A unique name for this scenario, that can be used for file names and other identifiers.
abstract java.lang.String	getTasksDisplayName() A human consumable description of the 'tasks' that are run for this scenario (may not be Gradle tasks).
java.lang.String	getTitle() A specific title defined for the scenario to be used in reports (defaults to getName()).
int	getWarmUpCount()
protected void	printDetail(java.io.PrintStream out)
void	printTo(java.io.PrintStream out)
static java.lang.String	safeFileName(java.lang.String name)
void	validate()
void	visitProblems(InvocationSettings settings, java.util.function.Consumer<java.lang.String> reporter)

Methods inherited from class java.lang.Object

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

Constructor Detail

ScenarioDefinition

public ScenarioDefinition(java.lang.String name,
                          @Nullable
                          java.lang.String title,
                          java.util.List<BuildMutator> buildMutators,
                          int warmUpCount,
                          int buildCount,
                          java.io.File outputDir)

Method Detail

validate

public void validate()

getTitle

public java.lang.String getTitle()

A specific title defined for the scenario to be used in reports (defaults to getName()).

getDisplayName

public abstract java.lang.String getDisplayName()

A human consumable and unique display name for this scenario using getTitle().

getProfileName

public abstract java.lang.String getProfileName()

A unique name for this scenario, that can be used for file names and other identifiers.

getBuildToolDisplayName

public abstract java.lang.String getBuildToolDisplayName()

A human consumable description of the build tool that runs this scenario.

getTasksDisplayName

public abstract java.lang.String getTasksDisplayName()

A human consumable description of the 'tasks' that are run for this scenario (may not be Gradle tasks).

getInvoker

public abstract BuildInvoker getInvoker()

getName

public java.lang.String getName()

getOutputDir

public java.io.File getOutputDir()

getBuildMutators

public java.util.List<BuildMutator> getBuildMutators()

getWarmUpCount

public int getWarmUpCount()

getBuildCount

public int getBuildCount()

printTo

public void printTo(java.io.PrintStream out)

visitProblems

public void visitProblems(InvocationSettings settings,
                          java.util.function.Consumer<java.lang.String> reporter)

printDetail

protected void printDetail(java.io.PrintStream out)

createsMultipleProcesses

public abstract boolean createsMultipleProcesses()

doesCleanup

public abstract boolean doesCleanup()

getBuildConfiguration

public abstract BuildConfiguration getBuildConfiguration()

safeFileName

public static java.lang.String safeFileName(java.lang.String name)