org.springframework.data.gemfire.support

Class ComposableCacheResolver<T extends org.apache.geode.cache.GemFireCache>

java.lang.Object

org.springframework.data.gemfire.support.AbstractCachingCacheResolver<T>

org.springframework.data.gemfire.support.ComposableCacheResolver<T>

All Implemented Interfaces:

Supplier<T>, CacheResolver<T>

public class ComposableCacheResolver<T extends org.apache.geode.cache.GemFireCache>
extends AbstractCachingCacheResolver<T>

Composition of CacheResolvers using the Composite Software Design Pattern that acts, and can be referred to, as a single instance of CacheResolver. This implementation also supports caching the result of the resolution of the GemFireCache instance reference.

Since:

2.3.0

Author:

John Blum

See Also:

GemFireCache, CacheResolver, AbstractCachingCacheResolver

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ComposableCacheResolver(CacheResolver<T> cacheResolverOne, CacheResolver<T> cacheResolverTwo) Constructs a new instance of ComposableCacheResolver initialized and composed with the given CacheResolvers forming the composition.

Method Summary

Modifier and Type	Method and Description
static <T extends org.apache.geode.cache.GemFireCache> CacheResolver<T>	compose(CacheResolver<T>... cacheResolvers) Factory method used to compose an array of CacheResolvers in a composition.
static <T extends org.apache.geode.cache.GemFireCache> CacheResolver<T>	compose(CacheResolver<T> one, CacheResolver<T> two) Null-safe factory method used to compose two CacheResolver objects in a composition.
static <T extends org.apache.geode.cache.GemFireCache> CacheResolver<T>	compose(Iterable<CacheResolver<T>> cacheResolvers) Factory method used to compose an Iterable collection of CacheResolvers in a composition.
T	doResolve() Resolves the first, single reference to a GemFireCache, handling any Exceptions throwing by the composed CacheResolvers, such as a CacheClosedException.
protected CacheResolver<T>	getCacheResolverOne() Returns a reference to the first, non-null, configured CacheResolver in the composition.
protected CacheResolver<T>	getCacheResolverTwo() Returns a reference to the second, non-null, configured CacheResolver in the composition.

Methods inherited from class org.springframework.data.gemfire.support.AbstractCachingCacheResolver

resolve

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.gemfire.CacheResolver

get

Constructor Detail

ComposableCacheResolver

protected ComposableCacheResolver(@NonNull
                                  CacheResolver<T> cacheResolverOne,
                                  @NonNull
                                  CacheResolver<T> cacheResolverTwo)

Constructs a new instance of ComposableCacheResolver initialized and composed with the given CacheResolvers forming the composition.

Parameters:

cacheResolverOne - first CacheResolver in the composition.

cacheResolverTwo - second CacheResolver in the composition.

Throws:

IllegalArgumentException - if either CacheResolver argument is null.

See Also:

CacheResolver

Method Detail

compose

@Nullable
public static <T extends org.apache.geode.cache.GemFireCache> CacheResolver<T> compose(@Nullable
                                                                                                 CacheResolver<T>... cacheResolvers)

Factory method used to compose an array of CacheResolvers in a composition.

Type Parameters:

T - subclass of GemFireCache.

Parameters:

cacheResolvers - array of CacheResolvers to compose; may be null.

Returns:

a composition from the array of CacheResolvers; may be null.

See Also:

CacheResolver, compose(Iterable)

compose

@Nullable
public static <T extends org.apache.geode.cache.GemFireCache> CacheResolver<T> compose(@Nullable
                                                                                                 Iterable<CacheResolver<T>> cacheResolvers)

Factory method used to compose an Iterable collection of CacheResolvers in a composition.

Type Parameters:

T - subclass of GemFireCache.

Parameters:

cacheResolvers - Iterable collection of CacheResolvers to compose; may be null.

Returns:

a composition from the Iterable collection of CacheResolvers; may be null.

See Also:

compose(CacheResolver, CacheResolver), CacheResolver, Iterable

compose

@Nullable
public static <T extends org.apache.geode.cache.GemFireCache> CacheResolver<T> compose(@Nullable
                                                                                                 CacheResolver<T> one,
                                                                                                 @Nullable
                                                                                                 CacheResolver<T> two)

Null-safe factory method used to compose two CacheResolver objects in a composition.

Type Parameters:

T - subclass of GemFireCache.

Parameters:

one - first CacheResolver in the composition.

two - second CacheResolver in the composition.

Returns:

the first CacheResolver if the second CacheResolver is null. Return the second CacheResolver if the first CacheResolver is null. Otherwise, return a composition of both CacheResolver one and two as a ComposableCacheResolver.

See Also:

CacheResolver, ComposableCacheResolver(CacheResolver, CacheResolver)

getCacheResolverOne

@NonNull
protected CacheResolver<T> getCacheResolverOne()

Returns a reference to the first, non-null, configured CacheResolver in the composition.

Returns:

a reference to the first CacheResolver in the composition.

See Also:

CacheResolver

getCacheResolverTwo

@NonNull
protected CacheResolver<T> getCacheResolverTwo()

Returns a reference to the second, non-null, configured CacheResolver in the composition.

Returns:

a reference to the second CacheResolver in the composition.

See Also:

CacheResolver

doResolve

public T doResolve()

Resolves the first, single reference to a GemFireCache, handling any Exceptions throwing by the composed CacheResolvers, such as a CacheClosedException. This method may ultimately still result in a thrown Exception, but it will make a best effort to exhaustively consult all composed CacheResolvers.

Specified by:

doResolve in class AbstractCachingCacheResolver<T extends org.apache.geode.cache.GemFireCache>

Returns:

the first, single resolved reference to a GemFireCache.

See Also:

CacheResolver.resolve(), GemFireCache, getCacheResolverOne(), getCacheResolverTwo()