com.thoughtworks.xstream.tools.benchmark.metrics
Class SizeMetric

java.lang.Object
  com.thoughtworks.xstream.tools.benchmark.metrics.SizeMetric

All Implemented Interfaces:

Metric

public class SizeMetric
extends Object
implements Metric

Determines the size of the serialized form of an object (in bytes).

Author:

Joe Walnes

See Also:

Harness, Metric

Constructor Summary

SizeMetric()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SizeMetric

public SizeMetric()

Method Detail

run

public double run(Product product,
                  Target target)
           throws Exception

Description copied from interface: Metric

Run the test and produce a metric.

Specified by:

run in interface 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:

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

run

public double run(Product product,
                  Object object)
           throws Exception

Deprecated. since 1.3

Description copied from interface: Metric

Run the test and produce a metric.

Specified by:

run in interface 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:

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

toString

public String toString()

Overrides:

toString in class Object

unit

public String unit()

Description copied from interface: Metric

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

Specified by:

unit in interface Metric

biggerIsBetter

public boolean biggerIsBetter()

Description copied from interface: Metric

Whether a big result is better for this metric.

Specified by:

biggerIsBetter in interface Metric