com.github.rollingmetrics.hitratio

Class UniformHitRatio

java.lang.Object

com.github.rollingmetrics.hitratio.UniformHitRatio

All Implemented Interfaces:

HitRatio

public class UniformHitRatio
extends Object
implements HitRatio

The hit-ratio which never evicts collected values.

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
• Normally you should not use this implementation because in real world use-cases you need to show measurements which actual to current moment of time or time window.

See Also:

SmoothlyDecayingRollingHitRatio, ResetPeriodicallyHitRatio, ResetOnSnapshotHitRatio

Constructor Summary

Constructors

Constructor and Description
UniformHitRatio()

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

UniformHitRatio

public UniformHitRatio()

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