Module nl.jqno.equalsverifier

Package nl.jqno.equalsverifier.internal.valueproviders

Class CachingValueProvider

java.lang.Object

nl.jqno.equalsverifier.internal.valueproviders.CachingValueProvider

All Implemented Interfaces:

ValueProvider

public class CachingValueProvider
extends Object
implements ValueProvider

Provides cached instances of classes. On a cache miss, a value is requested from the given fallback ValueProvider. If it returns a value, this value is cached.

Field Summary

Fields

Modifier and Type	Field	Description
private final ValueProvider	fallback
private final FieldCache	fieldCache
private final UserPrefabValueCaches	prefabCaches

Constructor Summary

Constructors

Constructor	Description
CachingValueProvider(UserPrefabValueCaches decider, FieldCache fieldCache, ValueProvider fallback)	Constructor.

Method Summary

Modifier and Type	Method	Description
<T> Optional<Tuple<T>>	provide(TypeTag tag, Attributes attributes)	Returns a tuple of two different prefabricated values of the specified type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.jqno.equalsverifier.internal.valueproviders.ValueProvider

provideOrThrow

Field Details

prefabCaches

private final UserPrefabValueCaches prefabCaches

fieldCache

private final FieldCache fieldCache

fallback

private final ValueProvider fallback

Constructor Details

CachingValueProvider

public CachingValueProvider(UserPrefabValueCaches decider,
 FieldCache fieldCache,
 ValueProvider fallback)

Constructor.

Parameters:

decider - Decides whether a value should be cached or not.

fieldCache - The underlying cache of instances.

fallback - The ValueProvider that provides instances when there's a cache miss.

Method Details

provide

public <T> Optional<Tuple<T>> provide(TypeTag tag,
 Attributes attributes)

Returns a tuple of two different prefabricated values of the specified type.

Specified by:

provide in interface ValueProvider

Type Parameters:

T - The returned tuple will have this generic type.

Parameters:

tag - A description of the desired type, including generic parameters.

attributes - The attributes of the field that the provided values must be linked to.

Returns:

A tuple of two different values of the given type, or an empty Optional if none could be found.