com.github.benmanes.caffeine.cache.simulator.admission

Enum Admission

java.lang.Object

java.lang.Enum<Admission>

com.github.benmanes.caffeine.cache.simulator.admission.Admission

All Implemented Interfaces:

Serializable, Comparable<Admission>

public enum Admission
extends Enum<Admission>

The admission policies.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS
TINYLFU

Method Summary

Modifier and Type	Method and Description
String	format(String name) Returns the policy's formatted name.
Admittor	from(Config config, PolicyStats policyStats) Returns a configured admittor.
static Admission	valueOf(String name) Returns the enum constant of this type with the specified name.
static Admission[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALWAYS

public static final Admission ALWAYS

TINYLFU

public static final Admission TINYLFU

Method Detail

values

public static Admission[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Admission c : Admission.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Admission valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

from

public Admittor from(Config config,
                     PolicyStats policyStats)

Returns a configured admittor.

Parameters:

config - the configuration

policyStats - the stats

Returns:

an admission policy

format

public String format(String name)

Returns the policy's formatted name.