Package com.codingchili.core.benchmarking

Class BenchmarkImplementationBuilder

java.lang.Object

com.codingchili.core.benchmarking.BenchmarkImplementationBuilder

All Implemented Interfaces:

BenchmarkImplementation

Direct Known Subclasses:

MapBenchmarkImplementation

public class BenchmarkImplementationBuilder
extends Object
implements BenchmarkImplementation

"Abstract" benchmark-implementation.

Field Summary

Fields

Modifier and Type	Field	Description
protected BenchmarkGroup	group

Constructor Summary

Constructors

Constructor	Description
BenchmarkImplementationBuilder(String name)

Method Summary

Modifier and Type	Method	Description
BenchmarkImplementation	add(String name, BenchmarkOperation operation)	Adds a new benchmark created from an operation and name.
List<Benchmark>	getBenchmarks()
String	getName()	Name of the implementation that is used within a benchmark.
Map<String,Object>	getProperties()	get all properties added to the implementation.
void	initialize(CoreContext core, io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> future)	Prepares an implementation for testing.
void	next(io.vertx.core.Promise<Void> promise)	Called before each benchmark is executed.
void	reset(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> future)	Called after the warmup phase has completed.
BenchmarkImplementation	setBenchmarks(List<Benchmark> benchmarks)	Sets the benchmarks to a list of benchmarks, may be used when creating reports.
BenchmarkImplementationBuilder	setGroup(BenchmarkGroup group)
BenchmarkImplementation	setName(String name)	May be used in the reporting phase to restructure results.
BenchmarkImplementation	setProperty(String key, Object value)	Set a property of the benchmark implementation.
void	shutdown(io.vertx.core.Promise<Void> promise)	Called after the benchmarking has completed.

Methods inherited from class java.lang.Object

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

Field Details

group

protected BenchmarkGroup group

Constructor Details

BenchmarkImplementationBuilder

public BenchmarkImplementationBuilder(String name)

Method Details

setGroup

public BenchmarkImplementationBuilder setGroup(BenchmarkGroup group)

Specified by:

setGroup in interface BenchmarkImplementation

Parameters:

group - the group the implementation is part of.

Returns:

fluent

add

public BenchmarkImplementation add(String name,
 BenchmarkOperation operation)

Description copied from interface: BenchmarkImplementation

Adds a new benchmark created from an operation and name.

Specified by:

add in interface BenchmarkImplementation

Parameters:

name - the name of the operation/benchmark.

operation - the operation to execute as a benchmark.

Returns:

fluent

initialize

public void initialize(CoreContext core,
 io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> future)

Description copied from interface: BenchmarkImplementation

Prepares an implementation for testing.

Specified by:

initialize in interface BenchmarkImplementation

Parameters:

core - the context to use for the benchmark

future - called when the setup is complete.

next

public void next(io.vertx.core.Promise<Void> promise)

Description copied from interface: BenchmarkImplementation

Called before each benchmark is executed.

Specified by:

next in interface BenchmarkImplementation

Parameters:

promise - callback

reset

public void reset(io.vertx.core.Handler<io.vertx.core.AsyncResult<Void>> future)

Description copied from interface: BenchmarkImplementation

Called after the warmup phase has completed.

Specified by:

reset in interface BenchmarkImplementation

Parameters:

future - callback

shutdown

public void shutdown(io.vertx.core.Promise<Void> promise)

Description copied from interface: BenchmarkImplementation

Called after the benchmarking has completed.

Specified by:

shutdown in interface BenchmarkImplementation

Parameters:

promise - callback

getBenchmarks

public List<Benchmark> getBenchmarks()

Specified by:

getBenchmarks in interface BenchmarkImplementation

Returns:

a listof benchmarks that should be executed for the given implementation.

setBenchmarks

public BenchmarkImplementation setBenchmarks(List<Benchmark> benchmarks)

Description copied from interface: BenchmarkImplementation

Sets the benchmarks to a list of benchmarks, may be used when creating reports.

Specified by:

setBenchmarks in interface BenchmarkImplementation

Parameters:

benchmarks - the benchmarks to set

Returns:

fluent

getName

public String getName()

Description copied from interface: BenchmarkImplementation

Name of the implementation that is used within a benchmark. A good choice is Class.getSimpleName().

Specified by:

getName in interface BenchmarkImplementation

Returns:

a string that identifies the implementation tested.

setName

public BenchmarkImplementation setName(String name)

Description copied from interface: BenchmarkImplementation

May be used in the reporting phase to restructure results.

Specified by:

setName in interface BenchmarkImplementation

Parameters:

name - the name of the implementation

Returns:

fluent.

setProperty

public BenchmarkImplementation setProperty(String key,
 Object value)

Description copied from interface: BenchmarkImplementation

Set a property of the benchmark implementation.

Specified by:

setProperty in interface BenchmarkImplementation

Parameters:

key - the key to identify the value.

value - the value to be inserted.

Returns:

fluent

getProperties

public Map<String,Object> getProperties()

Description copied from interface: BenchmarkImplementation

get all properties added to the implementation.

Specified by:

getProperties in interface BenchmarkImplementation

Returns:

a map of all the properties that has been set.