org.yardstickframework

Class BenchmarkDriverAdapter

java.lang.Object

org.yardstickframework.BenchmarkDriverAdapter

All Implemented Interfaces:

BenchmarkDriver

Direct Known Subclasses:

AtomicCounterBenchmark, EchoBenchmark

public abstract class BenchmarkDriverAdapter
extends Object
implements BenchmarkDriver

Convenient adapter for benchmark driver implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected BenchmarkConfiguration	cfg Benchmark configuration.

Constructor Summary

Constructors

Constructor and Description
BenchmarkDriverAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
String	description() Gets benchmark description.
Collection<BenchmarkProbe>	probes() Gets collection of custom probes that this benchmark provides.
void	setUp(BenchmarkConfiguration cfg) This method is invoked right before the BenchmarkDriver.test() method.
void	tearDown() This method is invoked right after the BenchmarkDriver.test() method.
String	usage() Gets benchmark usage.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yardstickframework.BenchmarkDriver

test

Field Detail

cfg

protected BenchmarkConfiguration cfg

Benchmark configuration.

Constructor Detail

BenchmarkDriverAdapter

public BenchmarkDriverAdapter()

Method Detail

setUp

public void setUp(BenchmarkConfiguration cfg)
           throws Exception

This method is invoked right before the BenchmarkDriver.test() method. All benchmark preparation and all resource initialization should be done here.

Specified by:

setUp in interface BenchmarkDriver

Parameters:

cfg - Benchmark configuration.

Throws:

Exception - If failed.

tearDown

public void tearDown()
              throws Exception

This method is invoked right after the BenchmarkDriver.test() method. All necessary resources should be released here.

Specified by:

tearDown in interface BenchmarkDriver

Throws:

Exception - If failed.

probes

public Collection<BenchmarkProbe> probes()

Gets collection of custom probes that this benchmark provides.

Specified by:

probes in interface BenchmarkDriver

Returns:

Collection of custom probes or null if set of default probes should be used.

description

public String description()

Gets benchmark description.

Specified by:

description in interface BenchmarkDriver

Returns:

Benchmark description.

usage

public String usage()

Gets benchmark usage.

Specified by:

usage in interface BenchmarkDriver

Returns:

Benchmark usage.