PolicyStats (simulator 2.9.1 API)

java.lang.Object
- com.github.benmanes.caffeine.cache.simulator.policy.PolicyStats

```
public class PolicyStats
extends Object
```
Statistics gathered by a policy execution. A policy can extend this class as a convenient way to add custom metrics.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PolicyStats.Metric

Nested Classes
Modifier and Type	Class and Description
`static class`	`PolicyStats.Metric`

Constructor Summary

Constructors
Constructor and Description

PolicyStats(String format, Object... args)

Constructors
Constructor and Description
`PolicyStats(String format, Object... args)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEvictions(long evictions)`
`void`	`addHits(long hits)`
`void`	`addMetric(PolicyStats.Metric metric)`
`void`	`addMetric(String name, DoubleSupplier supplier)`
`void`	`addMetric(String name, LongSupplier supplier)`
`void`	`addMetric(String name, Supplier<?> supplier)`
`void`	`addMisses(long misses)`
`void`	`addOperations(long operations)`
`void`	`addPercentMetric(String name, DoubleSupplier supplier)`
`long`	`admissionCount()`
`double`	`admissionRate()`
`double`	`averageMissPenalty()`
`double`	`avergeHitPenalty()`
`double`	`avergePenalty()`
`double`	`complexity()`
`long`	`evictionCount()`
`long`	`hitCount()`
`double`	`hitPenalty()`
`double`	`hitRate()`
`long`	`hitsWeight()`
`Map<String,PolicyStats.Metric>`	`metrics()`
`long`	`missCount()`
`long`	`missesWeight()`
`double`	`missPenalty()`
`double`	`missRate()`
`String`	`name()`
`long`	`operationCount()`
`double`	`percentAdaption()`
`void`	`recordAdmission()`
`void`	`recordEviction()`
`void`	`recordHit()`
`void`	`recordHitPenalty(double penalty)`
`void`	`recordMiss()`
`void`	`recordMissPenalty(double penalty)`
`void`	`recordOperation()`
`void`	`recordRejection()`
`void`	`recordWeightedHit(int weight)`
`void`	`recordWeightedMiss(int weight)`
`long`	`rejectionCount()`
`long`	`requestCount()`
`long`	`requestsWeight()`
`void`	`setPercentAdaption(double percentAdaption)`
`com.google.common.base.Stopwatch`	`stopwatch()`
`String`	`toString()`
`double`	`totalPenalty()`
`double`	`weightedHitRate()`
`double`	`weightedMissRate()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PolicyStats

public PolicyStats(String format,
                   Object... args)

Method Detail

addMetric

public void addMetric(PolicyStats.Metric metric)

addMetric

public void addMetric(String name,
                      Supplier<?> supplier)

addMetric

public void addMetric(String name,
                      LongSupplier supplier)

addMetric

public void addMetric(String name,
                      DoubleSupplier supplier)

addPercentMetric

public void addPercentMetric(String name,
                             DoubleSupplier supplier)

metrics

public Map<String,PolicyStats.Metric> metrics()

stopwatch

public com.google.common.base.Stopwatch stopwatch()

name
```
public String name()
```

recordOperation
```
public void recordOperation()
```

operationCount
```
public long operationCount()
```

addOperations

public void addOperations(long operations)

recordHit
```
public void recordHit()
```

hitCount
```
public long hitCount()
```

addHits
```
public void addHits(long hits)
```

recordWeightedHit

public void recordWeightedHit(int weight)

hitsWeight
```
public long hitsWeight()
```

recordHitPenalty

public void recordHitPenalty(double penalty)

hitPenalty
```
public double hitPenalty()
```

recordMiss
```
public void recordMiss()
```

missCount
```
public long missCount()
```

addMisses
```
public void addMisses(long misses)
```

recordWeightedMiss

public void recordWeightedMiss(int weight)

missesWeight
```
public long missesWeight()
```

recordMissPenalty

public void recordMissPenalty(double penalty)

missPenalty
```
public double missPenalty()
```

evictionCount
```
public long evictionCount()
```

recordEviction
```
public void recordEviction()
```

addEvictions

public void addEvictions(long evictions)

requestCount
```
public long requestCount()
```

requestsWeight
```
public long requestsWeight()
```

admissionCount
```
public long admissionCount()
```

recordAdmission
```
public void recordAdmission()
```

rejectionCount
```
public long rejectionCount()
```

recordRejection
```
public void recordRejection()
```

totalPenalty
```
public double totalPenalty()
```

percentAdaption
```
public double percentAdaption()
```

setPercentAdaption

public void setPercentAdaption(double percentAdaption)

hitRate
```
public double hitRate()
```

weightedHitRate
```
public double weightedHitRate()
```

missRate
```
public double missRate()
```

weightedMissRate
```
public double weightedMissRate()
```

admissionRate
```
public double admissionRate()
```

complexity
```
public double complexity()
```

avergePenalty
```
public double avergePenalty()
```

avergeHitPenalty
```
public double avergeHitPenalty()
```

averageMissPenalty
```
public double averageMissPenalty()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

Class PolicyStats

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PolicyStats

Method Detail

addMetric

addMetric

addMetric

addMetric

addPercentMetric

metrics

stopwatch

name

recordOperation

operationCount

addOperations

recordHit

hitCount

addHits

recordWeightedHit

hitsWeight

recordHitPenalty

hitPenalty

recordMiss

missCount

addMisses

recordWeightedMiss

missesWeight

recordMissPenalty

missPenalty

evictionCount

recordEviction

addEvictions

requestCount

requestsWeight

admissionCount

recordAdmission

rejectionCount

recordRejection

totalPenalty

percentAdaption

setPercentAdaption

hitRate

weightedHitRate

missRate

weightedMissRate

admissionRate

complexity

avergePenalty

avergeHitPenalty

averageMissPenalty

toString