no.g9.message.metric

Interface IMetric

All Superinterfaces:

Cloneable

All Known Implementing Classes:

SimpleMetric

public interface IMetric
extends Cloneable

This is the interface that a timer should support. A timer has certain characteristics: - The "key" - used to distinguish each timer in a Set. - The count - some timers will also count how many times a certain event has occurred. - The value - some timers will add upp numbers, often used in connection with the count to get an average. - And of course the time itself.

Method Summary

Modifier and Type	Method and Description
void	add(long val) Add a value to a metric and increase the counter.
void	clear() Reset the metric.
Object	clone() Make a clone of this object.
long	getCount() Gets the count of updates to this metric.
String	getKey() Returns the identifier.
long	getTimer() Returns the running time so far.
long	getValue() Gets the total value for this metric.
void	setCount(long n) Sets the counter value.
void	setKey(String key) Sets the ID.
void	setValue(long n) Sets the new value without changing the count.
IMetric	stopTimer() Sets the end time and returns a reference to this object.

Method Detail

add

void add(long val)

Add a value to a metric and increase the counter.

Parameters:

val - Value to add

clear

void clear()

Reset the metric.

clone

Object clone()
      throws CloneNotSupportedException

Make a clone of this object.

Returns:

a deep copy of this object

Throws:

CloneNotSupportedException - if it fails...

getKey

String getKey()

Returns the identifier.

Returns:

key value

See Also:

setKey(java.lang.String)

getCount

long getCount()

Gets the count of updates to this metric.

Returns:

count uf updates

See Also:

setCount(long)

getTimer

long getTimer()

Returns the running time so far.

Returns:

time in millis

stopTimer

IMetric stopTimer()

Sets the end time and returns a reference to this object.

Returns:

this object

getValue

long getValue()

Gets the total value for this metric.

Returns:

total value

See Also:

setValue(long)

setKey

void setKey(String key)

Sets the ID.

Parameters:

key - ID

See Also:

getKey()

setCount

void setCount(long n)

Sets the counter value.

Parameters:

n - New counter value

See Also:

getCount()

setValue

void setValue(long n)

Sets the new value without changing the count.

Parameters:

n - New value

See Also:

getValue()