CacheBuilderSpec (Guava: Google Core Libraries for Java 29.0-jre API)

java.lang.Object
- com.google.common.cache.CacheBuilderSpec

```
@GwtIncompatible
public final class CacheBuilderSpec
extends Object
```
A specification of a CacheBuilder configuration.
CacheBuilderSpec supports parsing configuration off of a string, which makes it especially useful for command-line configuration of a CacheBuilder.
The string syntax is a series of comma-separated keys or key-value pairs, each corresponding to a CacheBuilder method.
- concurrencyLevel=[integer]: sets CacheBuilder.concurrencyLevel.
- initialCapacity=[integer]: sets CacheBuilder.initialCapacity.
- maximumSize=[long]: sets CacheBuilder.maximumSize.
- maximumWeight=[long]: sets CacheBuilder.maximumWeight.
- expireAfterAccess=[duration]: sets CacheBuilder.expireAfterAccess(java.time.Duration).
- expireAfterWrite=[duration]: sets CacheBuilder.expireAfterWrite(java.time.Duration).
- refreshAfterWrite=[duration]: sets CacheBuilder.refreshAfterWrite(java.time.Duration).
- weakKeys: sets CacheBuilder.weakKeys().
- softValues: sets CacheBuilder.softValues().
- weakValues: sets CacheBuilder.weakValues().
- recordStats: sets CacheBuilder.recordStats().
The set of supported keys will grow as CacheBuilder evolves, but existing keys will never be removed.
Durations are represented by an integer, followed by one of "d", "h", "m", or "s", representing days, hours, minutes, or seconds respectively. (There is currently no syntax to request expiration 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
- softValues and weakValues
CacheBuilderSpec does not support configuring CacheBuilder methods with non-value parameters. These must be configured in code.
A new CacheBuilder can be instantiated from a CacheBuilderSpec using CacheBuilder.from(CacheBuilderSpec) or CacheBuilder.from(String).
Since:

12.0

Author:

Adam Winer

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CacheBuilderSpec`	`disableCaching()` Returns a CacheBuilderSpec that will prevent caching.
`boolean`	`equals(@Nullable Object obj)` Indicates whether some other object is "equal to" this one.
`int`	`hashCode()` Returns a hash code value for the object.
`static CacheBuilderSpec`	`parse(String cacheBuilderSpecification)` Creates a CacheBuilderSpec from a string.
`String`	`toParsableString()` Returns a string that can be used to parse an equivalent `CacheBuilderSpec`.
`String`	`toString()` Returns a string representation for this CacheBuilderSpec instance.

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

- Method Detail
  - parse
```
public static CacheBuilderSpec parse(String cacheBuilderSpecification)
```
    Creates a CacheBuilderSpec from a string.
    
    Parameters:
    
    cacheBuilderSpecification - the string form
  - disableCaching
```
public static CacheBuilderSpec disableCaching()
```
    Returns a CacheBuilderSpec that will prevent caching.
  - toParsableString
```
public String toParsableString()
```
    Returns a string that can be used to parse an equivalent CacheBuilderSpec. The order and form of this representation is not guaranteed, except that reparsing its output will produce a CacheBuilderSpec equal to this instance.
  - toString
```
public String toString()
```
    Returns a string representation for this CacheBuilderSpec instance. The form of this representation is not guaranteed.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.
  - hashCode
```
public int hashCode()
```
    Description copied from class: java.lang.Object
    Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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(Object) 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 Object.equals(java.lang.Object) 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.
    As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.
    
    See Also:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - equals
```
public boolean equals(@Nullable Object obj)
```
    Description copied from class: java.lang.Object
    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.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
    
    See Also:
    
    Object.hashCode(), HashMap

Class CacheBuilderSpec

Method Summary

Methods inherited from class java.lang.Object

Method Detail

parse

disableCaching

toParsableString

toString

hashCode

equals