org.terracotta.statistics.observer

Interface OperationObserver<T extends Enum<T>>

Type Parameters:

T - Enum type representing the possible operations 'results'

All Known Subinterfaces:

OperationStatistic<T>

All Known Implementing Classes:

AbstractOperationStatistic, MappedOperationStatistic, StatisticMapper, ZeroOperationStatistic

public interface OperationObserver<T extends Enum<T>>

Operation observers track the occurrence of processes which take a finite time and can potential terminate in different ways.

Operations must have an associated enum type that represents their possible outcomes. An example of such an enum type would be:

 enum PlaneFlight {
   LAND, CRASH;
 }
 

Operations also have an associated parameter the use of which is left up to the implementors of both the producer and consumer of events.

Method Summary

Modifier and Type	Method and Description
void	begin() Called immediately prior to the operation beginning.
void	end(T result) Called immediately after the operation completes with no interesting parameters.
void	end(T result, long... parameters) Called immediately after the operation completes.

Method Detail

begin

void begin()

Called immediately prior to the operation beginning.

end

void end(T result)

Called immediately after the operation completes with no interesting parameters.

Parameters:

result - the operation result

end

void end(T result,
         long... parameters)

Called immediately after the operation completes.

Parameters:

result - the operation result

parameters - the operation parameters