com.yahoo.statistics

Class Handle

java.lang.Object

com.yahoo.statistics.Handle

Direct Known Subclasses:

Counter, Group, Value

public abstract class Handle
extends Object

Base class for the interface to the statistics framework.

Author:

Steinar Knutsen

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	cancelled
private boolean	firstTime
private Statistics	manager
private String	name
private Callback	parametrizedCallback
private TimerTask	task

Constructor Summary

Constructors

Constructor and Description
Handle(String name, Statistics manager, Callback parametrizedCallback)

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancel this Handle and remove it from internal state in Statistics.
abstract boolean	equals(Object o)
(package private) String	getName()
abstract int	hashCode()
boolean	isCancelled() Returns whether this object has been cancelled or not.
(package private) TimerTask	makeTask()
void	run() Run the callback object first, then invoke runHandle().
void	runCallback() Run the callback object.
abstract void	runHandle() Invoke an action to be performed periodically for a statistics Handle.

Methods inherited from class java.lang.Object

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

Field Detail

task

private TimerTask task

name

private final String name

cancelled

private boolean cancelled

manager

private final Statistics manager

parametrizedCallback

private final Callback parametrizedCallback

firstTime

private boolean firstTime

Constructor Detail

Handle

Handle(String name,
       Statistics manager,
       Callback parametrizedCallback)

Method Detail

getName

String getName()

makeTask

TimerTask makeTask()

runCallback

public final void runCallback()

Run the callback object. This will happen at the start of each invocation of a Handle's run() method. The callback is presumed to be exception safe. If no callback is set, this is a no-op. The callback will need to handle any necessary synchronization itself.

run

public final void run()

Run the callback object first, then invoke runHandle().

runHandle

public abstract void runHandle()

Invoke an action to be performed periodically for a statistics Handle.

Synchronization has to be handled by the method itself.

cancel

public final boolean cancel()

Cancel this Handle and remove it from internal state in Statistics.

Returns:

value of java.util.TimerTask.cancel()

isCancelled

public final boolean isCancelled()

Returns whether this object has been cancelled or not.

Returns:

true if cancelled

equals

public abstract boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object