Class CacheBuilderSpec
- java.lang.Object
-
- com.google.common.cache.CacheBuilderSpec
-
@GwtIncompatible public final class CacheBuilderSpec extends Object
A specification of aCacheBuilder
configuration.CacheBuilderSpec
supports parsing configuration off of a string, which makes it especially useful for command-line configuration of aCacheBuilder
.The string syntax is a series of comma-separated keys or key-value pairs, each corresponding to a
CacheBuilder
method.concurrencyLevel=[integer]
: setsCacheBuilder.concurrencyLevel
.initialCapacity=[integer]
: setsCacheBuilder.initialCapacity
.maximumSize=[long]
: setsCacheBuilder.maximumSize
.maximumWeight=[long]
: setsCacheBuilder.maximumWeight
.expireAfterAccess=[duration]
: setsCacheBuilder.expireAfterAccess(java.time.Duration)
.expireAfterWrite=[duration]
: setsCacheBuilder.expireAfterWrite(java.time.Duration)
.refreshAfterWrite=[duration]
: setsCacheBuilder.refreshAfterWrite(java.time.Duration)
.weakKeys
: setsCacheBuilder.weakKeys()
.softValues
: setsCacheBuilder.softValues()
.weakValues
: setsCacheBuilder.weakValues()
.recordStats
: setsCacheBuilder.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
andmaximumWeight
softValues
andweakValues
CacheBuilderSpec
does not support configuringCacheBuilder
methods with non-value parameters. These must be configured in code.A new
CacheBuilder
can be instantiated from aCacheBuilderSpec
usingCacheBuilder.from(CacheBuilderSpec)
orCacheBuilder.from(String)
.- Since:
- 12.0
- Author:
- Adam Winer
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CacheBuilderSpec
disableCaching()
Returns a CacheBuilderSpec that will prevent caching.boolean
equals(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 equivalentCacheBuilderSpec
.String
toString()
Returns a string representation for this CacheBuilderSpec instance.
-
-
-
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 equivalentCacheBuilderSpec
. The order and form of this representation is not guaranteed, except that reparsing its output will produce aCacheBuilderSpec
equal to this instance.
-
toString
public String toString()
Returns a string representation for this CacheBuilderSpec instance. The form of this representation is not guaranteed.
-
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 byHashMap
.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 inequals
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 thehashCode
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 thehashCode
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. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)- Overrides:
hashCode
in classObject
- Returns:
- a hash code value for this object.
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
-
equals
public boolean equals(@CheckForNull 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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The
equals
method for classObject
implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference valuesx
andy
, this method returnstrue
if and only ifx
andy
refer to the same object (x == y
has the valuetrue
).Note that it is generally necessary to override the
hashCode
method whenever this method is overridden, so as to maintain the general contract for thehashCode
method, which states that equal objects must have equal hash codes.- Overrides:
equals
in classObject
- 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
- It is reflexive: for any non-null reference value
-
-