com.thoughtworks.xstream.tools.benchmark

Interface Metric

All Known Implementing Classes:

CharacterCountMetric, DeserializationSpeedMetric, SerializationSpeedMetric, SizeMetric

Deprecated.

As of 1.4.9 use JMH instead

public interface Metric

A metric is what's actually recorded. This provides a strategy for what to do with an object for a given product and should return a measurable result. For example it could serialize an object against a product and return how long it took to complete the operation.

Author:

Joe Walnes, Jörg Schaible

See Also:

Harness

Method Summary

Modifier and Type	Method and Description
boolean	biggerIsBetter() Deprecated. Whether a big result is better for this metric.
double	run(Product product, java.lang.Object object) Deprecated. since 1.3
double	run(Product product, Target target) Deprecated. Run the test and produce a metric.
java.lang.String	unit() Deprecated. The unit the metric is recorded in (for reporting purposes).

Method Detail

run

double run(Product product,
           java.lang.Object object)
    throws java.lang.Exception

Deprecated. since 1.3

Run the test and produce a metric.

Parameters:

product - Product to use in test.

object - A object to use against the product.

Returns:

The resulting metric (e.g. 12.22).

Throws:

java.lang.Exception - If this metric could not be obtained. This will be reported back to the Reporter.

run

double run(Product product,
           Target target)
    throws java.lang.Exception

Deprecated.

Run the test and produce a metric.

Parameters:

product - Product to use in test.

target - A target to use against the product.

Returns:

The resulting metric (e.g. 12.22).

Throws:

java.lang.Exception - If this metric could not be obtained. This will be reported back to the Reporter.

Since:

1.3

unit

java.lang.String unit()

Deprecated.

The unit the metric is recorded in (for reporting purposes). e.g. "ms" or "bytes".

biggerIsBetter

boolean biggerIsBetter()

Deprecated.

Whether a big result is better for this metric.