Package org.apache.juneau.commons.collections

Class Cache5.Builder<K1,K2,K3,K4,K5,V>

java.lang.Object
org.apache.juneau.commons.collections.Cache5.Builder<K1,K2,K3,K4,K5,V>
Type Parameters:
K1 - The first key type.
K2 - The second key type.
K3 - The third key type.
K4 - The fourth key type.
K5 - The fifth key type.
V - The value type.
Enclosing class:
Cache5<K1,K2,K3,K4,K5,V>
public static class Cache5.Builder<K1,K2,K3,K4,K5,V> extends Object
Builder for creating configured Cache5 instances.

  • Method Details

    • build

      public Cache5<K1,K2,K3,K4,K5,V> build()
      Builds a new Cache5 instance with the configured settings.
      Returns:
      A new immutable Cache5 instance.

    • cacheMode

      public Cache5.Builder<K1,K2,K3,K4,K5,V> cacheMode(CacheMode value)
      Sets the caching mode for this cache.

      Available modes:

      Parameters:
      value - The caching mode.
      Returns:
      This object for method chaining.

    • logOnExit

      public Cache5.Builder<K1,K2,K3,K4,K5,V> logOnExit(boolean value, String idValue)
      Conditionally enables logging of cache statistics when the JVM exits.

      When enabled, the cache will register a shutdown hook that logs the cache name, total cache hits, and total cache misses (size of cache) to help analyze cache effectiveness.

      Parameters:
      value - Whether to enable logging on exit.
      idValue - The identifier to use in the log message.
      Returns:
      This object for method chaining.

    • logOnExit

      public Cache5.Builder<K1,K2,K3,K4,K5,V> logOnExit(String value)
      Enables logging of cache statistics when the JVM exits.
      Parameters:
      value - The identifier to use in the log message.
      Returns:
      This object for method chaining.

    • maxSize

      public Cache5.Builder<K1,K2,K3,K4,K5,V> maxSize(int value)
      Specifies the maximum number of entries allowed in this cache.
      Parameters:
      value - The maximum number of cache entries. Must be positive.
      Returns:
      This object for method chaining.

    • supplier

      public Cache5.Builder<K1,K2,K3,K4,K5,V> supplier(Function5<K1,K2,K3,K4,K5,V> value)
      Specifies the default supplier function for computing values when keys are not found.
      Parameters:
      value - The default supplier function. Can be null.
      Returns:
      This object for method chaining.

    • threadLocal

      public Cache5.Builder<K1,K2,K3,K4,K5,V> threadLocal()
      Enables thread-local caching.

      When enabled, each thread gets its own separate cache instance. This is useful for thread-unsafe objects that need to be cached per thread.

      This is a shortcut for wrapping a cache in a ThreadLocal, but provides a cleaner API.

      Returns:
      This object for method chaining.
      See Also:

    • weak

      public Cache5.Builder<K1,K2,K3,K4,K5,V> weak()
      Sets the caching mode to WEAK.

      This is a shortcut for calling cacheMode(CacheMode.WEAK).

      Weak caching uses WeakHashMap for storage, allowing cache entries to be garbage collected when keys are no longer strongly referenced elsewhere.

      Returns:
      This object for method chaining.
      See Also: