Skip to content

Commit

Permalink
Fix confusing JavaDoc due to typos
Browse files Browse the repository at this point in the history
  • Loading branch information
ben-manes committed Nov 10, 2015
1 parent 0f97ad0 commit a8c3630
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ private void onMiss(long key) {
evict();
}

/** Promotes the entry to the protected region's LRU position, demoting an entry if necessary. */
/** Promotes the entry to the protected region's MRU position, demoting an entry if necessary. */
private void onEdenProbationHit(Node node) {
admittor.record(node.key);

Expand All @@ -131,13 +131,13 @@ private void onEdenProbationHit(Node node) {
}
}

/** Moves the entry to the LRU position in the admission window. */
/** Moves the entry to the MRU position in the admission window. */
private void onEdenProtectedHit(Node node) {
admittor.record(node.key);
node.moveToTail(headEdenProtected);
}

/** Promotes the entry to the protected region's LRU position, demoting an entry if necessary. */
/** Promotes the entry to the protected region's MRU position, demoting an entry if necessary. */
private void onMainProbationHit(Node node) {
admittor.record(node.key);

Expand All @@ -156,7 +156,7 @@ private void onMainProbationHit(Node node) {
}
}

/** Moves the entry to the LRU position, if it falls outside of the fast-path threshold. */
/** Moves the entry to the MRU position, if it falls outside of the fast-path threshold. */
private void onMainProtectedHit(Node node) {
// Fast path skips the hottest entries, useful for concurrent caches
if (node.recencyMove <= (mainRecencyCounter - recencyMoveDistance)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,12 @@ private void onMiss(long key) {
evict();
}

/** Moves the entry to the LRU position in the admission window. */
/** Moves the entry to the MRU position in the admission window. */
private void onEdenHit(Node node) {
node.moveToTail(headEden);
}

/** Promotes the entry to the protected region's LRU position, demoting an entry if necessary. */
/** Promotes the entry to the protected region's MRU position, demoting an entry if necessary. */
private void onMainHit(Node node) {
node.remove();
sizeMainQ[node.level]--;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,13 +115,13 @@ private void onMiss(long key) {
evict();
}

/** Moves the entry to the LRU position in the admission window. */
/** Moves the entry to the MRU position in the admission window. */
private void onEdenHit(Node node) {
admittor.record(node.key);
node.moveToTail(headEden);
}

/** Promotes the entry to the protected region's LRU position, demoting an entry if necessary. */
/** Promotes the entry to the protected region's MRU position, demoting an entry if necessary. */
private void onProbationHit(Node node) {
admittor.record(node.key);

Expand All @@ -140,7 +140,7 @@ private void onProbationHit(Node node) {
}
}

/** Moves the entry to the LRU position, if it falls outside of the fast-path threshold. */
/** Moves the entry to the MRU position, if it falls outside of the fast-path threshold. */
private void onProtectedHit(Node node) {
// Fast path skips the hottest entries, useful for concurrent caches
if (node.recencyMove <= (mainRecencyCounter - recencyMoveDistance)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
import com.github.benmanes.caffeine.cache.simulator.policy.PolicyStats;
import com.typesafe.config.Config;

/**
* @author [email protected] (Gil Einziger)
*/
public final class TinyCachePolicy implements Policy {
private final PolicyStats policyStats;
private final TinyCache tinyCache;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
import com.github.benmanes.caffeine.cache.simulator.policy.PolicyStats;
import com.typesafe.config.Config;

/**
* @author [email protected] (Gil Einziger)
*/
public final class TinyCachePolicywithGhostCache implements Policy {
private final TinyCacheWithGhostCache tinyCache;
private final PolicyStats policyStats;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@
import com.github.benmanes.caffeine.cache.simulator.policy.PolicyStats;
import com.typesafe.config.Config;

/**
* @author [email protected] (Gil Einziger)
*/
public final class WindowTinyCachePolicy implements Policy {
private final TinyCache window;
private final PolicyStats policyStats;
Expand Down

0 comments on commit a8c3630

Please sign in to comment.