memoization.java

Java memoization library - trade space for time

Features

• Memoize calls to JDK interfaces like Consumer, Function, Predicate, Supplier, and more
• Memoize calls to jOOL interfaces like Consumer0..16 and Function0..16
• Memoize calls to lambda interfaces like Fn0..8
• Memoize calls to RxJava interfaces like Action, Cancellable, and more
• Use custom caches like Caffeine, Guava, cache2k, or any ConcurrentMap.
• Use custom cache keys for fine-tuning

Usage

Memoize any of the supported types by using the static factory methods supplied by:

• Memoize if you want to memoize JDK interfaces.
• MemoizeJool if you want to memoize jOOL interfaces.
• MemoizeLambda if you want to memoize lambda interfaces.
• MemoizeRx if you want to memoize RxJava interfaces.

Default cache with default cache keys

```java wtf.metio.memoization.jdk.Memoize; wtf.metio.memoization.jool.MemoizeJool; wtf.metio.memoization.lambda.MemoizeLambda; wtf.metio.memoization.rxjava.MemoizeRx;

Function function = ...; Function memoizedFunction = Memoize.function(function);

Supplier

supplier = ...; Supplier

memoizedSupplier = MemoizeRx.supplier(supplier);

Function3 function = ...; Function3 memoizedFunction = MemoizeJool.function3(function);

Fn4 function = ...; Fn4 memoizedFunction = MemoizeLambda.fn4(function); ```

Default cache with custom cache keys

```java wtf.metio.memoization.jdk.Memoize; wtf.metio.memoization.jool.MemoizeJool; wtf.metio.memoization.lambda.MemoizeLambda; wtf.metio.memoization.rxjava.MemoizeRx;

Function function = ...; Function keyFunction = ...; Function memoizedFunction = Memoize.function(function, keyFunction);

Supplier

supplier = ...; Supplier keySupplier = ...; Supplier

memoizedSupplier = MemoizeRx.supplier(supplier, keySupplier);

Function3 function = ...; Function3 keyFunction = ...; Function3 memoizedFunction = MemoizeJool.function3(function, keyFunction);

Fn4 function = ...; Fn4 keyFunction = ...; Fn4 memoizedFunction = MemoizeLambda.fn4(function, keyFunction); ```

Custom cache with default cache keys

```java wtf.metio.memoization.jdk.Memoize; wtf.metio.memoization.jool.MemoizeJool; wtf.metio.memoization.lambda.MemoizeLambda; wtf.metio.memoization.rxjava.MemoizeRx;

// memoize in cache2k cache Function function = ...; Cache cache = ...; // org.cache2k.Cache Function memoizedFunction = Memoize.function(function, cache.asMap());

// memoize in Caffeine cache Supplier

supplier = ...; Cache cache = ...; // com.github.benmanes.caffeine.cache.Cache Supplier

memoizedSupplier = MemoizeRx.supplier(supplier, cache.asMap());

// memoize in Guava cache Function3 function = ...; Cache cache = ...; // com.google.common.cache.Cache Function3 memoizedFunction = MemoizeJool.function3(function, cache.asMap());

// memoize in ConcurrentMap Fn4 function = ...; Map cache = ...; Fn4 memoizedFunction = MemoizeLambda.fn4(function, cache); ```

Custom cache with custom cache keys

```java wtf.metio.memoization.jdk.Memoize; wtf.metio.memoization.jool.MemoizeJool; wtf.metio.memoization.lambda.MemoizeLambda; wtf.metio.memoization.rxjava.MemoizeRx;

// memoize in cache2k cache Function function = ...; Function keyFunction = ...; Cache cache = ...; // org.cache2k.Cache Function memoizedFunction = Memoize.function(function, keyFunction, cache.asMap());

// memoize in Caffeine cache Supplier

supplier = ...; Supplier keySupplier = ...; Cache cache = ...; // com.github.benmanes.caffeine.cache.Cache Supplier

memoizedSupplier = MemoizeRx.supplier(supplier, keySupplier, cache.asMap());

// memoize in Guava cache Function3 function = ...; Function3 keyFunction = ...; Cache cache = ...; // com.google.common.cache.Cache Function3 memoizedFunction = MemoizeJool.function3(function, keyFunction, cache.asMap());

// memoize in ConcurrentMap Fn4 function = ...; Fn4 keyFunction = ...; Map cache = ...; Fn4 memoizedFunction = MemoizeLambda.fn4(function, keyFunction, cache); ```

Note that the static factory methods do accept any Map, however they copy the entries in the map to a new ConcurrentHashMap in case the provided Map is not a ConcurrentMap. This is done in order to ensure atomic computeIfAbsent behavior.

Integration

In order to use this project, declare the following dependencies in your project:

```xml <!-- support for JDK interfaces --> wtf.metio.memoization memoization-jdk ${version.memoization} <!-- support for JDK interfaces -->

<!-- support for jOOL interfaces -->
<dependency>
    <groupId>wtf.metio.memoization</groupId>
    <artifactId>memoization-jool</artifactId>
    <version>${version.memoization}</version>
</dependency>
<!-- support for jOOL interfaces -->

<!-- support for lambda interfaces -->
<dependency>
    <groupId>wtf.metio.memoization</groupId>
    <artifactId>memoization-lambda</artifactId>
    <version>${version.memoization}</version>
</dependency>
<!-- support for lambda interfaces -->

<!-- support for RxJava interfaces -->
<dependency>
    <groupId>wtf.metio.memoization</groupId>
    <artifactId>memoization-rxjava</artifactId>
    <version>${version.memoization}</version>
</dependency>
<!-- support for RxJava interfaces -->

```

Replace ${version.memoization} with the latest release.

Alternatives

• Tek271 Memoizer
• GitMemoizer
• Spring's @Cacheable
• Chili's @Memoize
• Clojure's (memoize f)
• Groovy's @Memoized
• ScalaCache's memoize
• Cyclops' Memoize
• RxMemoization
• memoized
• memoizer
• jcabi's @Cacheable
• crache
• memento

License

``` Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ```