Caffeine cache 3.1.8 · com.github.benmanes.caffeine.cache.CaffeineSpec

A specification of a Caffeine builder configuration.

CaffeineSpec supports parsing configuration from a string, which makes it especially useful for command-line configuration of a Caffeine builder.

The string syntax is a series of comma-separated keys or key-value pairs, each corresponding to a Caffeine builder method.

initialCapacity=[integer]: sets Caffeine#initialCapacity.
maximumSize=[long]: sets Caffeine#maximumSize.
maximumWeight=[long]: sets Caffeine#maximumWeight.
expireAfterAccess=[duration]: sets Caffeine#expireAfterAccess.
expireAfterWrite=[duration]: sets Caffeine#expireAfterWrite.
refreshAfterWrite=[duration]: sets Caffeine#refreshAfterWrite.
weakKeys: sets Caffeine#weakKeys.
weakValues: sets Caffeine#weakValues.
softValues: sets Caffeine#softValues.
recordStats: sets Caffeine#recordStats.

Durations are represented as either an ISO-8601 string using Duration#parse(CharSequence) or by an integer followed by one of "d", "h", "m", or "s", representing days, hours, minutes, or seconds, respectively. There is currently no short syntax to request durations in milliseconds, microseconds, or nanoseconds.

Whitespace before and after commas and equal signs is ignored. Keys may not be repeated; it is also illegal to use the following pairs of keys in a single value:

maximumSize and maximumWeight
weakValues and softValues

CaffeineSpec does not support configuring Caffeine methods with non-value parameters. These must be configured in code.

A new Caffeine builder can be instantiated from a CaffeineSpec using Caffeine#from(CaffeineSpec) or Caffeine#from(String).

Field Summary

Modifier and Type	Field and Description
pack-priv @Nullable Duration	expireAfterAccess
pack-priv @Nullable Duration	expireAfterWrite
pack-priv int	initialCapacity
pack-priv @Nullable Caffeine.Strength	keyStrength
pack-priv long	maximumSize
pack-priv long	maximumWeight
pack-priv boolean	recordStats
pack-priv @Nullable Duration	refreshAfterWrite
pack-priv final String	specification
pack-priv static final String	SPLIT_KEY_VALUE
pack-priv static final String	SPLIT_OPTIONS
pack-priv @Nullable Caffeine.Strength	valueStrength

Access	Constructor and Description
private	CaffeineSpec(String specification)

Method Summary

Modifier and Type	Method and Description
pack-priv void	configure(String key, @Nullable String value) Configures the setting.
public boolean	equals(@Nullable Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
pack-priv void	expireAfterAccess(String key, @Nullable String value) Configures expire after access.
pack-priv void	expireAfterWrite(String key, @Nullable String value) Configures expire after write.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
pack-priv void	initialCapacity(String key, @Nullable String value) Configures the initial capacity.
pack-priv void	maximumSize(String key, @Nullable String value) Configures the maximum size.
pack-priv void	maximumWeight(String key, @Nullable String value) Configures the maximum size.
public static CaffeineSpec	Returns: the parsed specification parse(String the string form specification) Creates a CaffeineSpec from a string.
pack-priv static Duration	parseDuration(String key, @Nullable String value) Returns a parsed duration value.
pack-priv static int	parseInt(String key, @Nullable String value) Returns a parsed int value.
pack-priv static long	parseLong(String key, @Nullable String value) Returns a parsed long value.
pack-priv void	parseOption(String option) Parses and applies the configuration option.
pack-priv static TimeUnit	parseTimeUnit(String key, @Nullable String value) Returns a parsed `TimeUnit` value.
pack-priv void	recordStats(@Nullable String value) Configures the value as weak or soft references.
pack-priv void	refreshAfterWrite(String key, @Nullable String value) Configures refresh after write.
pack-priv Caffeine<Object, Object>	Returns: a builder configured to the specification toBuilder() Returns a `Caffeine` builder configured according to this specification.
public String	Returns: a string representation of this specification that can be parsed into a `CaffeineSpec` toParsableString() Returns a string representation that can be used to parse an equivalent `CaffeineSpec`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation for this `CaffeineSpec` instance.
pack-priv void	valueStrength(String key, @Nullable String value, Caffeine.Strength strength) Configures the value as weak or soft references.
pack-priv void	weakKeys(@Nullable String value) Configures the keys as weak references.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

expireAfterAccess	back to summary
pack-priv @Nullable Duration expireAfterAccess

expireAfterWrite	back to summary
pack-priv @Nullable Duration expireAfterWrite

initialCapacity	back to summary
pack-priv int initialCapacity

keyStrength	back to summary
pack-priv @Nullable Caffeine.Strength keyStrength

maximumSize	back to summary
pack-priv long maximumSize

maximumWeight	back to summary
pack-priv long maximumWeight

recordStats	back to summary
pack-priv boolean recordStats

refreshAfterWrite	back to summary
pack-priv @Nullable Duration refreshAfterWrite

specification	back to summary
pack-priv final String specification

SPLIT_KEY_VALUE	back to summary
pack-priv static final String SPLIT_KEY_VALUE

SPLIT_OPTIONS	back to summary
pack-priv static final String SPLIT_OPTIONS

valueStrength	back to summary
pack-priv @Nullable Caffeine.Strength valueStrength

Constructor Detail

CaffeineSpec	back to summary
private CaffeineSpec(String specification)

Method Detail

configure	back to summary
pack-priv void configure(String key, @Nullable String value) Configures the setting.

equals back to summary

equals	back to summary
public boolean equals(@Nullable Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:@Nullable Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(@Nullable Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:@Nullable Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

expireAfterAccess	back to summary
pack-priv void expireAfterAccess(String key, @Nullable String value) Configures expire after access.

expireAfterWrite	back to summary
pack-priv void expireAfterWrite(String key, @Nullable String value) Configures expire after write.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

initialCapacity	back to summary
pack-priv void initialCapacity(String key, @Nullable String value) Configures the initial capacity.

maximumSize	back to summary
pack-priv void maximumSize(String key, @Nullable String value) Configures the maximum size.

maximumWeight	back to summary
pack-priv void maximumWeight(String key, @Nullable String value) Configures the maximum size.

parse	back to summary
public static CaffeineSpec parse(String specification) Creates a CaffeineSpec from a string. Parameters specification:String the string form Returns:CaffeineSpec the parsed specification Annotations @SuppressWarnings:StringSplitter

parse

back to summary

public static CaffeineSpec parse(String specification)

Creates a CaffeineSpec from a string.

Parameters

specification:String: the string form

Returns:CaffeineSpec

the parsed specification

Annotations

@SuppressWarnings:StringSplitter

parseDuration	back to summary
pack-priv static Duration parseDuration(String key, @Nullable String value) Returns a parsed duration value.

parseInt	back to summary
pack-priv static int parseInt(String key, @Nullable String value) Returns a parsed int value.

parseLong	back to summary
pack-priv static long parseLong(String key, @Nullable String value) Returns a parsed long value.

parseOption	back to summary
pack-priv void parseOption(String option) Parses and applies the configuration option.

parseTimeUnit	back to summary
pack-priv static TimeUnit parseTimeUnit(String key, @Nullable String value) Returns a parsed `TimeUnit` value.

recordStats	back to summary
pack-priv void recordStats(@Nullable String value) Configures the value as weak or soft references.

refreshAfterWrite	back to summary
pack-priv void refreshAfterWrite(String key, @Nullable String value) Configures refresh after write.

toBuilder back to summary

toBuilder	back to summary
pack-priv Caffeine<Object, Object> toBuilder() Returns a `Caffeine` builder configured according to this specification. Returns:Caffeine<Object, Object> a builder configured to the specification

pack-priv Caffeine<Object, Object> toBuilder()

Returns a Caffeine builder configured according to this specification.

Returns:Caffeine<Object, Object>: a builder configured to the specification

toParsableString back to summary

toParsableString	back to summary
public String toParsableString() Returns a string representation that can be used to parse an equivalent `CaffeineSpec`. The order and form of this representation is not guaranteed, except that parsing its output will produce a `CaffeineSpec` equal to this instance. Returns:String a string representation of this specification that can be parsed into a `CaffeineSpec`

public String toParsableString()

Returns a string representation that can be used to parse an equivalent CaffeineSpec. The order and form of this representation is not guaranteed, except that parsing its output will produce a CaffeineSpec equal to this instance.

Returns:String: a string representation of this specification that can be parsed into a CaffeineSpec

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation for this `CaffeineSpec` instance. The form of this representation is not guaranteed. Returns:String Doc from java.lang.Object.toString. a string representation of the object. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation for this CaffeineSpec instance. The form of this representation is not guaranteed.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override

valueStrength	back to summary
pack-priv void valueStrength(String key, @Nullable String value, Caffeine.Strength strength) Configures the value as weak or soft references.

weakKeys	back to summary
pack-priv void weakKeys(@Nullable String value) Configures the keys as weak references.

public final Class CaffeineSpec

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail