Package org.gradle.profiler

Class ScenarioDefinition

java.lang.Object

org.gradle.profiler.ScenarioDefinition

Direct Known Subclasses:

BuildToolCommandLineScenarioDefinition, GradleScenarioDefinition

public abstract class ScenarioDefinition
extends Object

Constructor Summary

Constructors

Constructor	Description
ScenarioDefinition(String name, String title, List<BuildMutator> buildMutators, int warmUpCount, int buildCount, File outputDir)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ScenarioDefinition

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

Method Details

validate

public void validate()

getTitle

public String getTitle()

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

getDisplayName

public abstract String getDisplayName()

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

getProfileName

public abstract String getProfileName()

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

getBuildToolDisplayName

public abstract String getBuildToolDisplayName()

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

getTasksDisplayName

public abstract 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 String getName()

getOutputDir

public File getOutputDir()

getBuildMutators

public List<BuildMutator> getBuildMutators()

getWarmUpCount

public int getWarmUpCount()

getBuildCount

public int getBuildCount()

printTo

public void printTo(PrintStream out)

visitProblems

public void visitProblems(InvocationSettings settings,
 Consumer<String> reporter)

printDetail

protected void printDetail(PrintStream out)

createsMultipleProcesses

public abstract boolean createsMultipleProcesses()

doesCleanup

public abstract boolean doesCleanup()

getBuildConfiguration

public abstract BuildConfiguration getBuildConfiguration()