com.github.rollingmetrics.hitratio

Class ResetOnSnapshotHitRatio

java.lang.Object

com.github.rollingmetrics.hitratio.ResetOnSnapshotHitRatio

All Implemented Interfaces:

HitRatio

public class ResetOnSnapshotHitRatio
extends Object
implements HitRatio

The hit-ratio which reset its state to zero after each invocation of getHitRatio().

Concurrency properties:

• Writing is lock-free. Writers do not block writers and readers.
• Reading is lock-free. Readers do not block writers and readers.

Usage recommendations:

• When you do not need in "rolling time window" semantic. Else use SmoothlyDecayingRollingHitRatio
• When you need in 100 percents guarantee that one measure can not be reported twice.
• Only if one kind of reader interests in value of hit-ratio. Usage of this implementation for case of multiple readers will be a bad idea because of readers will steal data from each other.

See Also:

SmoothlyDecayingRollingHitRatio, ResetPeriodicallyHitRatio, UniformHitRatio

Constructor Summary

Constructors

Constructor and Description
ResetOnSnapshotHitRatio()

Method Summary

Modifier and Type	Method and Description
double	getHitRatio() Returns the ratio between hits and misses
void	update(int hitCount, int totalCount) Registers an result of bulk operations.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.rollingmetrics.hitratio.HitRatio

incrementHitCount, incrementMissCount

Constructor Detail

ResetOnSnapshotHitRatio

public ResetOnSnapshotHitRatio()

Method Detail

update

public void update(int hitCount,
                   int totalCount)

Description copied from interface: HitRatio

Registers an result of bulk operations.

Example of usage:

 
 Set<Something> cachedValues = cache.get(keys);
 hitRatio.update(cachedValues.size(), keys.size());
 
 

Specified by:

update in interface HitRatio

getHitRatio

public double getHitRatio()

Description copied from interface: HitRatio

Returns the ratio between hits and misses

Specified by:

getHitRatio in interface HitRatio

Returns:

the ratio between hits and misses