net.grinder.statistics

Class TestStatisticsMap

java.lang.Object

net.grinder.statistics.TestStatisticsMap

All Implemented Interfaces:

Externalizable, Serializable

public final class TestStatisticsMap
extends Object
implements Externalizable

A map of test numbers to StatisticsSets.

Test statistics synchronisation occurs at the granularity of the contained StatisticsSet instances. The map is synchronised on the TestStatisticsMap itself.

Author:

Philip Aston

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TestStatisticsMap.ForEach Convenient visitor-like iteration.

Constructor Summary

Constructors

Constructor and Description
TestStatisticsMap() Externalizable classes need a public default constructor.
TestStatisticsMap(StatisticsSetFactory statisticsSetFactory) Creates a new TestStatisticsMap instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(TestStatisticsMap other) Add the values in another TestStatisticsMap to this TestStatisticsMap.
StatisticsSet	compositeStatisticsTotals() Add up all the composite statistics.
boolean	equals(Object o) Implement value based equality.
int	hashCode() Defer to Object.hashCode().
StatisticsSet	nonCompositeStatisticsTotals() Add up all the non-composite statistics.
void	put(Test test, StatisticsSet statistics) Put a new {test, statistics} pair in the map.
void	readExternal(ObjectInput in) Efficient externalisation method.
TestStatisticsMap	reset() Reset all our statistics and return a snapshot.
int	size() Return the number of entries in the TestStatisticsMap.
String	toString() Return a String representation of this TestStatisticsMap.
void	writeExternal(ObjectOutput out) Efficient externalisation method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TestStatisticsMap

public TestStatisticsMap(StatisticsSetFactory statisticsSetFactory)

Creates a new TestStatisticsMap instance.

Parameters:

statisticsSetFactory - A factory used to build StatisticsSets.

TestStatisticsMap

public TestStatisticsMap()

Externalizable classes need a public default constructor.

Method Detail

put

public void put(Test test,
       StatisticsSet statistics)

Put a new {test, statistics} pair in the map.

Parameters:

test - A test.

statistics - The test's statistics.

size

public int size()

Return the number of entries in the TestStatisticsMap.

Returns:

an int value

add

public void add(TestStatisticsMap other)

Add the values in another TestStatisticsMap to this TestStatisticsMap.

Parameters:

other - The other TestStatisticsMap.

reset

public TestStatisticsMap reset()

Reset all our statistics and return a snapshot.

Returns:

The snapshot. Only Tests with non-zero statistics are included.

nonCompositeStatisticsTotals

public StatisticsSet nonCompositeStatisticsTotals()

Add up all the non-composite statistics.

Returns:

The sum of all the non-composite statistics.

compositeStatisticsTotals

public StatisticsSet compositeStatisticsTotals()

Add up all the composite statistics.

Returns:

The sum of all the composite statistics.

equals

public boolean equals(Object o)

Implement value based equality. Used by unit tests, so we don't bother with synchronisation.

Overrides:

equals in class Object

Parameters:

o - Object to compare to.

Returns:

true if and only if the two objects are equal.

hashCode

public int hashCode()

Defer to Object.hashCode().

We define hashCode to keep Checkstyle happy, but we don't use it.

Overrides:

hashCode in class Object

Returns:

The hash code.

toString

public String toString()

Return a String representation of this TestStatisticsMap.

Overrides:

toString in class Object

Returns:

The String

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Efficient externalisation method.

Specified by:

writeExternal in interface Externalizable

Parameters:

out - Handle to the output stream.

Throws:

IOException - If an I/O error occurs.

readExternal

public void readExternal(ObjectInput in)
                  throws IOException

Efficient externalisation method. No synchronisation, assume that we're being read into a new instance.

Specified by:

readExternal in interface Externalizable

Parameters:

in - Handle to the input stream.

Throws:

IOException - If an I/O error occurs.