Package org.keycloak.cache

Record Class LocalCacheConfiguration<K,V>

java.lang.Object

java.lang.Record

org.keycloak.cache.LocalCacheConfiguration<K,V>

Type Parameters:

K - the type of the cache Keys used for lookup

V - the type of the cache Values to be stored

Record Components:

name - the name of the cache

maxSize - the maximum size of the cache, or -1 if an unbounded cache is desired.

expiration - the Duration to wait before entries are expired. A null value indicates no expiration.

loader - an optional Function which is used to retrieve cache values on cache miss.

public record LocalCacheConfiguration<K,V>(String name, int maxSize, Duration expiration, Function<K,V> loader)
extends Record

Configuration record that encapsulates all configuration required in order to create a LocalCache.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LocalCacheConfiguration.Builder<K,V>	A builder class to simplify the creation of LocalCacheConfiguration objects.

Constructor Summary

Constructors

Constructor	Description
LocalCacheConfiguration(String name, int maxSize, Duration expiration, Function<K,V> loader)	Creates an instance of a LocalCacheConfiguration record class.

Method Summary

Modifier and Type	Method	Description
static <K, V> LocalCacheConfiguration.Builder<K,V>	builder()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Duration	expiration()	Returns the value of the expiration record component.
boolean	hasExpiration()
final int	hashCode()	Returns a hash code value for this object.
boolean	hasLoader()
Function<K,V>	loader()	Returns the value of the loader record component.
int	maxSize()	Returns the value of the maxSize record component.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LocalCacheConfiguration

public LocalCacheConfiguration(String name,
 int maxSize,
 Duration expiration,
 Function<K,V> loader)

Creates an instance of a LocalCacheConfiguration record class.

Parameters:

name - the value for the name record component

maxSize - the value for the maxSize record component

expiration - the value for the expiration record component

loader - the value for the loader record component

Method Details

hasExpiration

public boolean hasExpiration()

hasLoader

public boolean hasLoader()

builder

public static <K,
V>
LocalCacheConfiguration.Builder<K,V> builder()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

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

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

maxSize

public int maxSize()

Returns the value of the maxSize record component.

Returns:

the value of the maxSize record component

expiration

public Duration expiration()

Returns the value of the expiration record component.

Returns:

the value of the expiration record component

loader

public Function<K,V> loader()

Returns the value of the loader record component.

Returns:

the value of the loader record component