org.perfidix.meter

Class AbstractMeter

java.lang.Object

org.perfidix.meter.AbstractMeter

Direct Known Subclasses:

CountingMeter, FileMeter, MemMeter, ThreadMeter, TimeMeter

public abstract class AbstractMeter
extends Object

For benchmarking in a widen sense, several different meters should be implemented. The first one is obviously the time. Nevertheless, besides the time, other meters for special purposes can be implemented with this method.

Author:

Alexander Onea, neue Couch, Sebastian Graf, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
AbstractMeter()

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	equals(Object obj)
abstract String	getName() A short name of the meter.
abstract String	getUnit() Returns the unit in which this measure taker computes its results.
abstract String	getUnitDescription() The long description of the unit.
abstract double	getValue() Getting the current value for this meter.
abstract int	hashCode()
String	toString() The String representation of this meter with its current value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMeter

public AbstractMeter()

Method Detail

getValue

public abstract double getValue()

Getting the current value for this meter.

Returns:

the current tick value.

getUnit

public abstract String getUnit()

Returns the unit in which this measure taker computes its results.

Returns:

the unit of this meter

getUnitDescription

public abstract String getUnitDescription()

The long description of the unit. can be empty but if available, it should provide one or two words about the measure taker.

Returns:

the long description of the unit in which measurement takes place.

getName

public abstract String getName()

A short name of the meter.

Returns:

the name.

toString

public final String toString()

The String representation of this meter with its current value.

Overrides:

toString in class Object

Returns:

a string representation of this meter.

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

equals

public abstract boolean equals(Object obj)

Overrides:

equals in class Object